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

BooleanHolder

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

A Holder class for a boolean that is used to store "out" and "inout" parameters in IDL methods. If an IDL method signature has an IDL boolean as an "out" or "inout" parameter, the programmer must pass an instance of BooleanHolder 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 myBooleanHolder is an instance of BooleanHolder, the value stored in its value field can be accessed with myBooleanHolder.value.

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

Fields Summary
public boolean
value
The boolean value held by this BooleanHolder object.
Constructors Summary
public BooleanHolder()
Constructs a new BooleanHolder object with its value field initialized to false.
public BooleanHolder(boolean initial)
Constructs a new BooleanHolder object with its value field initialized with the given boolean.

param
initial the boolean with which to initialize the value field of the newly-created BooleanHolder object

	value = initial;
Methods Summary
public void_read(org.omg.CORBA.portable.InputStream input)
Reads unmarshalled data from input and assigns it to this BooleanHolder object's value field.

param
input the InputStream object containing CDR formatted data from the wire

	value = input.read_boolean();
public TypeCode_type()
Retrieves the TypeCode object that corresponds to the value held in this BooleanHolder object.

return
the TypeCode for the value held in this BooleanHolder object

	return ORB.init().get_primitive_tc(TCKind.tk_boolean);
public void_write(org.omg.CORBA.portable.OutputStream output)
Marshals the value in this BooleanHolder object's value field to the output stream output.

param
output the OutputStream which will contain the CDR formatted data

	output.write_boolean(value);