1 /* CharHolder.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>char</code> that is mapped into
49  * java <code>char</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 CharHolder
59   implements Streamable
60 {
61   /**
62    * The default type code for this holder.
63    */
64   private static final TypeCode t_char = new PrimitiveTypeCode(TCKind.tk_char);
65 
66   /**
67    * The <code>char</code> (CORBA <code>char</code>) value,
68    * held by this CharHolder.
69    */
70   public char value;
71 
72   /**
73    * Constructs an instance of CharHolder,
74    * initializing {@link #value} to <code>0 </code>.
75    */
CharHolder()76   public CharHolder()
77   {
78   }
79 
80   /**
81    * Constructs an instance of CharHolder,
82    * initializing {@link #value} to the given <code>char</code>.
83    *
84    * @param initial_value a value that will be assigned to the
85    * {@link #value} field.
86    */
CharHolder(char initial_value)87   public CharHolder(char initial_value)
88   {
89     value = initial_value;
90   }
91 
92   /**
93    * Fill in the {@link #value } field by reading the required data
94    * from the given stream. For <code>char</code>, the functionality
95    * is delegated to
96    * {@link org.omg.CORBA.portable.InputStream#read_char}.
97    *
98    * @param input the input stream to read from.
99    */
_read(InputStream input)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    */
_type()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    */
_write(OutputStream output)122   public void _write(OutputStream output)
123   {
124     output.write_char(value);
125   }
126 }
127