001    /* NameValuePairHelper.java --
002       Copyright (C) 2005 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.NameValuePairHolder;
043    import gnu.CORBA.OrbRestricted;
044    
045    import org.omg.CORBA.Any;
046    import org.omg.CORBA.BAD_OPERATION;
047    import org.omg.CORBA.ORB;
048    import org.omg.CORBA.StructMember;
049    import org.omg.CORBA.TCKind;
050    import org.omg.CORBA.TypeCode;
051    import org.omg.CORBA.portable.InputStream;
052    import org.omg.CORBA.portable.OutputStream;
053    
054    /**
055     * A helper operations for the structure {@link NameValuePair}.
056     *
057     * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
058     */
059    public abstract class NameValuePairHelper
060    {
061      /**
062       * Create the NameValuePair typecode (structure,
063       * named "NameValuePair").
064       * The typecode states that the structure contains the
065       * following fields: id, value.
066       */
067      public static TypeCode type()
068      {
069        ORB orb = OrbRestricted.Singleton;
070        StructMember[] members = new StructMember[ 2 ];
071    
072        TypeCode field;
073    
074        field =
075          orb.create_alias_tc("IDL:omg.org/DynamicAny/FieldName:1.0",
076                              "FieldName",
077                              orb.get_primitive_tc(TCKind.tk_string)
078          );
079        members [ 0 ] = new StructMember("id", field, null);
080    
081        field = orb.get_primitive_tc(TCKind.tk_any);
082        members [ 1 ] = new StructMember("value", field, null);
083        return orb.create_struct_tc(id(), "NameValuePair", members);
084      }
085    
086      /**
087       * Insert the NameValuePair into the given Any.
088       * This method uses the NameValuePairHolder.
089       *
090       * @param any the Any to insert into.
091       * @param that the NameValuePair to insert.
092       */
093      public static void insert(Any any, NameValuePair that)
094      {
095        any.insert_Streamable(new NameValuePairHolder(that));
096      }
097    
098      /**
099       * 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    }