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:    * The cached typecode value, computed only once.
  57:    */
  58:   private static TypeCode typeCode;
  59: 
  60:   /**
  61:    * Insert the Visibility into the given Any.
  62:    * Uses {@link Any#insert_short}.
  63:    */
  64:   public static void insert(Any any, short that)
  65:   {
  66:     any.insert_short(that);
  67:   }
  68: 
  69:   /**
  70:    * Extract the Visibility from the given Any.
  71:    * Uses {@link Any#extract_short}.
  72:    */
  73:   public static short extract(Any any)
  74:   {
  75:     return any.extract_short();
  76:   }
  77: 
  78:   /**
  79:    * Return an alias of short, named "Visibility".
  80:    */
  81:   public static TypeCode type()
  82:   {
  83:     if (typeCode == null)
  84:       {
  85:         TypeCode tshort =
  86:           OrbRestricted.Singleton.get_primitive_tc(TCKind.tk_short);
  87:         typeCode =
  88:           OrbRestricted.Singleton.create_alias_tc(id(), "Visibility", tshort);
  89:       }
  90:     return typeCode;
  91:   }
  92: 
  93:   /**
  94:    * Get the Visibility repository id.
  95:    *
  96:    * @return "IDL:omg.org/CORBA/Visibility:1.0", always.
  97:    */
  98:   public static String id()
  99:   {
 100:     return "IDL:omg.org/CORBA/Visibility:1.0";
 101:   }
 102: 
 103:   /**
 104:    * Read the visibility value (as short) from the CDR intput stream.
 105:    *
 106:    * Uses {@link InputStream#read_short()}.
 107:    *
 108:    * @param istream a stream to read from.
 109:    */
 110:   public static short read(InputStream istream)
 111:   {
 112:     return istream.read_short();
 113:   }
 114: 
 115:   /**
 116:    * Write the visibility value (as short) to the CDR output stream.
 117:    *
 118:    * USes {@link OutputStream#write_short(short)}.
 119:    *
 120:    * @param ostream a stream to write into.
 121:    * @param value a value to write.
 122:    */
 123:   public static void write(OutputStream ostream, short value)
 124:   {
 125:     ostream.write_short(value);
 126:   }