001    /* NameDynAnyPairHelper.java --
002       Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package org.omg.DynamicAny;
040    
041    import gnu.CORBA.Minor;
042    import gnu.CORBA.NameDynAnyPairHolder;
043    import gnu.CORBA.OrbRestricted;
044    
045    import org.omg.CORBA.Any;
046    import org.omg.CORBA.BAD_OPERATION;
047    import org.omg.CORBA.MARSHAL;
048    import org.omg.CORBA.ORB;
049    import org.omg.CORBA.StructMember;
050    import org.omg.CORBA.TCKind;
051    import org.omg.CORBA.TypeCode;
052    import org.omg.CORBA.portable.InputStream;
053    import org.omg.CORBA.portable.OutputStream;
054    
055    /**
056     * A helper operations for the structure {@link NameDynAnyPair}.
057     *
058     * Following the 1.5 JDK specifications, DynAny (and hence any structure,
059     * containing DynAny) is always a local object, so the two methods of this
060     * helper ({@link #read} and {@link #write} are not in use, always throwing
061     * {@link MARSHAL}.
062     *
063     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
064     */
065    public abstract class NameDynAnyPairHelper
066    {
067      /**
068       * Extract the NameDynAnyPair from given Any.
069       * This method uses the NameDynAnyPairHolder.
070       *
071       * @throws BAD_OPERATION if the passed Any does not contain NameDynAnyPair.
072       */
073      public static NameDynAnyPair extract(Any any)
074      {
075        try
076          {
077            return ((NameDynAnyPairHolder) any.extract_Streamable()).value;
078          }
079        catch (ClassCastException cex)
080          {
081            BAD_OPERATION bad = new BAD_OPERATION("NameDynAnyPair expected");
082            bad.initCause(cex);
083            bad.minor = Minor.Any;        
084            throw bad;
085          }
086      }
087    
088      /**
089       * Get the NameDynAnyPair repository id.
090       *
091       * @return "IDL:omg.org/DynamicAny/NameDynAnyPair:1.0", always.
092       */
093      public static String id()
094      {
095        return "IDL:omg.org/DynamicAny/NameDynAnyPair:1.0";
096      }
097    
098      /**
099       * 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      }
164    }