Package org.omg.CORBA

Class ByteHolder

java.lang.Object
org.omg.CORBA.ByteHolder
All Implemented Interfaces:
Streamable
public final class ByteHolder extends Object implements 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

    Fields
    Modifier and Type
    Field
    Description
    byte
    value
    The byte value held by this ByteHolder object.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ByteHolder()
    Constructs a new ByteHolder object with its value field initialized to 0.
    ByteHolder(byte initial)
    Constructs a new ByteHolder object for the given byte.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    _read(InputStream input)
    Reads from input and initalizes the value in this ByteHolder object with the unmarshalled data.
    TypeCode
    _type()
    Returns the TypeCode corresponding to the value held in this ByteHolder object.
    void
    _write(OutputStream output)
    Marshals to output the value in this ByteHolder object.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • value

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

  • Constructor Details

    • ByteHolder

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

    • ByteHolder

      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 Details

    • _read

      public void _read(InputStream input)
      Reads from input and initalizes the value in this ByteHolder object with the unmarshalled data.
      Specified by:
      _read in interface Streamable
      Parameters:
      input - the InputStream containing CDR formatted data from the wire.

    • _write

      public void _write(OutputStream output)
      Marshals to output the value in this ByteHolder object.
      Specified by:
      _write in interface Streamable
      Parameters:
      output - the OutputStream which will contain the CDR formatted data.

    • _type

      public TypeCode _type()
      Returns the TypeCode corresponding to the value held in this ByteHolder object.
      Specified by:
      _type in interface Streamable
      Returns:
      the TypeCode of the value held in this ByteHolder object