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