File Doc Category Size Date Package
StringHolder.java API Doc Java SE 5 API 3167 Fri Aug 26 14:58:32 BST 2005 org.omg.CORBA

StringHolder

java.lang.Object

public final class StringHolder extends Object implements org.omg.CORBA.portable.Streamable

The Holder for String. For more information on Holder files, see "Generated Files: Holder Files".

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

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

Fields Summary
public String
value
The String value held by this StringHolder object.
Constructors Summary
public StringHolder()
Constructs a new StringHolder object with its value field initialized to null.

public StringHolder(String initial)
Constructs a new StringHolder object with its value field initialized to the given String.
param
initial the String with which to initialize the value field of the newly-created StringHolder object
value = initial;
Methods Summary
public void _read(org.omg.CORBA.portable.InputStream input)
Reads the unmarshalled data from input and assigns it to the value field of this StringHolder object.
param
input the InputStream containing CDR formatted data from the wire.
value = input.read_string();
public org.omg.CORBA.TypeCode _type()
Retrieves the TypeCode object that corresponds to the value held in this StringHolder object.
return
the type code of the value held in this StringHolder object
return ORB.init().get_primitive_tc(TCKind.tk_string);
public void _write(org.omg.CORBA.portable.OutputStream output)
Marshals the value held by this StringHolder object to the output stream output.
param
output the OutputStream which will contain the CDR formatted data.
output.write_string(value);