Source for org.omg.DynamicAny.NameDynAnyPairHelper

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