001/* TaggedComponentHelper.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.IOP;
040
041import gnu.CORBA.Minor;
042import gnu.CORBA.OrbRestricted;
043
044import org.omg.CORBA.Any;
045import org.omg.CORBA.BAD_OPERATION;
046import org.omg.CORBA.ORB;
047import org.omg.CORBA.StructMember;
048import org.omg.CORBA.TCKind;
049import org.omg.CORBA.TypeCode;
050import org.omg.CORBA.portable.InputStream;
051import org.omg.CORBA.portable.OutputStream;
052
053/**
054 * A helper operations for the {@link TaggedComponent}.
055 *
056 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
057 */
058public abstract class TaggedComponentHelper
059{
060  /**
061   * Create the TaggedComponent typecode (structure, named "TaggedComponent").
062   * The typecode states that the structure contains the following fields: tag,
063   * component_data.
064   */
065  public static TypeCode type()
066  {
067    ORB orb = OrbRestricted.Singleton;
068    StructMember[] members = new StructMember[2];
069    
070    TypeCode field;
071    
072    field = orb.create_alias_tc("IDL:omg.org/IOP/ComponentId:1.0",
073                                "ComponentId",
074                                orb.get_primitive_tc(TCKind.tk_ulong));
075    members[0] = new StructMember("tag", field, null);
076    
077    field = orb.create_sequence_tc(0, orb.get_primitive_tc(TCKind.tk_octet));
078    members[1] = new StructMember("component_data", field, null);
079    return orb.create_struct_tc(id(), "TaggedComponent", members);
080  }
081
082  /**
083   * Insert the TaggedComponent into the given Any. This method uses the
084   * TaggedComponentHolder.
085   *
086   * @param any the Any to insert into.
087   * @param that the TaggedComponent to insert.
088   */
089  public static void insert(Any any, TaggedComponent that)
090  {
091    any.insert_Streamable(new TaggedComponentHolder(that));
092  }
093
094  /**
095   * Extract the TaggedComponent from given Any. This method uses the
096   * TaggedComponentHolder.
097   *
098   * @throws BAD_OPERATION if the passed Any does not contain TaggedComponent.
099   */
100  public static TaggedComponent extract(Any any)
101  {
102    try
103      {
104        return ((TaggedComponentHolder) any.extract_Streamable()).value;
105      }
106    catch (ClassCastException cex)
107      {
108        BAD_OPERATION bad = new BAD_OPERATION("TaggedComponent expected");
109        bad.minor = Minor.Any;        
110        bad.initCause(cex);
111        throw bad;
112      }
113  }
114
115  /**
116   * Get the TaggedComponent repository id.
117   *
118   * @return "IDL:omg.org/IOP/TaggedComponent:1.0", always.
119   */
120  public static String id()
121  {
122    return "IDL:omg.org/IOP/TaggedComponent:1.0";
123  }
124
125  /**
126   * Read the structure from the CDR intput stream. Expects the integer
127   * identifier of the tag, then the size of the tag data and then the specified
128   * number of bytes, representing the data of the tag.
129   *
130   * @param input a org.omg.CORBA.portable stream to read from.
131   */
132  public static TaggedComponent read(InputStream input)
133  {
134    TaggedComponent value = new TaggedComponent();
135    value.tag = input.read_long();
136    int length = input.read_long();
137    value.component_data = new byte[length];
138    input.read_octet_array(value.component_data, 0, length);
139    return value;
140  }
141
142  /**
143   * Write the structure to the CDR output stream. Writes the integer identifier
144   * of the tag, then the size of the tag data and then the specified number of
145   * bytes, representing the data of the tag.
146   *
147   * @param output a org.omg.CORBA.portable stream stream to write into.
148   * @param value a value to write.
149   */
150  public static void write(OutputStream output, TaggedComponent value)
151  {
152    output.write_long(value.tag);
153    output.write_long(value.component_data.length);
154    output.write_octet_array(value.component_data, 0, value.component_data.length);
155  }
156}