org.omg.CORBA

Class StringHolder

java.lang.Object

org.omg.CORBA.StringHolder

All Implemented Interfaces:

Streamable

public final class StringHolder
extends Object
implements Streamable

A holder for CORBA string that is mapped into java String. The holders have several application areas. The end user usually sees them implementing CORBA methods where the primitive type is passed by reference. While CORBA (or, for example, C) supports this, the java does not and a wrapper class is required.

Field Summary

Fields

Modifier and Type	Field and Description
String	value The String (CORBA string) value, held by this StringHolder.

Constructor Summary

Constructors

Constructor and Description
StringHolder() Constructs an instance of StringHolder, initializing value to null.
StringHolder(String initial_value) Constructs an instance of StringHolder, initializing value to the given String.

Method Summary

Methods

Modifier and Type	Method and Description
void	_read(InputStream input) Fill in the value field by reading the required data from the given stream.
TypeCode	_type() Returns the TypeCode, corresponding the CORBA type that is stored using this holder.
void	_write(OutputStream output) Write the value field to the given stream.

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 (CORBA string) value, held by this StringHolder.

Constructor Detail

StringHolder

public StringHolder()

Constructs an instance of StringHolder, initializing value to null.

StringHolder

public StringHolder(String initial_value)

Constructs an instance of StringHolder, initializing value to the given String.

Parameters:

initial_value - a value that will be assigned to the value field.

Method Detail

_read

public void _read(InputStream input)

Fill in the value field by reading the required data from the given stream. For string, the functionality is delegated to InputStream.read_string().

Specified by:

_read in interface Streamable

Parameters:

input - the input stream to read from.

_type

public TypeCode _type()

Returns the TypeCode, corresponding the CORBA type that is stored using this holder. The TypeCode.length() method of the returned typecode always returns 0.

Specified by:

_type in interface Streamable

_write

public void _write(OutputStream output)

Write the value field to the given stream. For string, the functionality is delegated to OutputStream.write_string(String).

Specified by:

_write in interface Streamable

Parameters:

output - the output stream to write into.