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