001/* ComponentIdHelper.java --
002   Copyright (C) 2005, 2006 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.IOP;
040
041import gnu.CORBA.OrbRestricted;
042
043import org.omg.CORBA.Any;
044import org.omg.CORBA.BAD_OPERATION;
045import org.omg.CORBA.ORB;
046import org.omg.CORBA.TCKind;
047import org.omg.CORBA.TypeCode;
048import org.omg.CORBA.portable.InputStream;
049import org.omg.CORBA.portable.OutputStream;
050
051/**
052* A helper operations for th Component id. A Component Id is an integer
053* constant and needs no helper, but the one is included to
054* to facilitate the automated code handling.
055*
056* @specnote In this implementation, this class is not in use. Its "logical"
057* place is the read/write methods of the TaggedComponentHelper, to handle the
058* first member (int) of the record of the Tagged Component.
059*
060* @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
061*/
062public abstract class ComponentIdHelper
063{
064  /**
065   * Create the ComponentId typecode (alias of CORBA ulong, named "ComponentId".
066   */
067  public static TypeCode type()
068  {
069    ORB orb = OrbRestricted.Singleton;
070    return orb.create_alias_tc("IDL:omg.org/IOP/ComponentId:1.0",
071                               "ComponentId",
072                               orb.get_primitive_tc(TCKind.tk_ulong));
073  }
074
075  /**
076  * Insert the int into the given Any.
077  */
078  public static void insert(Any any, int that)
079  {
080    any.insert_ulong(that);
081  }
082
083  /**
084   * Extract the int from given Any.
085   *
086   * @throws BAD_OPERATION if the passed Any does not contain int.
087   */
088  public static int extract(Any any)
089  {
090    return any.extract_ulong();
091  }
092
093  /**
094   * Get the int repository id.
095   *
096   * @return "IDL:omg.org/IOP/ComponentId:1.0", always.
097   */
098  public static String id()
099  {
100    return "IDL:omg.org/IOP/ComponentId:1.0";
101  }
102
103  /**
104   * Read the ComponentId from the CDR intput stream.
105   *
106   * @param input a org.omg.CORBA.portable stream to read from.
107   */
108  public static int read(InputStream input)
109  {
110    return input.read_ulong();
111  }
112
113  /**
114   * Write the ComponentId to the CDR output stream (as int).
115   *
116   * @param output a org.omg.CORBA.portable stream stream to write into.
117   * @param value a value to write.
118   */
119  public static void write(OutputStream output, int value)
120  {
121    output.write_ulong(value);
122  }
123}