Source for org.omg.IOP.CodecFactoryHelper

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