Source for org.omg.CORBA.VisibilityHelper

   1: /* VisibilityHelper.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package org.omg.CORBA;
  40: 
  41: import gnu.CORBA.OrbRestricted;
  42: 
  43: import org.omg.CORBA.portable.InputStream;
  44: import org.omg.CORBA.portable.OutputStream;
  45: 
  46: /**
  47:  * A helper operations for a Visibility that is mapped into java and CORBA
  48:  * <code>short</code>. The Visibility normally takes one of the two values,
  49:  * {@link PUBLIC_MEMBER#value} or {@link PRIVATE_MEMBER#value}.
  50:  *
  51:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  52:  */
  53: public abstract class VisibilityHelper
  54: {
  55:   /**
  56:    * Insert the Visibility into the given Any.
  57:    * Uses {@link Any#insert_short}.
  58:    */
  59:   public static void insert(Any any, short that)
  60:   {
  61:     any.insert_short(that);
  62:   }
  63: 
  64:   /**
  65:    * Extract the Visibility from the given Any.
  66:    * Uses {@link Any#extract_short}.
  67:    */
  68:   public static short extract(Any any)
  69:   {
  70:     return any.extract_short();
  71:   }
  72: 
  73:   /**
  74:    * Return an alias of short, named "Visibility".
  75:    */
  76:   public static TypeCode type()
  77:   {
  78:         TypeCode tshort =
  79:           OrbRestricted.Singleton.get_primitive_tc(TCKind.tk_short);
  80:         return
  81:           OrbRestricted.Singleton.create_alias_tc(id(), "Visibility", tshort);
  82:   }
  83: 
  84:   /**
  85:    * Get the Visibility repository id.
  86:    *
  87:    * @return "IDL:omg.org/CORBA/Visibility:1.0", always.
  88:    */
  89:   public static String id()
  90:   {
  91:     return "IDL:omg.org/CORBA/Visibility:1.0";
  92:   }
  93: 
  94:   /**
  95:    * Read the visibility value (as short) from the CDR intput stream.
  96:    *
  97:    * Uses {@link InputStream#read_short()}.
  98:    *
  99:    * @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: }