Source for org.omg.IOP.CodecFactoryHelper

   1: /* CodecFactoryHelper.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.IOP;
  40: 
  41: import gnu.CORBA.OrbRestricted;
  42: 
  43: import org.omg.CORBA.Any;
  44: import org.omg.CORBA.BAD_OPERATION;
  45: import org.omg.CORBA.BAD_PARAM;
  46: import org.omg.CORBA.CompletionStatus;
  47: import org.omg.CORBA.MARSHAL;
  48: import org.omg.CORBA.TypeCode;
  49: import org.omg.CORBA.portable.InputStream;
  50: import org.omg.CORBA.portable.OutputStream;
  51: 
  52: /**
  53: * The helper operations for the
  54: * CORBA object {@link CodecFactory}.
  55: *
  56: * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  57: */
  58: public abstract class CodecFactoryHelper
  59: {
  60:   /**
  61:    * Get the type code of the {@link CodecFactory}.
  62:    */
  63:   public static TypeCode type()
  64:   {
  65:     return OrbRestricted.Singleton.create_interface_tc(id(), "CodecFactory");
  66:   }
  67: 
  68:   /**
  69:    * Insert the CodecFactory into the given Any.
  70:    *
  71:    * @param any the Any to insert into.
  72:    * @param that the CodecFactory to insert.
  73:    */
  74:   public static void insert(Any any, CodecFactory that)
  75:   {
  76:     any.insert_Object(that);
  77:   }
  78: 
  79:   /**
  80:    * Extract the CodecFactory from given Any.
  81:    *
  82:    * @throws BAD_OPERATION if the passed Any does not contain CodecFactory.
  83:    */
  84:   public static CodecFactory extract(Any any)
  85:   {
  86:     return narrow(any.extract_Object());
  87:   }
  88: 
  89:   /**
  90:    * Get the CodecFactory repository id.
  91:    *
  92:    * @return "IDL:omg.org/IOP/CodecFactory:1.0", always.
  93:    */
  94:   public static String id()
  95:   {
  96:     return "IDL:omg.org/IOP/CodecFactory:1.0";
  97:   }
  98: 
  99:   /**
 100:    * Cast the passed object into the CodecFactory. As the CodecFactory
 101:    * is a local object, this is not different from the java type cast.
 102:    *
 103:    * @throws BAD_PARAM if the passed object is not a CodecFactory.
 104:    */
 105:   public static CodecFactory narrow(org.omg.CORBA.Object obj)
 106:   {
 107:     try
 108:       {
 109:         return (CodecFactory) obj;
 110:       }
 111:     catch (ClassCastException ex)
 112:       {
 113:         BAD_PARAM bad = new BAD_PARAM("CodecFactory expected");
 114:         bad.initCause(ex);
 115:         throw bad;
 116:       }
 117:   }
 118: 
 119:   /**
 120:    * Narrow the given object to the CodecFactory. For the objects that are
 121:    * always local, this operation does not differ from the ordinary
 122:    * {@link #narrow} (ClassCastException will be thrown if narrowing something
 123:    * different). See OMG issue 4158.
 124:    *
 125:    * @param obj the object to cast.
 126:    *
 127:    * @return the casted CodecFactory.
 128:    *
 129:    * @since 1.5
 130:    */
 131:   public static CodecFactory unchecked_narrow(org.omg.CORBA.Object obj)
 132:   {
 133:     return narrow(obj);
 134:   }
 135: 
 136:   /**
 137:    * This should read the CodecFactory from the CDR intput stream,
 138:    * but this is not possible as CodecFactory is a local object.
 139:    *
 140:    * @specnote Suns implementation (1.4) throws this exception either.
 141:    *
 142:    * @throws MARSHAL, minor code 0 and incomplete, always.
 143:    */
 144:   public static CodecFactory read(InputStream input)
 145:   {
 146:     throw new MARSHAL(UNSUPPORTED, 0, CompletionStatus.COMPLETED_NO);
 147:   }
 148: 
 149:   /**
 150:    * This should write the CodecFactory from the CDR intput stream,
 151:    * but this is not possible as CodecFactory is a local object.
 152:    *
 153:    * @specnote Suns implementation (1.4) throws this exception either.
 154:    *
 155:    * @throws MARSHAL, minor code 0 and incomplete, always.
 156:    */
 157:   public static void write(OutputStream output, CodecFactory value)
 158:   {
 159:     throw new MARSHAL(UNSUPPORTED, 0, CompletionStatus.COMPLETED_NO);
 160:   }
 161: 
 162:   private static String UNSUPPORTED =
 163:     "The operation is unsupported for CodecFactory because it is a local object";
 164: }