Source for gnu.CORBA.WCharHolder

   1: /* WCharHolder.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.TCKind;
  44: import org.omg.CORBA.TypeCode;
  45: import org.omg.CORBA.portable.InputStream;
  46: import org.omg.CORBA.portable.OutputStream;
  47: import org.omg.CORBA.portable.Streamable;
  48: 
  49: /**
  50:  * A holder for CORBA <code>char</code> that is mapped into
  51:  * java <code>char</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 WCharHolder
  61:   implements Streamable
  62: {
  63:   /**
  64:    * The default type code for this holder.
  65:    */
  66:   private static final TypeCode t_char = new PrimitiveTypeCode(TCKind.tk_wchar);
  67: 
  68:   /**
  69:    * The <code>char</code> (CORBA <code>wchar</code>) value,
  70:    * held by this WCharHolder.
  71:    */
  72:   public char value;
  73: 
  74:   /**
  75:    * Constructs an instance of WCharHolder,
  76:    * initializing {@link #value} to <code>0 </code>.
  77:    */
  78:   public WCharHolder()
  79:   {
  80:   }
  81: 
  82:   /**
  83:    * Constructs an instance of WCharHolder,
  84:    * initializing {@link #value} to the given <code>char</code>.
  85:    *
  86:    * @param initial_value a value that will be assigned to the
  87:    * {@link #value} field.
  88:    */
  89:   public WCharHolder(char initial_value)
  90:   {
  91:     value = initial_value;
  92:   }
  93: 
  94:   /**
  95:    * Fill in the {@link value } field by reading the required data
  96:    * from the given stream. For <code>char</code>, the functionality
  97:    * is delegated to
  98:    * {@link org.omg.CORBA.portable.InputStream#read_wchar}.
  99:    *
 100:    * @param input the input stream to read from.
 101:    */
 102:   public void _read(InputStream input)
 103:   {
 104:     value = input.read_wchar();
 105:   }
 106: 
 107:   /**
 108:    * Returns the TypeCode, corresponding the CORBA type that is stored
 109:    * using this holder.
 110:    */
 111:   public TypeCode _type()
 112:   {
 113:     return t_char;
 114:   }
 115: 
 116:   /**
 117:    * Write the {@link value } field to the given stream.
 118:    * For <code>char</code>, the functionality
 119:    * is delegated to
 120:    * {@link org.omg.CORBA.portable.OutputStream#write_wchar(char) }.
 121:    *
 122:    * @param output the output stream to write into.
 123:    */
 124:   public void _write(OutputStream output)
 125:   {
 126:     output.write_wchar(value);
 127:   }
 128: }