Source for org.omg.DynamicAny.DynAnyHelper

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