libjava/classpath/org/omg/IOP/TaggedComponentHelper.java

   1 /* TaggedComponentHelper.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.IOP;
  40
  41 import org.omg.CORBA.Any;
  42 import org.omg.CORBA.BAD_OPERATION;
  43 import org.omg.CORBA.MARSHAL;
  44 import org.omg.CORBA.ORB;
  45 import org.omg.CORBA.StructMember;
  46 import org.omg.CORBA.TCKind;
  47 import org.omg.CORBA.TypeCode;
  48 import org.omg.CORBA.portable.InputStream;
  49 import org.omg.CORBA.portable.OutputStream;
  50
  51 import java.io.IOException;
  52
  53 /**
  54  * A helper operations for the {@link TaggedComponent}.
  55  *
  56  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  57  */
  58 public abstract class TaggedComponentHelper
  59 {
  60   /**
  61    * The cached typecode value, computed only once.
  62    */
  63   private static TypeCode typeCode;
  64
  65   /**
  66    * Create the TaggedComponent typecode (structure, named "TaggedComponent").
  67    * The typecode states that the structure contains the following fields: tag,
  68    * component_data.
  69    */
  70   public static TypeCode type()
  71   {
  72     if (typeCode == null)
  73       {
  74         ORB orb = ORB.init();
  75         StructMember[] members = new StructMember[2];
  76
  77         TypeCode field;
  78
  79         field = orb.create_alias_tc("IDL:omg.org/IOP/ComponentId:1.0",
  80                                     "ComponentId",
  81                                     orb.get_primitive_tc(TCKind.tk_ulong));
  82         members[0] = new StructMember("tag", field, null);
  83
  84         field = orb.create_sequence_tc(0, orb.get_primitive_tc(TCKind.tk_octet));
  85         members[1] = new StructMember("component_data", field, null);
  86         typeCode = orb.create_struct_tc(id(), "TaggedComponent", members);
  87       }
  88     return typeCode;
  89   }
  90
  91   /**
  92    * Insert the TaggedComponent into the given Any. This method uses the
  93    * TaggedComponentHolder.
  94    *
  95    * @param any the Any to insert into.
  96    * @param that the TaggedComponent to insert.
  97    */
  98   public static void insert(Any any, TaggedComponent that)
  99   {
 100     any.insert_Streamable(new TaggedComponentHolder(that));
 101   }
 102
 103   /**
 104    * Extract the TaggedComponent from given Any. This method uses the
 105    * TaggedComponentHolder.
 106    *
 107    * @throws BAD_OPERATION if the passed Any does not contain TaggedComponent.
 108    */
 109   public static TaggedComponent extract(Any any)
 110   {
 111     try
 112       {
 113         return ((TaggedComponentHolder) any.extract_Streamable()).value;
 114       }
 115     catch (ClassCastException cex)
 116       {
 117         BAD_OPERATION bad = new BAD_OPERATION("TaggedComponent expected");
 118         bad.initCause(cex);
 119         throw bad;
 120       }
 121   }
 122
 123   /**
 124    * Get the TaggedComponent repository id.
 125    *
 126    * @return "IDL:omg.org/IOP/TaggedComponent:1.0", always.
 127    */
 128   public static String id()
 129   {
 130     return "IDL:omg.org/IOP/TaggedComponent:1.0";
 131   }
 132
 133   /**
 134    * Read the structure from the CDR intput stream. Expects the integer
 135    * identifier of the tag, then the size of the tag data and then the specified
 136    * number of bytes, representing the data of the tag.
 137    *
 138    * @param input a org.omg.CORBA.portable stream to read from.
 139    */
 140   public static TaggedComponent read(InputStream input)
 141   {
 142     TaggedComponent value = new TaggedComponent();
 143     value.tag = input.read_long();
 144     value.component_data = new byte[input.read_long()];
 145     try
 146       {
 147         input.read(value.component_data);
 148       }
 149     catch (IOException e)
 150       {
 151         MARSHAL m = new MARSHAL();
 152         m.initCause(e);
 153         throw m;
 154       }
 155     return value;
 156   }
 157
 158   /**
 159    * Write the structure to the CDR output stream. Writes the integer identifier
 160    * of the tag, then the size of the tag data and then the specified number of
 161    * bytes, representing the data of the tag.
 162    *
 163    * @param output a org.omg.CORBA.portable stream stream to write into.
 164    * @param value a value to write.
 165    */
 166   public static void write(OutputStream output, TaggedComponent value)
 167   {
 168     output.write_long(value.tag);
 169     output.write_long(value.component_data.length);
 170
 171     try
 172       {
 173         output.write(value.component_data);
 174       }
 175     catch (IOException e)
 176       {
 177         MARSHAL m = new MARSHAL();
 178         m.initCause(e);
 179         throw m;
 180       }
 181   }
 182 }