libjava/classpath/org/omg/DynamicAny/DynValueHelper.java

   1 /* DynValueHelper.java --
   2    Copyright (C) 2005, 2006 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 gnu.CORBA.OrbRestricted;
  42
  43 import org.omg.CORBA.BAD_OPERATION;
  44 import org.omg.CORBA.BAD_PARAM;
  45 import org.omg.CORBA.TypeCode;
  46 import org.omg.CORBA.Any;
  47 import org.omg.CORBA.portable.InputStream;
  48 import org.omg.CORBA.MARSHAL;
  49 import org.omg.CORBA.portable.OutputStream;
  50
  51 /**
  52  * The helper operations for {@link DynValue}. Following the 1.5 JDK
  53  * specifications, DynValue is always a local object, so the two methods of this
  54  * helper ({@link #read} and {@link #write} are not in use, always throwing
  55  * {@link MARSHAL}.
  56  *
  57  * @specnote always throwing MARSHAL in read and write ensures compatibility
  58  * with other popular implementations like Sun's.
  59  *
  60  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  61  */
  62 public abstract class DynValueHelper
  63 {
  64   /**
  65    * Cast the passed object into the DynValue. As DynValue is a local object,
  66    * the method just uses java type cast.
  67    *
  68    * @param obj the object to narrow.
  69    * @return narrowed instance.
  70    * @throws BAD_PARAM if the passed object is not a DynValue.
  71    */
  72   public static DynValue narrow(org.omg.CORBA.Object obj)
  73   {
  74     try
  75       {
  76         return (DynValue) obj;
  77       }
  78     catch (ClassCastException cex)
  79       {
  80         throw new BAD_PARAM(obj.getClass().getName() + " is not a DynValue");
  81       }
  82   }
  83
  84   /**
  85    * Narrow the given object to the DynValue. For the objects that are
  86    * always local, this operation does not differ from the ordinary
  87    * {@link #narrow} (ClassCastException will be thrown if narrowing something
  88    * different). See OMG issue 4158.
  89    *
  90    * @param obj the object to cast.
  91    *
  92    * @return the casted DynValue.
  93    *
  94    * @since 1.5
  95    */
  96   public static DynValue unchecked_narrow(org.omg.CORBA.Object obj)
  97   {
  98     return narrow(obj);
  99   }
 100
 101   /**
 102    * Get the type code of the {@link DynValue}.
 103    */
 104   public static TypeCode type()
 105   {
 106     return OrbRestricted.Singleton.create_interface_tc(id(), "DynValue");
 107   }
 108
 109   /**
 110    * Insert the DynValue into the given Any.
 111    *
 112    * @param any the Any to insert into.
 113    *
 114    * @param that the DynValue to insert.
 115    */
 116   public static void insert(Any any, DynValue that)
 117   {
 118     any.insert_Object(that);
 119   }
 120
 121   /**
 122    * Extract the DynValue from given Any.
 123    *
 124    * @throws BAD_OPERATION if the passed Any does not contain DynValue.
 125    */
 126   public static DynValue extract(Any any)
 127   {
 128     return narrow(any.extract_Object());
 129   }
 130
 131   /**
 132    * Get the DynValue repository id.
 133    *
 134    * @return "IDL:omg.org/DynamicAny/DynValue:1.0", always.
 135    */
 136   public static String id()
 137   {
 138     return "IDL:omg.org/DynamicAny/DynValue:1.0";
 139   }
 140
 141   /**
 142    * This should read DynValue 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 DynValue read(InputStream input)
 152   {
 153     throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
 154   }
 155
 156   /**
 157    * This should read DynValue from the CDR input stream, but (following the JDK
 158    * 1.5 API) it does not.
 159    *
 160    * @param output a org.omg.CORBA.portable stream to write into.
 161    *
 162    * @specenote Sun throws the same exception.
 163    *
 164    * @throws MARSHAL always.
 165    */
 166   public static void write(OutputStream output, DynValue value)
 167   {
 168     throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
 169   }
 170 }