Source for org.omg.DynamicAny.NameValuePairHelper

   1: /* NameValuePairHelper.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.DynamicAny;
  40: 
  41: import gnu.CORBA.NameValuePairHolder;
  42: 
  43: import org.omg.CORBA.Any;
  44: import org.omg.CORBA.BAD_OPERATION;
  45: import org.omg.CORBA.ORB;
  46: import org.omg.CORBA.StructMember;
  47: import org.omg.CORBA.TCKind;
  48: import org.omg.CORBA.TypeCode;
  49: import org.omg.CORBA.portable.InputStream;
  50: import org.omg.CORBA.portable.OutputStream;
  51: 
  52: /**
  53:  * A helper operations for the structure {@link NameValuePair}.
  54:  *
  55:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  56:  */
  57: public abstract class NameValuePairHelper
  58: {
  59:   /**
  60:    * The cached typecode value, computed only once.
  61:    */
  62:   private static TypeCode typeCode;
  63: 
  64:   /**
  65:    * Create the NameValuePair typecode (structure,
  66:    * named "NameValuePair").
  67:    * The typecode states that the structure contains the
  68:    * following fields: id, value.
  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 =
  80:           orb.create_alias_tc("IDL:omg.org/DynamicAny/FieldName:1.0",
  81:                               "FieldName",
  82:                               orb.get_primitive_tc(TCKind.tk_string)
  83:                              );
  84:         members [ 0 ] = new StructMember("id", field, null);
  85: 
  86:         field = orb.get_primitive_tc(TCKind.tk_any);
  87:         members [ 1 ] = new StructMember("value", field, null);
  88:         typeCode = orb.create_struct_tc(id(), "NameValuePair", members);
  89:       }
  90:     return typeCode;
  91:   }
  92: 
  93:   /**
  94:    * Insert the NameValuePair into the given Any.
  95:    * This method uses the NameValuePairHolder.
  96:    *
  97:    * @param any the Any to insert into.
  98:    * @param that the NameValuePair to insert.
  99:    */
 100:   public static void insert(Any any, NameValuePair that)
 101:   {
 102:     any.insert_Streamable(new NameValuePairHolder(that));
 103:   }
 104: 
 105:   /**
 106:    * Extract the NameValuePair from given Any.
 107:    * This method uses the NameValuePairHolder.
 108:    *
 109:    * @throws BAD_OPERATION if the passed Any does not contain NameValuePair.
 110:    */
 111:   public static NameValuePair extract(Any any)
 112:   {
 113:     try
 114:       {
 115:         return ((NameValuePairHolder) any.extract_Streamable()).value;
 116:       }
 117:     catch (ClassCastException cex)
 118:       {
 119:         BAD_OPERATION bad = new BAD_OPERATION("NameValuePair expected");
 120:         bad.initCause(cex);
 121:         throw bad;
 122:       }
 123:   }
 124: 
 125:   /**
 126:    * Get the NameValuePair repository id.
 127:    *
 128:    * @return "IDL:omg.org/DynamicAny/NameValuePair:1.0", always.
 129:    */
 130:   public static String id()
 131:   {
 132:     return "IDL:omg.org/DynamicAny/NameValuePair:1.0";
 133:   }
 134: 
 135:   /**
 136:    * Read the structure from the CDR intput stream.
 137:    *
 138:    * @param input a org.omg.CORBA.portable stream to read from.
 139:    */
 140:   public static NameValuePair read(InputStream input)
 141:   {
 142:     NameValuePair value = new NameValuePair();
 143:     value.id = input.read_string();
 144:     value.value = input.read_any();
 145:     return value;
 146:   }
 147: 
 148:   /**
 149:    * Write the structure to the CDR output stream.
 150:    *
 151:    * @param output a org.omg.CORBA.portable stream stream to write into.
 152:    * @param value a value to write.
 153:    */
 154:   public static void write(OutputStream output, NameValuePair value)
 155:   {
 156:     output.write_string(value.id);
 157:     output.write_any(value.value);
 158:   }