org.omg.CORBA
Class PrincipalHolder

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

Deprecated. Deprecated by CORBA 2.2.

@Deprecated
public final class PrincipalHolder
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 Principal. For more information on Holder files, see "Generated Files: Holder Files".

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

Since:
JDK1.2

Field Summary
 Principal sample code for org.omg.CORBA.Principal definition code for org.omg.CORBA.Principal value sample code for org.omg.CORBA.PrincipalHolder.value definition code for org.omg.CORBA.PrincipalHolder.value
          Deprecated. The Principal value held by this PrincipalHolder object.
 
Constructor Summary
PrincipalHolder sample code for org.omg.CORBA.PrincipalHolder.PrincipalHolder() definition code for org.omg.CORBA.PrincipalHolder.PrincipalHolder() ()
          Deprecated. Constructs a new PrincipalHolder object with its value field initialized to null.
PrincipalHolder sample code for org.omg.CORBA.PrincipalHolder.PrincipalHolder(org.omg.CORBA.Principal) definition code for org.omg.CORBA.PrincipalHolder.PrincipalHolder(org.omg.CORBA.Principal) (Principal sample code for org.omg.CORBA.Principal definition code for org.omg.CORBA.Principal  initial)
          Deprecated. Constructs a new PrincipalHolder object with its value field initialized to the given Principal object.
 
Method Summary
 void _read sample code for org.omg.CORBA.PrincipalHolder._read(org.omg.CORBA.portable.InputStream) definition code for org.omg.CORBA.PrincipalHolder._read(org.omg.CORBA.portable.InputStream) (InputStream sample code for org.omg.CORBA.portable.InputStream definition code for org.omg.CORBA.portable.InputStream  input)
          Deprecated. Reads data from istream and initalizes the value field of the Holder 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.PrincipalHolder._type() definition code for org.omg.CORBA.PrincipalHolder._type() ()
          Deprecated. Retrieves the TypeCode object corresponding to the value in the value field of the Holder.
 void _write sample code for org.omg.CORBA.PrincipalHolder._write(org.omg.CORBA.portable.OutputStream) definition code for org.omg.CORBA.PrincipalHolder._write(org.omg.CORBA.portable.OutputStream) (OutputStream sample code for org.omg.CORBA.portable.OutputStream definition code for org.omg.CORBA.portable.OutputStream  output)
          Deprecated. Marshals to ostream the value in the value field of the Holder.
 
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.PrincipalHolder.value

public Principal sample code for org.omg.CORBA.Principal definition code for org.omg.CORBA.Principal  value
Deprecated. 
The Principal value held by this PrincipalHolder object.

Constructor Detail

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

public PrincipalHolder()
Deprecated. 
Constructs a new PrincipalHolder object with its value field initialized to null.


PrincipalHolder sample code for org.omg.CORBA.PrincipalHolder(org.omg.CORBA.Principal) definition code for org.omg.CORBA.PrincipalHolder(org.omg.CORBA.Principal)

public PrincipalHolder(Principal sample code for org.omg.CORBA.Principal definition code for org.omg.CORBA.Principal  initial)
Deprecated. 
Constructs a new PrincipalHolder object with its value field initialized to the given Principal object.

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

_read sample code for org.omg.CORBA.PrincipalHolder._read(org.omg.CORBA.portable.InputStream) definition code for org.omg.CORBA.PrincipalHolder._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)
Deprecated. 
Description copied from interface: Streamable 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)
Reads data from istream and initalizes the value field of the Holder 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 that represents the CDR data from the wire.

_write sample code for org.omg.CORBA.PrincipalHolder._write(org.omg.CORBA.portable.OutputStream) definition code for org.omg.CORBA.PrincipalHolder._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)
Deprecated. 
Description copied from interface: Streamable 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)
Marshals to ostream the value in the value field of the Holder.

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 CDR OutputStream

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

public TypeCode sample code for org.omg.CORBA.TypeCode definition code for org.omg.CORBA.TypeCode  _type()
Deprecated. 
Description copied from interface: Streamable sample code for org.omg.CORBA.portable.Streamable._type() definition code for org.omg.CORBA.portable.Streamable._type()
Retrieves the TypeCode object corresponding to the value in the value field of the Holder.

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 object for the value held in the holder