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

   1 /* ObjectIdHelper.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.PortableInterceptor;
  40
  41 import gnu.CORBA.OrbRestricted;
  42
  43 import org.omg.CORBA.Any;
  44 import org.omg.CORBA.ORB;
  45 import org.omg.CORBA.OctetSeqHelper;
  46 import org.omg.CORBA.OctetSeqHolder;
  47 import org.omg.CORBA.TypeCode;
  48 import org.omg.CORBA.portable.InputStream;
  49 import org.omg.CORBA.portable.OutputStream;
  50
  51 /**
  52  * The Object Id of this package is defined in OMG specification as a byte array.
  53  * As such, the Object Id needs no helper, but one is included in the API anyway.
  54  *
  55  * @since 1.5
  56  *
  57  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  58  */
  59 public abstract class ObjectIdHelper
  60 {
  61   /**
  62    * Insert the Object Id into Any.
  63    *
  64    * @param a the Any to insert into.
  65    * @param that the string to insert.
  66    */
  67   public static void insert(Any a, byte[] that)
  68   {
  69     a.insert_Streamable(new OctetSeqHolder(that));
  70     a.type(type());
  71   }
  72
  73   /**
  74    * Extract the Object Id from Any.
  75    *
  76    * @param a the Any to extract from.
  77    */
  78   public static byte[] extract(Any a)
  79   {
  80     return ((OctetSeqHolder) a.extract_Streamable()).value;
  81   }
  82
  83   /**
  84    * Return an alias typecode (an alias of the octet sequence).
  85    */
  86   public static TypeCode type()
  87   {
  88     ORB orb = OrbRestricted.Singleton;
  89     return orb.create_alias_tc(id(), "ObjectId", OctetSeqHelper.type());
  90   }
  91
  92   /**
  93    * Return the Object Id repository id.
  94    * @return "IDL:omg.org/PortableInterceptor/ObjectId:1.0", always.
  95    */
  96   public static String id()
  97   {
  98     return "IDL:omg.org/PortableInterceptor/ObjectId:1.0";
  99   }
 100
 101   /**
 102    * Read the Object Id as a byte array.
 103    *
 104    * @param input the stream to read from.
 105    */
 106   public static byte[] read(InputStream input)
 107   {
 108     return OctetSeqHelper.read(input);
 109   }
 110
 111   /**
 112    * Write the Object Id as a byte array.
 113    *
 114    * @param output the stream to write into.
 115    * @param value the Object Id value to write.
 116    */
 117   public static void write(OutputStream output, byte[] value)
 118   {
 119     OctetSeqHelper.write(output, value);
 120   }
 121 }