001/* ObjectIdHelper.java --
002   Copyright (C) 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.PortableInterceptor;
040
041import gnu.CORBA.OrbRestricted;
042
043import org.omg.CORBA.Any;
044import org.omg.CORBA.ORB;
045import org.omg.CORBA.OctetSeqHelper;
046import org.omg.CORBA.OctetSeqHolder;
047import org.omg.CORBA.TypeCode;
048import org.omg.CORBA.portable.InputStream;
049import org.omg.CORBA.portable.OutputStream;
050
051/**
052 * The Object Id of this package is defined in OMG specification as a byte array.
053 * As such, the Object Id needs no helper, but one is included in the API anyway.
054 * 
055 * @since 1.5 
056 *
057 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
058 */
059public abstract class ObjectIdHelper
060{
061  /**
062   * Insert the Object Id into Any.
063   *
064   * @param a the Any to insert into.
065   * @param that the string to insert.
066   */
067  public static void insert(Any a, byte[] that)
068  {
069    a.insert_Streamable(new OctetSeqHolder(that));
070    a.type(type());
071  }
072
073  /**
074   * Extract the Object Id from Any.
075   * 
076   * @param a the Any to extract from.
077   */
078  public static byte[] extract(Any a)
079  {
080    return ((OctetSeqHolder) a.extract_Streamable()).value;
081  }
082
083  /**
084   * Return an alias typecode (an alias of the octet sequence).
085   */
086  public static TypeCode type()
087  {
088    ORB orb = OrbRestricted.Singleton;
089    return orb.create_alias_tc(id(), "ObjectId", OctetSeqHelper.type());
090  }
091
092  /**
093   * Return the Object Id repository id.
094   * @return "IDL:omg.org/PortableInterceptor/ObjectId:1.0", always.
095   */
096  public static String id()
097  {
098    return "IDL:omg.org/PortableInterceptor/ObjectId:1.0";
099  }
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}