gomp-20050608-branch/libjava/classpath/org/omg/DynamicAny/NameDynAnyPairHelper.java

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