org.omg.CORBA
Class BooleanHolder

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by org.omg.CORBA.BooleanHolder
All Implemented Interfaces:
Streamable sample code for org.omg.CORBA.portable.Streamable definition code for org.omg.CORBA.portable.Streamable

public final class BooleanHolder
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Streamable sample code for org.omg.CORBA.portable.Streamable definition code for 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.

Since:
JDK1.2

Field Summary
 boolean value sample code for org.omg.CORBA.BooleanHolder.value definition code for org.omg.CORBA.BooleanHolder.value
          The boolean value held by this BooleanHolder object.
 
Constructor Summary
BooleanHolder sample code for org.omg.CORBA.BooleanHolder.BooleanHolder() definition code for org.omg.CORBA.BooleanHolder.BooleanHolder() ()
          Constructs a new BooleanHolder object with its value field initialized to false.
BooleanHolder sample code for org.omg.CORBA.BooleanHolder.BooleanHolder(boolean) definition code for org.omg.CORBA.BooleanHolder.BooleanHolder(boolean) (boolean initial)
          Constructs a new BooleanHolder object with its value field initialized with the given boolean.
 
Method Summary
 void _read sample code for org.omg.CORBA.BooleanHolder._read(org.omg.CORBA.portable.InputStream) definition code for org.omg.CORBA.BooleanHolder._read(org.omg.CORBA.portable.InputStream) (InputStream sample code for org.omg.CORBA.portable.InputStream definition code for org.omg.CORBA.portable.InputStream  input)
          Reads unmarshalled data from input and assigns it to this BooleanHolder object's value field.
 TypeCode sample code for org.omg.CORBA.TypeCode definition code for org.omg.CORBA.TypeCode _type sample code for org.omg.CORBA.BooleanHolder._type() definition code for org.omg.CORBA.BooleanHolder._type() ()
          Retrieves the TypeCode object that corresponds to the value held in this BooleanHolder object.
 void _write sample code for org.omg.CORBA.BooleanHolder._write(org.omg.CORBA.portable.OutputStream) definition code for org.omg.CORBA.BooleanHolder._write(org.omg.CORBA.portable.OutputStream) (OutputStream sample code for org.omg.CORBA.portable.OutputStream definition code for org.omg.CORBA.portable.OutputStream  output)
          Marshals the value in this BooleanHolder object's value field to the output stream output.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

value sample code for org.omg.CORBA.BooleanHolder.value

public boolean value
The boolean value held by this BooleanHolder object.

Constructor Detail

BooleanHolder sample code for org.omg.CORBA.BooleanHolder() definition code for org.omg.CORBA.BooleanHolder()

public BooleanHolder()
Constructs a new BooleanHolder object with its value field initialized to false.


BooleanHolder sample code for org.omg.CORBA.BooleanHolder(boolean) definition code for org.omg.CORBA.BooleanHolder(boolean)

public BooleanHolder(boolean initial)
Constructs a new BooleanHolder object with its value field initialized with the given boolean.

Parameters:
initial - the boolean with which to initialize the value field of the newly-created BooleanHolder object
Method Detail

_read sample code for org.omg.CORBA.BooleanHolder._read(org.omg.CORBA.portable.InputStream) definition code for org.omg.CORBA.BooleanHolder._read(org.omg.CORBA.portable.InputStream)

public void _read(InputStream sample code for org.omg.CORBA.portable.InputStream definition code for org.omg.CORBA.portable.InputStream  input)
Reads unmarshalled data from input and assigns it to this BooleanHolder object's value field.

Specified by:
_read sample code for org.omg.CORBA.portable.Streamable._read(org.omg.CORBA.portable.InputStream) definition code for org.omg.CORBA.portable.Streamable._read(org.omg.CORBA.portable.InputStream) in interface Streamable sample code for org.omg.CORBA.portable.Streamable definition code for org.omg.CORBA.portable.Streamable
Parameters:
input - the InputStream object containing CDR formatted data from the wire

_write sample code for org.omg.CORBA.BooleanHolder._write(org.omg.CORBA.portable.OutputStream) definition code for org.omg.CORBA.BooleanHolder._write(org.omg.CORBA.portable.OutputStream)

public void _write(OutputStream sample code for org.omg.CORBA.portable.OutputStream definition code for org.omg.CORBA.portable.OutputStream  output)
Marshals the value in this BooleanHolder object's value field to the output stream output.

Specified by:
_write sample code for org.omg.CORBA.portable.Streamable._write(org.omg.CORBA.portable.OutputStream) definition code for org.omg.CORBA.portable.Streamable._write(org.omg.CORBA.portable.OutputStream) in interface Streamable sample code for org.omg.CORBA.portable.Streamable definition code for org.omg.CORBA.portable.Streamable
Parameters:
output - the OutputStream which will contain the CDR formatted data

_type sample code for org.omg.CORBA.BooleanHolder._type() definition code for org.omg.CORBA.BooleanHolder._type()

public TypeCode sample code for org.omg.CORBA.TypeCode definition code for org.omg.CORBA.TypeCode  _type()
Retrieves the TypeCode object that corresponds to the value held in this BooleanHolder object.

Specified by:
_type sample code for org.omg.CORBA.portable.Streamable._type() definition code for org.omg.CORBA.portable.Streamable._type() in interface Streamable sample code for org.omg.CORBA.portable.Streamable definition code for org.omg.CORBA.portable.Streamable
Returns:
the TypeCode for the value held in this BooleanHolder object