Source for org.omg.DynamicAny.NameDynAnyPairHelper

   1: /* NameDynAnyPairHelper.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.NameDynAnyPairHolder;
  42: 
  43: import org.omg.CORBA.Any;
  44: import org.omg.CORBA.BAD_OPERATION;
  45: import org.omg.CORBA.MARSHAL;
  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 structure {@link NameDynAnyPair}.
  55:  *
  56:  * Following the 1.5 JDK specifications, DynAny (and hence any structure,
  57:  * containing DynAny) is always a local object, so the two methods of this
  58:  * helper ({@link #read} and {@link #write} are not in use, always throwing
  59:  * {@link MARSHAL}.
  60:  *
  61:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  62:  */
  63: public abstract class NameDynAnyPairHelper
  64: {
  65:   /**
  66:    * The cached typecode value, computed only once.
  67:    */
  68:   private static TypeCode typeCode;
  69: 
  70:   /**
  71:    * Extract the NameDynAnyPair from given Any.
  72:    * This method uses the NameDynAnyPairHolder.
  73:    *
  74:    * @throws BAD_OPERATION if the passed Any does not contain NameDynAnyPair.
  75:    */
  76:   public static NameDynAnyPair extract(Any any)
  77:   {
  78:     try
  79:       {
  80:         return ((NameDynAnyPairHolder) any.extract_Streamable()).value;
  81:       }
  82:     catch (ClassCastException cex)
  83:       {
  84:         BAD_OPERATION bad = new BAD_OPERATION("NameDynAnyPair expected");
  85:         bad.initCause(cex);
  86:         throw bad;
  87:       }
  88:   }
  89: 
  90:   /**
  91:    * Get the NameDynAnyPair repository id.
  92:    *
  93:    * @return "IDL:omg.org/DynamicAny/NameDynAnyPair:1.0", always.
  94:    */
  95:   public static String id()
  96:   {
  97:     return "IDL:omg.org/DynamicAny/NameDynAnyPair:1.0";
  98:   }
  99: 
 100:   /**
 101:    * Create the NameDynAnyPair typecode (structure,
 102:    * named "NameDynAnyPair").
 103:    * The typecode states that the structure contains the
 104:    * following fields: id, value.
 105:    */
 106:   public static TypeCode type()
 107:   {
 108:     if (typeCode == null)
 109:       {
 110:         ORB orb = ORB.init();
 111:         StructMember[] members = new StructMember[ 2 ];
 112: 
 113:         TypeCode field;
 114: 
 115:         field =
 116:           orb.create_alias_tc("IDL:omg.org/DynamicAny/FieldName:1.0",
 117:                               "FieldName",
 118:                               orb.get_primitive_tc(TCKind.tk_string)
 119:                              );
 120:         members [ 0 ] = new StructMember("id", field, null);
 121: 
 122:         field = DynAnyHelper.type();
 123:         members [ 1 ] = new StructMember("value", field, null);
 124:         typeCode = orb.create_struct_tc(id(), "NameDynAnyPair", members);
 125:       }
 126:     return typeCode;
 127:   }
 128: 
 129:   /**
 130:    * Insert the NameDynAnyPair into the given Any.
 131:    * This method uses the NameDynAnyPairHolder.
 132:    *
 133:    * @param any the Any to insert into.
 134:    * @param that the NameDynAnyPair to insert.
 135:    */
 136:   public static void insert(Any any, NameDynAnyPair that)
 137:   {
 138:     any.insert_Streamable(new NameDynAnyPairHolder(that));
 139:   }
 140: 
 141:   /**
 142:    * The method should read this object from the CDR input stream, but
 143:    * (following the JDK 1.5 API) it does not.
 144:    *
 145:    * @param input a org.omg.CORBA.portable stream to read from.
 146:    *
 147:    * @specenote Sun throws the same exception.
 148:    *
 149:    * @throws MARSHAL always.
 150:    */
 151:   public static NameDynAnyPair read(InputStream input)
 152:   {
 153:     throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
 154:   }
 155: 
 156:   /**
 157:    * The method should write this object to the CDR input stream, but
 158:    * (following the JDK 1.5 API) it does not.
 159:    *
 160:    * @param input a org.omg.CORBA.portable stream to read from.
 161:    *
 162:    * @specenote Sun throws the same exception.
 163:    *
 164:    * @throws MARSHAL always.
 165:    */
 166:   public static void write(OutputStream output, NameDynAnyPair value)
 167:   {
 168:     throw new MARSHAL(DynAnyFactoryHelper.not_applicable(id()));
 169:   }