libjava/classpath/org/omg/CORBA/StringHolder.java

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