FileDocCategorySizeDatePackage
CharHolder.javaAPI DocJava SE 5 API3020Fri Aug 26 14:58:26 BST 2005org.omg.CORBA

CharHolder

public final class CharHolder extends Object implements org.omg.CORBA.portable.Streamable
The Holder for Char. For more information on Holder files, see "Generated Files: Holder Files".

A Holder class for a char that is used to store "out" and "inout" parameters in IDL methods. If an IDL method signature has an IDL char as an "out" or "inout" parameter, the programmer must pass an instance of CharHolder as the corresponding parameter in the method invocation; for "inout" parameters, the programmer must also fill the "in" value to be sent to the server. Before the method invocation returns, the ORB will fill in the value corresponding to the "out" value returned from the server.

If myCharHolder is an instance of CharHolder, the value stored in its value field can be accessed with myCharHolder.value.

version
1.14, 09/09/97
since
JDK1.2

Fields Summary
public char
value
The char value held by this CharHolder object.
Constructors Summary
public CharHolder()
Constructs a new CharHolder object with its value field initialized to 0.

    
public CharHolder(char initial)
Constructs a new CharHolder object for the given char.

param
initial the char with which to initialize the value field of the new CharHolder object

	value = initial;
    
Methods Summary
public void_read(org.omg.CORBA.portable.InputStream input)
Reads from input and initalizes the value in this CharHolder object with the unmarshalled data.

param
input the InputStream containing CDR formatted data from the wire

	value = input.read_char();
    
public org.omg.CORBA.TypeCode_type()
Returns the TypeCode object corresponding to the value held in this CharHolder object.

return
the TypeCode of the value held in this CharHolder object

	return ORB.init().get_primitive_tc(TCKind.tk_char);
    
public void_write(org.omg.CORBA.portable.OutputStream output)
Marshals to output the value in this CharHolder object.

param
output the OutputStream which will contain the CDR formatted data

	output.write_char(value);