This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


org.omg.CORBA
class StringHolder

java.lang.Object extended by org.omg.CORBA.StringHolder
All Implemented Interfaces:
Streamable

Most common way to construct:

StringHolder instructions = new StringHolder();

Based on 18 examples


public final class StringHolder
extends Object
implements 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.


Field Summary
 String value
          The String value held by this StringHolder object.
 
Constructor Summary

          Constructs a new StringHolder object with its value field initialized to null.

          Constructs a new StringHolder object with its value field initialized to the given String.
 
Method Summary
 void

          Reads the unmarshalled data from input and assigns it to the value field of this StringHolder object.
 TypeCode

          Retrieves the TypeCode object that corresponds to the value held in this StringHolder object.
 void

          Marshals the value held by this StringHolder object to the output stream output.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

value

public String value
The String value held by this StringHolder object.
Constructor Detail

StringHolder

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


StringHolder

public StringHolder(String initial)
Constructs a new StringHolder object with its value field initialized to the given String.

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

_read

public void _read(InputStream input)
Reads the unmarshalled data from input and assigns it to the value field of this StringHolder object.

Parameters:
input - the InputStream containing CDR formatted data from the wire.

_type

public TypeCode _type()
Retrieves the TypeCode object that corresponds to the value held in this StringHolder object.

Returns:
the type code of the value held in this StringHolder object

_write

public void _write(OutputStream output)
Marshals the value held by this StringHolder object to the output stream output.

Parameters:
output - the OutputStream which will contain the CDR formatted data.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.