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.MARSHAL;
  47: import org.omg.CORBA.ORB;
  48: import org.omg.CORBA.StructMember;
  49: import org.omg.CORBA.TCKind;
  50: import org.omg.CORBA.TypeCode;
  51: import org.omg.CORBA.portable.InputStream;
  52: import org.omg.CORBA.portable.OutputStream;
  53: 
  54: import java.io.IOException;
  55: 
  56: /**
  57:  * A helper operations for the {@link TaggedComponent}.
  58:  *
  59:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  60:  */
  61: public abstract class TaggedComponentHelper
  62: {
  63:   /**
  64:    * Create the TaggedComponent typecode (structure, named "TaggedComponent").
  65:    * The typecode states that the structure contains the following fields: tag,
  66:    * component_data.
  67:    */
  68:   public static TypeCode type()
  69:   {
  70:     ORB orb = OrbRestricted.Singleton;
  71:     StructMember[] members = new StructMember[2];
  72:     
  73:     TypeCode field;
  74:     
  75:     field = orb.create_alias_tc("IDL:omg.org/IOP/ComponentId:1.0",
  76:                                 "ComponentId",
  77:                                 orb.get_primitive_tc(TCKind.tk_ulong));
  78:     members[0] = new StructMember("tag", field, null);
  79:     
  80:     field = orb.create_sequence_tc(0, orb.get_primitive_tc(TCKind.tk_octet));
  81:     members[1] = new StructMember("component_data", field, null);
  82:     return orb.create_struct_tc(id(), "TaggedComponent", members);
  83:   }
  84: 
  85:   /**
  86:    * Insert the TaggedComponent into the given Any. This method uses the
  87:    * TaggedComponentHolder.
  88:    *
  89:    * @param any the Any to insert into.
  90:    * @param that the TaggedComponent to insert.
  91:    */
  92:   public static void insert(Any any, TaggedComponent that)
  93:   {
  94:     any.insert_Streamable(new TaggedComponentHolder(that));
  95:   }
  96: 
  97:   /**
  98:    * Extract the TaggedComponent from given Any. This method uses the
  99:    * 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:     value.component_data = new byte[input.read_long()];
 140:     try
 141:       {
 142:         input.read(value.component_data);
 143:       }
 144:     catch (IOException e)
 145:       {
 146:         MARSHAL m = new MARSHAL();
 147:         m.minor = Minor.Encapsulation;
 148:         m.initCause(e);
 149:         throw m;
 150:       }
 151:     return value;
 152:   }
 153: 
 154:   /**
 155:    * Write the structure to the CDR output stream. Writes the integer identifier
 156:    * of the tag, then the size of the tag data and then the specified number of
 157:    * bytes, representing the data of the tag.
 158:    *
 159:    * @param output a org.omg.CORBA.portable stream stream to write into.
 160:    * @param value a value to write.
 161:    */
 162:   public static void write(OutputStream output, TaggedComponent value)
 163:   {
 164:     output.write_long(value.tag);
 165:     output.write_long(value.component_data.length);
 166: 
 167:     try
 168:       {
 169:         output.write(value.component_data);
 170:       }
 171:     catch (IOException e)
 172:       {
 173:         MARSHAL m = new MARSHAL();
 174:         m.minor = Minor.Encapsulation;
 175:         m.initCause(e);
 176:         throw m;
 177:       }
 178:   }