gomp-20050608-branch/libjava/classpath/org/omg/CORBA/AnyHolder.java

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