FileDocCategorySizeDatePackage
TypeCodeHolder.javaAPI DocJava SE 5 API3183Fri Aug 26 14:58:32 BST 2005org.omg.CORBA

TypeCodeHolder

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

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

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

Fields Summary
public TypeCode
value
The TypeCode value held by this TypeCodeHolder object.
Constructors Summary
public TypeCodeHolder()
Constructs a new TypeCodeHolder object with its value field initialized to null.
public TypeCodeHolder(TypeCode initial)
Constructs a new TypeCodeHolder object with its value field initialized to the given TypeCode object.

param
initial the TypeCode object with which to initialize the value field of the newly-created TypeCodeHolder object

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

param
input the InputStream containing CDR formatted data from the wire

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

return
the TypeCode of the value held in this TypeCodeHolder object

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

param
output the OutputStream which will contain the CDR formatted data

	output.write_TypeCode(value);