001/* NameValuePairHelper.java --
002   Copyright (C) 2005 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.CORBA;
040
041import gnu.CORBA.DynAn.NameValuePairHolder;
042import gnu.CORBA.typecodes.AliasTypeCode;
043import gnu.CORBA.typecodes.PrimitiveTypeCode;
044import gnu.CORBA.typecodes.StringTypeCode;
045import gnu.CORBA.Minor;
046import gnu.CORBA.OrbRestricted;
047
048import org.omg.CORBA.portable.InputStream;
049import org.omg.CORBA.portable.OutputStream;
050
051/**
052 * The helper operations for {@link NameValuePair}.
053 *
054 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
055 */
056public abstract class NameValuePairHelper
057{
058  /**
059   * The {@link NameValuePair} repository id,
060   * 'IDL:omg.org/CORBA/NameValuePair:1.0'.
061   */
062  private static String _id = "IDL:omg.org/CORBA/NameValuePair:1.0";
063
064  /**
065   * Extract the NameValuePair from the given {@link Any}.
066   */
067  public static NameValuePair extract(Any a)
068  {
069    try
070      {
071        return ((NameValuePairHolder) a.extract_Streamable()).value;
072      }
073    catch (ClassCastException ex)
074      {
075        BAD_OPERATION bad = new BAD_OPERATION("NameValuePair expected");
076        bad.minor = Minor.Any;
077        throw bad;
078      }
079  }
080
081  /**
082   * Return the NameValuePair repository id.
083   */
084  public static String id()
085  {
086    return _id;
087  }
088
089  /**
090   * Insert the NameValuePair into the given {@link Any}.
091   */
092  public static void insert(Any a, NameValuePair that)
093  {
094    a.insert_Streamable(new NameValuePairHolder(that));
095  }
096
097  /**
098   * Read the NameValuePair from the given CDR stream. First reads the
099   * name (id) as string, then the value as {@link Any}.
100   */
101  public static NameValuePair read(InputStream istream)
102  {
103    NameValuePair p = new NameValuePair();
104    p.id = istream.read_string();
105    p.value = istream.read_any();
106    return p;
107  }
108
109  /**
110   * Create the type code for the name value pair.
111   */
112  public static TypeCode type()
113  {
114    StructMember[] members = new StructMember[2];
115
116    TypeCode t_id = new AliasTypeCode(new StringTypeCode(TCKind.tk_string), "",
117                                      "id");
118
119    members[0] = new StructMember("id", t_id, null);
120
121    members[1] = new StructMember("value",
122                                  new PrimitiveTypeCode(TCKind.tk_any), null);
123
124    return OrbRestricted.Singleton.create_struct_tc(id(), "NameValuePair",
125                                                    members);
126  }
127
128  /**
129   * Write the exception to the CDR output stream. First writes the
130   * name (id), then the value as {@link Any}.
131   */
132  public static void write(OutputStream ostream, NameValuePair value)
133  {
134    ostream.write_string(value.id);
135    ostream.write_any(value.value);
136  }
137}