libjava/classpath/org/omg/PortableInterceptor/ObjectReferenceFactoryHelper.java

   1 /* ObjectReferenceFactoryHelper.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.PortableInterceptor;
  40
  41 import gnu.CORBA.CDR.Vio;
  42 import gnu.CORBA.Minor;
  43 import gnu.CORBA.OrbRestricted;
  44
  45 import org.omg.CORBA.Any;
  46 import org.omg.CORBA.BAD_OPERATION;
  47 import org.omg.CORBA.TypeCode;
  48 import org.omg.CORBA.ValueMember;
  49 import org.omg.CORBA.portable.InputStream;
  50 import org.omg.CORBA.portable.OutputStream;
  51 import org.omg.CORBA.VM_ABSTRACT;
  52
  53 /**
  54  * The helper operations for the CORBA object {@link ObjectReferenceFactory}.
  55  *
  56  * @since 1.5
  57  *
  58  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  59  */
  60 public abstract class ObjectReferenceFactoryHelper
  61 {
  62   /**
  63    * Get the type code of the {@link ObjectReferenceFactory}.
  64    *
  65    * @return value type code with the agreed id, named "ObjectReferenceFactory",
  66    *         abstract, no members, no base type.
  67    */
  68   public static TypeCode type()
  69   {
  70     return OrbRestricted.Singleton.create_value_tc(id(), "ObjectReferenceFactory",
  71                                       VM_ABSTRACT.value, null,
  72                                       new ValueMember[0]);
  73   }
  74
  75   /**
  76    * Insert the ObjectReferenceFactory into the given Any.
  77    *
  78    * @param any the Any to insert into.
  79    * @param that the ObjectReferenceFactory to insert.
  80    */
  81   public static void insert(Any any, ObjectReferenceFactory that)
  82   {
  83     ObjectReferenceFactoryHolder h = new ObjectReferenceFactoryHolder(that);
  84     any.insert_Streamable(h);
  85   }
  86
  87   /**
  88    * Extract the ObjectReferenceFactory from given Any.
  89    *
  90    * @throws BAD_OPERATION if the passed Any does not contain ObjectReferenceFactory.
  91    */
  92   public static ObjectReferenceFactory extract(Any any)
  93   {
  94     try
  95       {
  96         ObjectReferenceFactoryHolder h =
  97           (ObjectReferenceFactoryHolder) (any.extract_Streamable());
  98         return h.value;
  99       }
 100     catch (ClassCastException ex)
 101       {
 102         BAD_OPERATION bad =
 103           new BAD_OPERATION("ObjectReferenceFactory expected");
 104         bad.minor = Minor.Any;
 105         bad.initCause(ex);
 106         throw bad;
 107       }
 108   }
 109
 110   /**
 111    * Get the ObjectReferenceFactory repository id.
 112    *
 113    * @return "IDL:omg.org/PortableInterceptor/ObjectReferenceFactory:1.0",
 114    * always.
 115    */
 116   public static String id()
 117   {
 118     return "IDL:omg.org/PortableInterceptor/ObjectReferenceFactory:1.0";
 119   }
 120
 121   /**
 122    * Read the ObjectReferenceFactory from the CDR intput stream
 123    * (ValueBase type expected).
 124    *
 125    * @param input a org.omg.CORBA.portable stream to read from.
 126    */
 127   public static ObjectReferenceFactory read(InputStream input)
 128   {
 129     return (ObjectReferenceFactory) Vio.read(input);
 130   }
 131
 132   /**
 133    * Write the ObjectReferenceFactory to the CDR output stream (as a ValueBase).
 134    *
 135    * @param output a org.omg.CORBA.portable stream stream to write into.
 136    * @param value a value to write.
 137    */
 138   public static void write(OutputStream output, ObjectReferenceFactory value)
 139   {
 140     Vio.write(output, value);
 141   }
 142 }