001/* CharHolder.java --
002   Copyright (C) 2005, 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package org.omg.CORBA;
040
041import gnu.CORBA.typecodes.PrimitiveTypeCode;
042
043import org.omg.CORBA.portable.InputStream;
044import org.omg.CORBA.portable.OutputStream;
045import org.omg.CORBA.portable.Streamable;
046
047/**
048 * A holder for CORBA <code>char</code> that is mapped into
049 * java <code>char</code>.
050 *
051 * The holders have several application areas. The end user usually
052 * sees them implementing CORBA methods where the primitive type
053 * is passed by reference. While CORBA (or, for example, C) supports
054 * this, the java does not and a wrapper class is required.
055 *
056 * @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
057 */
058public final class CharHolder
059  implements Streamable
060{
061  /**
062   * The default type code for this holder.
063   */
064  private static final TypeCode t_char = new PrimitiveTypeCode(TCKind.tk_char);
065
066  /**
067   * The <code>char</code> (CORBA <code>char</code>) value,
068   * held by this CharHolder.
069   */
070  public char value;
071
072  /**
073   * Constructs an instance of CharHolder,
074   * initializing {@link #value} to <code>0 </code>.
075   */
076  public CharHolder()
077  {
078  }
079
080  /**
081   * Constructs an instance of CharHolder,
082   * initializing {@link #value} to the given <code>char</code>.
083   *
084   * @param initial_value a value that will be assigned to the
085   * {@link #value} field.
086   */
087  public CharHolder(char initial_value)
088  {
089    value = initial_value;
090  }
091
092  /**
093   * Fill in the {@link #value } field by reading the required data
094   * from the given stream. For <code>char</code>, the functionality
095   * is delegated to
096   * {@link org.omg.CORBA.portable.InputStream#read_char}.
097   *
098   * @param input the input stream to read from.
099   */
100  public void _read(InputStream input)
101  {
102    value = input.read_char();
103  }
104
105  /**
106   * Returns the TypeCode, corresponding the CORBA type that is stored
107   * using this holder.
108   */
109  public TypeCode _type()
110  {
111    return t_char;
112  }
113
114  /**
115   * Write the {@link #value } field to the given stream.
116   * For <code>char</code>, the functionality
117   * is delegated to
118   * {@link org.omg.CORBA.portable.OutputStream#write_char(char) }.
119   *
120   * @param output the output stream to write into.
121   */
122  public void _write(OutputStream output)
123  {
124    output.write_char(value);
125  }
126}