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