Source for gnu.CORBA.OctetHolder

   1: /* OctetHolder.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 gnu.CORBA;
  40: 
  41: import gnu.CORBA.typecodes.PrimitiveTypeCode;
  42: 
  43: import org.omg.CORBA.portable.InputStream;
  44: import org.omg.CORBA.portable.OutputStream;
  45: import org.omg.CORBA.portable.Streamable;
  46: import org.omg.CORBA.TCKind;
  47: import org.omg.CORBA.TypeCode;
  48: 
  49: /**
  50:  * A holder for CORBA <code>octet</code> that is mapped into
  51:  * java <code>long</code>.
  52:  *
  53:  * The holders have several application areas. The end user usually
  54:  * sees them implementing CORBA methods where the primitive type
  55:  * is passed by reference. While CORBA (or, for example, C) supports
  56:  * this, the java does not and a wrapper class is required.
  57:  *
  58:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  59:  */
  60: public final class OctetHolder
  61:   implements Streamable
  62: {
  63:   /**
  64:    * The default type code for this holder.
  65:    */
  66:   private static final TypeCode t_octet =
  67:     new PrimitiveTypeCode(TCKind.tk_octet);
  68: 
  69:   /**
  70:    * The <code>long</code> (CORBA <code>octet</code>) value,
  71:    * held by this OctetHolder.
  72:    */
  73:   public byte value;
  74: 
  75:   /**
  76:    * Constructs an instance of OctetHolder,
  77:    * initializing {@link #value} to <code>0 </code>.
  78:    */
  79:   public OctetHolder()
  80:   {
  81:   }
  82: 
  83:   /**
  84:    * Constructs an instance of OctetHolder,
  85:    * initializing {@link #value} to the given <code>octed</code> (byte).
  86:    *
  87:    * @param initial_value a value that will be assigned to the
  88:    * {@link #value} field.
  89:    */
  90:   public OctetHolder(byte initial_value)
  91:   {
  92:     value = initial_value;
  93:   }
  94: 
  95:   /**
  96:    * Fill in the {@link value } field by reading the required data
  97:    * from the given stream. For <code>octet</code>, the functionality
  98:    * is delegated to
  99:    * {@link org.omg.CORBA.portable.InputStream#read_octet}.
 100:    *
 101:    * @param input the input stream to read from.
 102:    */
 103:   public void _read(InputStream input)
 104:   {
 105:     value = input.read_octet();
 106:   }
 107: 
 108:   /**
 109:    * Returns the TypeCode, corresponding the CORBA type that is stored
 110:    * using this holder.
 111:    */
 112:   public TypeCode _type()
 113:   {
 114:     return t_octet;
 115:   }
 116: 
 117:   /**
 118:    * Write the {@link value } field to the given stream.
 119:    * For <code>octet</code>, the functionality
 120:    * is delegated to
 121:    * {@link org.omg.CORBA.portable.OutputStream#write_octet(long) }.
 122:    *
 123:    * @param output the output stream to write into.
 124:    */
 125:   public void _write(OutputStream output)
 126:   {
 127:     output.write_octet(value);
 128:   }
 129: }