001/* ParameterModeHelper.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.OrbRestricted;
042
043import org.omg.CORBA.portable.InputStream;
044import org.omg.CORBA.portable.OutputStream;
045
046/**
047 * A helper operations for a method parameter modes.
048 * A method parameter can pass the value (PARAM_IN), be used as a placeholder
049 * to return the value (PARAM_OUT) or both pass the data and be used as a
050 * placeholder to return the changed value (PARAM_INOUT).
051 *
052 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
053 */
054public abstract class ParameterModeHelper
055{
056  /**
057   * Insert the parameter mode into the given Any.
058   */
059  public static void insert(Any any, ParameterMode that)
060  {
061    any.insert_Streamable(new ParameterModeHolder(that));
062  }
063
064  /**
065   * Extract the parameter mode from the given Any.
066   */
067  public static ParameterMode extract(Any any)
068  {
069    return ((ParameterModeHolder) any.extract_Streamable()).value;
070  }
071
072  /**
073   * Get the parameter mode typecode (enumeration, named "ParameterMode").
074   * The typecode states that the enumeration can obtain one of
075   * the following values: PARAM_IN ,PARAM_OUT ,PARAM_INOUT .
076   */
077  public static TypeCode type()
078  {
079        String[] members =
080          new String[] { "PARAM_IN", "PARAM_OUT", "PARAM_INOUT" };
081
082        return
083          OrbRestricted.Singleton.create_enum_tc(id(), "ParameterMode", members);
084  }
085
086  /**
087   * Get the parameter mode repository id.
088   *
089   * @return "IDL:omg.org/CORBA/ParameterMode:1.0", always.
090   */
091  public static String id()
092  {
093    return "IDL:omg.org/CORBA/ParameterMode:1.0";
094  }
095
096  /**
097   * Read the enumeration value (as int) from the CDR intput stream.
098   *
099   * @param istream a stream to read from.
100   */
101  public static ParameterMode read(InputStream istream)
102  {
103    return ParameterMode.from_int(istream.read_long());
104  }
105
106  /**
107   * Write the enumeration value (as int) to the CDR output stream.
108   *
109   * @param ostream a stream to write into.
110   * @param value a value to write.
111   */
112  public static void write(OutputStream ostream, ParameterMode value)
113  {
114    ostream.write_long(value.value());
115  }
116}