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 gnu.CORBA.Minor;
  42: import gnu.CORBA.OrbRestricted;
  43: 
  44: import org.omg.CORBA.Any;
  45: import org.omg.CORBA.BAD_OPERATION;
  46: import org.omg.CORBA.ORB;
  47: import org.omg.CORBA.StructMember;
  48: import org.omg.CORBA.TCKind;
  49: import org.omg.CORBA.TypeCode;
  50: import org.omg.CORBA.portable.InputStream;
  51: import org.omg.CORBA.portable.OutputStream;
  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:    * Create the TaggedComponent typecode (structure, named "TaggedComponent").
  62:    * The typecode states that the structure contains the following fields: tag,
  63:    * component_data.
  64:    */
  65:   public static TypeCode type()
  66:   {
  67:     ORB orb = OrbRestricted.Singleton;
  68:     StructMember[] members = new StructMember[2];
  69: 
  70:     TypeCode field;
  71: 
  72:     field = orb.create_alias_tc("IDL:omg.org/IOP/ComponentId:1.0",
  73:                                 "ComponentId",
  74:                                 orb.get_primitive_tc(TCKind.tk_ulong));
  75:     members[0] = new StructMember("tag", field, null);
  76: 
  77:     field = orb.create_sequence_tc(0, orb.get_primitive_tc(TCKind.tk_octet));
  78:     members[1] = new StructMember("component_data", field, null);
  79:     return orb.create_struct_tc(id(), "TaggedComponent", members);
  80:   }
  81: 
  82:   /**
  83:    * Insert the TaggedComponent into the given Any. This method uses the
  84:    * TaggedComponentHolder.
  85:    *
  86:    * @param any the Any to insert into.
  87:    * @param that the TaggedComponent to insert.
  88:    */
  89:   public static void insert(Any any, TaggedComponent that)
  90:   {
  91:     any.insert_Streamable(new TaggedComponentHolder(that));
  92:   }
  93: 
  94:   /**
  95:    * Extract the TaggedComponent from given Any. This method uses the
  96:    * TaggedComponentHolder.
  97:    *
  98:    * @throws BAD_OPERATION if the passed Any does not contain TaggedComponent.
  99:    */
 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: }