org.omg.CORBA
Class ByteHolder

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

public final class ByteHolder
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 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.

Since:
JDK1.2

Field Summary
 byte value sample code for org.omg.CORBA.ByteHolder.value definition code for org.omg.CORBA.ByteHolder.value
          The byte value held by this ByteHolder object.
 
Constructor Summary
ByteHolder sample code for org.omg.CORBA.ByteHolder.ByteHolder() definition code for org.omg.CORBA.ByteHolder.ByteHolder() ()
          Constructs a new ByteHolder object with its value field initialized to 0.
ByteHolder sample code for org.omg.CORBA.ByteHolder.ByteHolder(byte) definition code for org.omg.CORBA.ByteHolder.ByteHolder(byte) (byte initial)
          Constructs a new ByteHolder object for the given byte.
 
Method Summary
 void _read sample code for org.omg.CORBA.ByteHolder._read(org.omg.CORBA.portable.InputStream) definition code for org.omg.CORBA.ByteHolder._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 from input and initalizes the value in this ByteHolder object with the unmarshalled data.
 TypeCode sample code for org.omg.CORBA.TypeCode definition code for org.omg.CORBA.TypeCode _type sample code for org.omg.CORBA.ByteHolder._type() definition code for org.omg.CORBA.ByteHolder._type() ()
          Returns the TypeCode corresponding to the value held in this ByteHolder object.
 void _write sample code for org.omg.CORBA.ByteHolder._write(org.omg.CORBA.portable.OutputStream) definition code for org.omg.CORBA.ByteHolder._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 to output the value in this ByteHolder object.
 
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.ByteHolder.value

public byte value
The byte value held by this ByteHolder object.

Constructor Detail

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

public ByteHolder()
Constructs a new ByteHolder object with its value field initialized to 0.


ByteHolder sample code for org.omg.CORBA.ByteHolder(byte) definition code for org.omg.CORBA.ByteHolder(byte)

public ByteHolder(byte initial)
Constructs a new ByteHolder object for the given byte.

Parameters:
initial - the byte with which to initialize the value field of the new ByteHolder object
Method Detail

_read sample code for org.omg.CORBA.ByteHolder._read(org.omg.CORBA.portable.InputStream) definition code for org.omg.CORBA.ByteHolder._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 from input and initalizes the value in this ByteHolder object with the unmarshalled data.

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 containing CDR formatted data from the wire.

_write sample code for org.omg.CORBA.ByteHolder._write(org.omg.CORBA.portable.OutputStream) definition code for org.omg.CORBA.ByteHolder._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 to output the value in this ByteHolder object.

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.ByteHolder._type() definition code for org.omg.CORBA.ByteHolder._type()

public TypeCode sample code for org.omg.CORBA.TypeCode definition code for org.omg.CORBA.TypeCode  _type()
Returns the TypeCode corresponding to the value held in this ByteHolder 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 of the value held in this ByteHolder object