001/* VisibilityHelper.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 Visibility that is mapped into java and CORBA
048 * <code>short</code>. The Visibility normally takes one of the two values,
049 * {@link PUBLIC_MEMBER#value} or {@link PRIVATE_MEMBER#value}.
050 *
051 * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
052 */
053public abstract class VisibilityHelper
054{
055  /**
056   * Insert the Visibility into the given Any.
057   * Uses {@link Any#insert_short}.
058   */
059  public static void insert(Any any, short that)
060  {
061    any.insert_short(that);
062  }
063
064  /**
065   * Extract the Visibility from the given Any.
066   * Uses {@link Any#extract_short}.
067   */
068  public static short extract(Any any)
069  {
070    return any.extract_short();
071  }
072
073  /**
074   * Return an alias of short, named "Visibility".
075   */
076  public static TypeCode type()
077  {
078        TypeCode tshort =
079          OrbRestricted.Singleton.get_primitive_tc(TCKind.tk_short);
080        return
081          OrbRestricted.Singleton.create_alias_tc(id(), "Visibility", tshort);
082  }
083
084  /**
085   * Get the Visibility repository id.
086   *
087   * @return "IDL:omg.org/CORBA/Visibility:1.0", always.
088   */
089  public static String id()
090  {
091    return "IDL:omg.org/CORBA/Visibility:1.0";
092  }
093
094  /**
095   * Read the visibility value (as short) from the CDR intput stream.
096   *
097   * Uses {@link InputStream#read_short()}.
098   *
099   * @param istream a stream to read from.
100   */
101  public static short read(InputStream istream)
102  {
103    return istream.read_short();
104  }
105
106  /**
107   * Write the visibility value (as short) to the CDR output stream.
108   *
109   * USes {@link OutputStream#write_short(short)}.
110   *
111   * @param ostream a stream to write into.
112   * @param value a value to write.
113   */
114  public static void write(OutputStream ostream, short value)
115  {
116    ostream.write_short(value);
117  }
118}