Source for org.omg.DynamicAny.DynAnyFactoryHelper

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