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

ByteHolder

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

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

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

Fields Summary
public byte
value
The byte value held by this ByteHolder object.
Constructors Summary
public ByteHolder()
Constructs a new ByteHolder object with its value field initialized to 0.
public ByteHolder(byte initial)
Constructs a new ByteHolder object for the given byte.

param
initial the byte with which to initialize the value field of the new ByteHolder object

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

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

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

return
the TypeCode of the value held in this ByteHolder object

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

param
output the OutputStream which will contain the CDR formatted data.

	output.write_octet(value);