old-autovect-branch/libjava/classpath/org/omg/DynamicAny/DynArrayHelper.java

   1 /* DynArrayHelper.java --
   2    Copyright (C) 2005 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package org.omg.DynamicAny;
  40
  41 import org.omg.CORBA.BAD_PARAM;
  42 import org.omg.CORBA.TypeCode;
  43 import org.omg.CORBA.ORB;
  44 import org.omg.CORBA.Any;
  45 import org.omg.CORBA.portable.InputStream;
  46 import org.omg.CORBA.MARSHAL;
  47 import org.omg.CORBA.portable.OutputStream;
  48
  49 /**
  50  * The helper operations for {@link DynArray}. Following the 1.5 JDK
  51  * specifications, DynArray is always a local object, so the two methods of this
  52  * helper ({@link #read} and {@link #write} are not in use, always throwing
  53  * {@link MARSHAL}.
  54  *
  55  * @specnote always throwing MARSHAL in read and write ensures compatibility
  56  * with other popular implementations like Sun's.
  57  *
  58  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  59  */
  60 public abstract class DynArrayHelper
  61 {
  62   /**
  63    * Cast the passed object into the DynArray. As DynArray is a local object,
  64    * the method just uses java type cast.
  65    *
  66    * @param obj the object to narrow.
  67    * @return narrowed instance.
  68    * @throws BAD_PARAM if the passed object is not a DynArray.
  69    */
  70   public static DynArray narrow(org.omg.CORBA.Object obj)
  71   {
  72     try
  73       {
  74         return (DynArray) obj;
  75       }
  76     catch (ClassCastException cex)
  77       {
  78         throw new BAD_PARAM(obj.getClass().getName() + " is not a DynArray");
  79       }
  80   }
  81
  82   /**
  83    * Narrow the given object to the DynArray. For the objects that are
  84    * always local, this operation does not differ from the ordinary
  85    * {@link #narrow} (ClassCastException will be thrown if narrowing something
  86    * different).
  87    *
  88    * @param obj the object to cast.
  89    *
  90    * @return the casted DynArray.
  91    *
  92    * @since 1.5
  93    *
  94    * @see OMG issue 4158.
  95    */
  96   public static DynArray unchecked_narrow(org.omg.CORBA.Object obj)
  97   {
  98     return narrow(obj);
  99   }
 100
 101   /**
 102    * Get the type code of the {@link DynArray}.
 103    */
 104   public static TypeCode type()
 105   {
 106     return ORB.init().create_interface_tc(id(), "DynArray");
 107   }
 108
 109   /**
 110    * Insert the DynArray into the given Any.
 111    *
 112    * @param any the Any to insert into.
 113    *
 114    * @param that the DynArray to insert.
 115    */
 116   public static void insert(Any any, DynArray that)
 117   {
 118     any.insert_Object(that);
 119   }
 120
 121   /**
 122    * Extract the DynArray from given Any.
 123    *
 124    * @throws BAD_OPERATION if the passed Any does not contain DynArray.
 125    */
 126   public static DynArray extract(Any any)
 127   {
 128     return narrow(any.extract_Object());
 129   }
 130
 131   /**
 132    * Get the DynArray repository id.
 133    *
 134    * @return "IDL:omg.org/DynamicAny/DynArray:1.0", always.
 135    */
 136   public static String id()
 137   {
 138     return "IDL:omg.org/DynamicAny/DynArray:1.0";
 139   }
 140
 141   /**
 142    * This should read DynArray from the CDR input stream, but (following the JDK
 143    * 1.5 API) it does not.
 144    *
 145    * @param input a org.omg.CORBA.portable stream to read from.
 146    *
 147    * @specenote Sun throws the same exception.
 148    *
 149    * @throws MARSHAL always.
 150    */
 151   public static DynArray read(InputStream input)
 152   {
 153     throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
 154   }
 155
 156   /**
 157    * This should read DynArray from the CDR input stream, but (following the JDK
 158    * 1.5 API) it does not.
 159    *
 160    * @param input a org.omg.CORBA.portable stream to read from.
 161    *
 162    * @specenote Sun throws the same exception.
 163    *
 164    * @throws MARSHAL always.
 165    */
 166   public static void write(OutputStream output, DynArray value)
 167   {
 168     throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
 169   }
 170 }