001    /* TaggedComponentHelper.java --
002       Copyright (C) 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package org.omg.IOP;
040    
041    import gnu.CORBA.Minor;
042    import gnu.CORBA.OrbRestricted;
043    
044    import org.omg.CORBA.Any;
045    import org.omg.CORBA.BAD_OPERATION;
046    import org.omg.CORBA.MARSHAL;
047    import org.omg.CORBA.ORB;
048    import org.omg.CORBA.StructMember;
049    import org.omg.CORBA.TCKind;
050    import org.omg.CORBA.TypeCode;
051    import org.omg.CORBA.portable.InputStream;
052    import org.omg.CORBA.portable.OutputStream;
053    
054    import java.io.IOException;
055    
056    /**
057     * A helper operations for the {@link TaggedComponent}.
058     *
059     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
060     */
061    public abstract class TaggedComponentHelper
062    {
063      /**
064       * Create the TaggedComponent typecode (structure, named "TaggedComponent").
065       * The typecode states that the structure contains the following fields: tag,
066       * component_data.
067       */
068      public static TypeCode type()
069      {
070        ORB orb = OrbRestricted.Singleton;
071        StructMember[] members = new StructMember[2];
072        
073        TypeCode field;
074        
075        field = orb.create_alias_tc("IDL:omg.org/IOP/ComponentId:1.0",
076                                    "ComponentId",
077                                    orb.get_primitive_tc(TCKind.tk_ulong));
078        members[0] = new StructMember("tag", field, null);
079        
080        field = orb.create_sequence_tc(0, orb.get_primitive_tc(TCKind.tk_octet));
081        members[1] = new StructMember("component_data", field, null);
082        return orb.create_struct_tc(id(), "TaggedComponent", members);
083      }
084    
085      /**
086       * Insert the TaggedComponent into the given Any. This method uses the
087       * TaggedComponentHolder.
088       *
089       * @param any the Any to insert into.
090       * @param that the TaggedComponent to insert.
091       */
092      public static void insert(Any any, TaggedComponent that)
093      {
094        any.insert_Streamable(new TaggedComponentHolder(that));
095      }
096    
097      /**
098       * Extract the TaggedComponent from given Any. This method uses the
099       * TaggedComponentHolder.
100       *
101       * @throws BAD_OPERATION if the passed Any does not contain TaggedComponent.
102       */
103      public static TaggedComponent extract(Any any)
104      {
105        try
106          {
107            return ((TaggedComponentHolder) any.extract_Streamable()).value;
108          }
109        catch (ClassCastException cex)
110          {
111            BAD_OPERATION bad = new BAD_OPERATION("TaggedComponent expected");
112            bad.minor = Minor.Any;        
113            bad.initCause(cex);
114            throw bad;
115          }
116      }
117    
118      /**
119       * Get the TaggedComponent repository id.
120       *
121       * @return "IDL:omg.org/IOP/TaggedComponent:1.0", always.
122       */
123      public static String id()
124      {
125        return "IDL:omg.org/IOP/TaggedComponent:1.0";
126      }
127    
128      /**
129       * Read the structure from the CDR intput stream. Expects the integer
130       * identifier of the tag, then the size of the tag data and then the specified
131       * number of bytes, representing the data of the tag.
132       *
133       * @param input a org.omg.CORBA.portable stream to read from.
134       */
135      public static TaggedComponent read(InputStream input)
136      {
137        TaggedComponent value = new TaggedComponent();
138        value.tag = input.read_long();
139        int length = input.read_long();
140        value.component_data = new byte[length];
141        input.read_octet_array(value.component_data, 0, length);
142        return value;
143      }
144    
145      /**
146       * Write the structure to the CDR output stream. Writes the integer identifier
147       * of the tag, then the size of the tag data and then the specified number of
148       * bytes, representing the data of the tag.
149       *
150       * @param output a org.omg.CORBA.portable stream stream to write into.
151       * @param value a value to write.
152       */
153      public static void write(OutputStream output, TaggedComponent value)
154      {
155        output.write_long(value.tag);
156        output.write_long(value.component_data.length);
157        output.write_octet_array(value.component_data, 0, value.component_data.length);
158      }
159    }