Package org.omg.CORBA
Class StringHolder
java.lang.Object
org.omg.CORBA.StringHolder
- All Implemented Interfaces:
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
.
- Since:
- JDK1.2
- Version:
- 1.14, 09/09/97
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newStringHolder
object with itsvalue
field initialized tonull
.StringHolder
(String initial) Constructs a newStringHolder
object with itsvalue
field initialized to the givenString
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
_read
(InputStream input) Reads the unmarshalled data frominput
and assigns it to thevalue
field of thisStringHolder
object._type()
Retrieves theTypeCode
object that corresponds to the value held in thisStringHolder
object.void
_write
(OutputStream output) Marshals the value held by thisStringHolder
object to the output streamoutput
.
-
Field Details
-
value
TheString
value held by thisStringHolder
object.
-
-
Constructor Details
-
StringHolder
public StringHolder()Constructs a newStringHolder
object with itsvalue
field initialized tonull
. -
StringHolder
Constructs a newStringHolder
object with itsvalue
field initialized to the givenString
.- Parameters:
initial
- theString
with which to initialize thevalue
field of the newly-createdStringHolder
object
-
-
Method Details
-
_read
Reads the unmarshalled data frominput
and assigns it to thevalue
field of thisStringHolder
object.- Specified by:
_read
in interfaceStreamable
- Parameters:
input
- the InputStream containing CDR formatted data from the wire.
-
_write
Marshals the value held by thisStringHolder
object to the output streamoutput
.- Specified by:
_write
in interfaceStreamable
- Parameters:
output
- the OutputStream which will contain the CDR formatted data.
-
_type
Retrieves theTypeCode
object that corresponds to the value held in thisStringHolder
object.- Specified by:
_type
in interfaceStreamable
- Returns:
- the type code of the value held in this
StringHolder
object
-