Source for org.omg.IOP.TaggedComponentHelper

   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.ORB;
  44: import org.omg.CORBA.StructMember;
  45: import org.omg.CORBA.TCKind;
  46: import org.omg.CORBA.TypeCode;
  47: import org.omg.CORBA.portable.InputStream;
  48: import org.omg.CORBA.portable.OutputStream;
  49: 
  50: /**
  51: * A helper operations for the {@link TaggedComponent}.
  52: *
  53: * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  54: */
  55: public abstract class TaggedComponentHelper
  56: {
  57:   /**
  58:    * The cached typecode value, computed only once.
  59:    */
  60:   private static TypeCode typeCode;
  61: 
  62:   /**
  63:    * Create the TaggedComponent typecode (structure,
  64:    * named "TaggedComponent").
  65:    * The typecode states that the structure contains the
  66:    * following fields: tag, component_data.
  67:    */
  68:   public static TypeCode type()
  69:   {
  70:     if (typeCode == null)
  71:       {
  72:         ORB orb = ORB.init();
  73:         StructMember[] members = new StructMember[ 2 ];
  74: 
  75:         TypeCode field;
  76: 
  77:         field =
  78:           orb.create_alias_tc("IDL:omg.org/IOP/ComponentId:1.0", "ComponentId",
  79:                               orb.get_primitive_tc(TCKind.tk_ulong)
  80:                              );
  81:         members [ 0 ] = new StructMember("tag", field, null);
  82: 
  83:         field =
  84:           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.
  93:   * This method uses the 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.
 105:    * This method uses the 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
 136:    * and then the specified number of bytes, representing the data
 137:    * of the tag.
 138:    *
 139:    * @param input a org.omg.CORBA.portable stream to read from.
 140:    */
 141:   public static TaggedComponent read(InputStream input)
 142:   {
 143:     TaggedComponent value = new TaggedComponent();
 144:     value.tag = input.read_long();
 145:     value.component_data = new byte[ input.read_long() ];
 146:     for (int i0 = 0; i0 < value.component_data.length; i0++)
 147:       value.component_data [ i0 ] = input.read_octet();
 148:     return value;
 149:   }
 150: 
 151:   /**
 152:    * Write the structure to the CDR output stream.
 153:    * Writes the integer identifier of the tag, then the size of the tag data
 154:    * and then the specified number of bytes, representing the data
 155:    * of the tag.
 156:    *
 157:    * @param output a org.omg.CORBA.portable stream stream to write into.
 158:    * @param value a value to write.
 159:    */
 160:   public static void write(OutputStream output, TaggedComponent value)
 161:   {
 162:     output.write_long(value.tag);
 163:     output.write_long(value.component_data.length);
 164:     for (int i0 = 0; i0 < value.component_data.length; i0++)
 165:       output.write_octet(value.component_data [ i0 ]);
 166:   }