Source for org.omg.CORBA.TypeCodeHolder

   1: /* TypeCodeHolder.java --
   2:    Copyright (C) 2005, 2006 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.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: 
  47: /**
  48:  * A holder for CORBA <code>TypeCode</code> that is mapped into
  49:  * java <code>TypeCode</code>.
  50:  *
  51:  *
  52:  * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
  53:  */
  54: public final class TypeCodeHolder
  55:   implements Streamable
  56: {
  57:   /**
  58:    * The default type code for this holder.
  59:    */
  60:   private static final TypeCode t_TypeCode =
  61:     new PrimitiveTypeCode(TCKind.tk_TypeCode);
  62: 
  63:   /**
  64:    * The <code>TypeCode</code> (CORBA <code>TypeCode</code>) value,
  65:    * held by this TypeCodeHolder.
  66:    */
  67:   public TypeCode value;
  68: 
  69:   /**
  70:    * Constructs an instance of TypeCodeHolder,
  71:    * initializing {@link #value} to <code>null</code>.
  72:    */
  73:   public TypeCodeHolder()
  74:   {
  75:   }
  76: 
  77:   /**
  78:    * Constructs an instance of TypeCodeHolder,
  79:    * initializing {@link #value} to the given <code>TypeCode</code>.
  80:    *
  81:    * @param initial_value a value that will be assigned to the
  82:    * {@link #value} field.
  83:    */
  84:   public TypeCodeHolder(TypeCode initial_value)
  85:   {
  86:     value = initial_value;
  87:   }
  88: 
  89:   /**
  90:    * Fill in the {@link #value} field by reading the required data
  91:    * from the given stream. For <code>TypeCode</code>, the functionality
  92:    * is delegated to
  93:    * {@link org.omg.CORBA.portable.InputStream#read_TypeCode}.
  94:    *
  95:    * @param input the input stream to read from.
  96:    */
  97:   public void _read(InputStream input)
  98:   {
  99:     value = input.read_TypeCode();
 100:   }
 101: 
 102:   /**
 103:    * Returns the TypeCode, corresponding the CORBA type that is stored
 104:    * using this holder.
 105:    */
 106:   public TypeCode _type()
 107:   {
 108:     return t_TypeCode;
 109:   }
 110: 
 111:   /**
 112:    * Write the {@link #value} field to the given stream.
 113:    * For <code>TypeCode</code>, the functionality
 114:    * is delegated to
 115:    * {@link org.omg.CORBA.portable.OutputStream#write_TypeCode(TypeCode) }.
 116:    *
 117:    * @param output the output stream to write into.
 118:    */
 119:   public void _write(OutputStream output)
 120:   {
 121:     output.write_TypeCode(value);
 122:   }
 123: }