|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--org.omg.CORBA.Any
Serves as a container for any data that can be
described in IDL or for any IDL primitive type.
An Any object is used as a component of a
NamedValue object, which provides information about
arguments or return values in requests, and which is used to define
name/value pairs in Context objects.
An Any object consists of two parts:
TypeCode object describing the type of the data
value contained in the Any object. For example,
a TypeCode object for an array contains
a field for the length of the array and a field for
the type of elements in the array. (Note that in this case, the
second field of the TypeCode object is itself a
TypeCode object.)
A large part of the
For a given primitive type X, these methods are:
This method throws the exception
There are distinct method pairs for each
primitive IDL data type (
The class
Any class consists of pairs of methods
for inserting values into and extracting values from an
Any object.
x of primitive type X
into the value field of the Any object.
Note that the method
insert_X also resets the Any object's
type field if necessary.
X from the Any object.
BAD_OPERATION under two conditions:
Any object is not
X
extract_X is called before
the value field of the Any object
has been set
insert_long and extract_long,
insert_string and extract_string, and so on).
Any also has methods for
getting and setting the type code,
for testing two Any objects for equality,
and for reading an Any object from a stream or
writing it to a stream.
| Constructor Summary | |
Any()
|
|
| Method Summary | |
abstract InputStream |
create_input_stream()
Creates an input stream from which this Any object's value
can be unmarshalled. |
abstract OutputStream |
create_output_stream()
Creates an output stream into which this Any object's
value can be marshalled. |
abstract boolean |
equal(Any a)
Checks for equality between this Any object and the
given Any object. |
abstract Any |
extract_any()
Extracts the Any object in this
Any object's value field. |
abstract boolean |
extract_boolean()
Extracts the boolean in this
Any object's value field. |
abstract char |
extract_char()
Extracts the char in this
Any object's value field. |
abstract double |
extract_double()
Extracts the double in this
Any object's value field. |
BigDecimal |
extract_fixed()
Extracts the java.math.BigDecimal object in this
Any object's value field. |
abstract float |
extract_float()
Extracts the float in this
Any object's value field. |
abstract int |
extract_long()
Extracts the int in this
Any object's value field. |
abstract long |
extract_longlong()
Extracts the long in this
Any object's value field. |
abstract Object |
extract_Object()
Extracts the org.omg.CORBA.Object in this
Any object's value field. |
abstract byte |
extract_octet()
Extracts the byte in this
Any object's value field. |
abstract Principal |
extract_Principal()
Deprecated. Deprecated by CORBA 2.2. |
abstract short |
extract_short()
Extracts the short in this
Any object's value field. |
abstract String |
extract_string()
Extracts the String object in this
Any object's value field. |
abstract TypeCode |
extract_TypeCode()
Extracts the TypeCode object in this
Any object's value field. |
abstract int |
extract_ulong()
Extracts the int in this
Any object's value field. |
abstract long |
extract_ulonglong()
Extracts the long in this
Any object's value field. |
abstract short |
extract_ushort()
Extracts the short in this
Any object's value field. |
Serializable |
extract_Value()
Extracts the java.io.Serializable object in this
Any object's value field. |
abstract char |
extract_wchar()
Extracts the char in this
Any object's value field. |
abstract String |
extract_wstring()
Extracts the String object in this
Any object's value field. |
abstract void |
insert_any(Any a)
Inserts the given Any object
into this Any object's value field. |
abstract void |
insert_boolean(boolean b)
Inserts the given boolean
into this Any object's value field. |
abstract void |
insert_char(char c)
Inserts the given char
into this Any object's value field. |
abstract void |
insert_double(double d)
Inserts the given double
into this Any object's value field. |
void |
insert_fixed(BigDecimal value)
Inserts the given java.math.BigDecimal object
into this Any object's value field. |
void |
insert_fixed(BigDecimal value,
TypeCode type)
Inserts the given java.math.BigDecimal object
into this Any object's value field. |
abstract void |
insert_float(float f)
Inserts the given float
into this Any object's value field. |
abstract void |
insert_long(int l)
Inserts the given int
into this Any object's value field. |
abstract void |
insert_longlong(long l)
Inserts the given long
into this Any object's value field. |
abstract void |
insert_Object(Object o)
Inserts the given org.omg.CORBA.Object object
into this Any object's value field. |
abstract void |
insert_Object(Object o,
TypeCode t)
Inserts the given org.omg.CORBA.Object object
into this Any object's value field. |
abstract void |
insert_octet(byte b)
Inserts the given byte
into this Any object's value field. |
abstract void |
insert_Principal(Principal p)
Deprecated. Deprecated by CORBA 2.2. |
abstract void |
insert_short(short s)
Inserts the given short
into this Any object's value field. |
abstract void |
insert_Streamable(Streamable s)
Inserts the given Streamable object
into this Any object's value field. |
abstract void |
insert_string(String s)
Inserts the given String object
into this Any object's value field. |
abstract void |
insert_TypeCode(TypeCode t)
Inserts the given TypeCode object
into this Any object's value field. |
abstract void |
insert_ulong(int l)
Inserts the given int
into this Any object's value field. |
abstract void |
insert_ulonglong(long l)
Inserts the given long
into this Any object's value field. |
abstract void |
insert_ushort(short s)
Inserts the given short
into this Any object's value field. |
void |
insert_Value(Serializable v)
Inserts the given java.io.Serializable object
into this Any object's value field. |
void |
insert_Value(Serializable v,
TypeCode t)
Inserts the given java.io.Serializable object
into this Any object's value field. |
abstract void |
insert_wchar(char c)
Inserts the given char
into this Any object's value field. |
abstract void |
insert_wstring(String s)
Inserts the given String object
into this Any object's value field. |
abstract void |
read_value(InputStream is,
TypeCode t)
Reads off (unmarshals) the value of an Any object from
the given input stream using the given typecode. |
abstract TypeCode |
type()
Returns type information for the element contained in this Any object. |
abstract void |
type(TypeCode t)
Sets this Any object's type field
to the given TypeCode object and clears its value. |
abstract void |
write_value(OutputStream os)
Writes out to the given output stream the typecode and value of this Any object. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public Any()
| Method Detail |
public abstract TypeCode type()
Any object.TypeCode object containing type information
about the value contained in this Any objectpublic abstract void type(TypeCode t)
Any object's type field
to the given TypeCode object and clears its value.
Note that using this method to set the type code wipes out the
value if there is one. The method
is provided primarily so that the type may be set properly for
IDL out parameters. Generally, setting the type
is done by the insert_X methods, which will set the type
to X if it is not already set to X.
t - the TypeCode object giving
information for the value in
this Any objectpublic abstract boolean equal(Any a)
Any object and the
given Any object. Two Any objects are
equal if both their values and type codes are equal.a - the Any object to test for equalitytrue if the Any objects are equal;
false otherwiseCORBA package
comments for unimplemented features
public abstract void read_value(InputStream is,
TypeCode t)
throws MARSHAL
Any object from
the given input stream using the given typecode.is - the org.omg.CORBA.portable.InputStream
object from which to read
the value contained in this Any objectt - a TypeCode object containing type information
about the value to be readMARSHAL - when the given TypeCode object is
not consistent with the value that was contained
in the input streampublic abstract void write_value(OutputStream os)
Any object.
If this method is called on an Any object that has not
had a value inserted into its value field, it will throw
the exception java.lang.NullPointerException.
os - the org.omg.CORBA.portable.OutputStream
object into which to marshal the value and typecode
of this Any objectpublic abstract OutputStream create_output_stream()
Any object's
value can be marshalled.OutputStreampublic abstract InputStream create_input_stream()
Any object's value
can be unmarshalled.InputStreampublic abstract void insert_Streamable(Streamable s)
Streamable object
into this Any object's value field.
This method allows the insertion of non-primitive IDL types.s - the Streamable object to insert into this
Any object; may be a non-primitive
IDL type
public abstract short extract_short()
throws BAD_OPERATION
short in this
Any object's value field.short stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a short or the
value field has not yet been setpublic abstract void insert_short(short s)
short
into this Any object's value field.s - the short to insert into this
Any object
public abstract int extract_long()
throws BAD_OPERATION
int in this
Any object's value field.int stored in this Any objectBAD_OPERATION - if this Any object
contains something other than an int or the
value field has not yet been setpublic abstract void insert_long(int l)
int
into this Any object's value field.l - the int to insert into this
Any object
public abstract long extract_longlong()
throws BAD_OPERATION
long in this
Any object's value field.long stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a long or the
value field has not yet been setpublic abstract void insert_longlong(long l)
long
into this Any object's value field.l - the long to insert into this
Any object
public abstract short extract_ushort()
throws BAD_OPERATION
short in this
Any object's value field.short stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a short or the
value field has not yet been setpublic abstract void insert_ushort(short s)
short
into this Any object's value field.s - the short to insert into this
Any object
public abstract int extract_ulong()
throws BAD_OPERATION
int in this
Any object's value field.int stored in this Any objectBAD_OPERATION - if this Any object
contains something other than an int or the
value field has not yet been setpublic abstract void insert_ulong(int l)
int
into this Any object's value field.l - the int to insert into this
Any object
public abstract long extract_ulonglong()
throws BAD_OPERATION
long in this
Any object's value field.long stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a long or the
value field has not yet been setpublic abstract void insert_ulonglong(long l)
long
into this Any object's value field.l - the long to insert into this
Any object
public abstract float extract_float()
throws BAD_OPERATION
float in this
Any object's value field.float stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a float or the
value field has not yet been setpublic abstract void insert_float(float f)
float
into this Any object's value field.f - the float to insert into this
Any object
public abstract double extract_double()
throws BAD_OPERATION
double in this
Any object's value field.double stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a double or the
value field has not yet been setpublic abstract void insert_double(double d)
double
into this Any object's value field.d - the double to insert into this
Any object
public abstract boolean extract_boolean()
throws BAD_OPERATION
boolean in this
Any object's value field.boolean stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a boolean or the
value field has not yet been setpublic abstract void insert_boolean(boolean b)
boolean
into this Any object's value field.b - the boolean to insert into this
Any object
public abstract char extract_char()
throws BAD_OPERATION
char in this
Any object's value field.char stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a char or the
value field has not yet been set
public abstract void insert_char(char c)
throws DATA_CONVERSION
char
into this Any object's value field.c - the char to insert into this
Any objectDATA_CONVERSION - if there is a data conversion
error
public abstract byte extract_octet()
throws BAD_OPERATION
byte in this
Any object's value field.byte stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a byte or the
value field has not yet been setpublic abstract void insert_octet(byte b)
byte
into this Any object's value field.b - the byte to insert into this
Any object
public abstract char extract_wchar()
throws BAD_OPERATION
char in this
Any object's value field.char stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a char or the
value field has not yet been setpublic abstract void insert_wchar(char c)
char
into this Any object's value field.c - the char to insert into this
Any object
public abstract Any extract_any()
throws BAD_OPERATION
Any object in this
Any object's value field.Any object stored in this Any objectBAD_OPERATION - if this Any object
contains something other than an Any object or the
value field has not yet been setpublic abstract void insert_any(Any a)
Any object
into this Any object's value field.a - the Any object to insert into this
Any object
public abstract String extract_string()
throws BAD_OPERATION
String object in this
Any object's value field.String object stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a String object or the
value field has not yet been set
public abstract void insert_string(String s)
throws DATA_CONVERSION,
MARSHAL
String object
into this Any object's value field.s - the String object to insert into this
Any objectDATA_CONVERSION - if there is a data conversion errorMARSHAL - if the ORB has a problem marshalling or
unmarshalling parameters
public abstract String extract_wstring()
throws BAD_OPERATION
String object in this
Any object's value field.String object stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a String object or the
value field has not yet been set
public abstract void insert_wstring(String s)
throws MARSHAL
String object
into this Any object's value field.s - the String object to insert into this
Any objectMARSHAL - if the ORB has a problem marshalling or
unmarshalling parameters
public abstract Object extract_Object()
throws BAD_OPERATION
org.omg.CORBA.Object in this
Any object's value field.org.omg.CORBA.Object stored in
this Any objectBAD_OPERATION - if this Any object
contains something other than an
org.omg.CORBA.Object or the
value field has not yet been setpublic abstract void insert_Object(Object o)
org.omg.CORBA.Object object
into this Any object's value field.o - the org.omg.CORBA.Object object to insert into this
Any object
public abstract void insert_Object(Object o,
TypeCode t)
throws BAD_OPERATION
org.omg.CORBA.Object object
into this Any object's value field.o - the org.omg.CORBA.Object instance to insert into this
Any objectt - the TypeCode object that is to be inserted into
this Any object and that describes
the Object being insertedBAD_OPERATION - if this method is invalid for this
Any object
public abstract TypeCode extract_TypeCode()
throws BAD_OPERATION
TypeCode object in this
Any object's value field.TypeCode object stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a TypeCode object or the
value field has not yet been setpublic abstract void insert_TypeCode(TypeCode t)
TypeCode object
into this Any object's value field.t - the TypeCode object to insert into this
Any object
public abstract Principal extract_Principal()
throws BAD_OPERATION
Principal object in this
Any object's value field.
Note that the class Principal has been deprecated.Principal object stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a
Principal object or the
value field has not yet been setpublic abstract void insert_Principal(Principal p)
Principal object
into this Any object's value field.
Note that the class Principal has been deprecated.p - the Principal object to insert into this
Any objectpublic BigDecimal extract_fixed()
java.math.BigDecimal object in this
Any object's value field.java.math.BigDecimal object
stored in this Any objectBAD_OPERATION - if this Any object
contains something other than a
java.math.BigDecimal object or the
value field has not yet been setpublic void insert_fixed(BigDecimal value)
java.math.BigDecimal object
into this Any object's value field.value - the java.math.BigDecimal object
to insert into this Any object
public void insert_fixed(BigDecimal value,
TypeCode type)
java.math.BigDecimal object
into this Any object's value field.value - the java.math.BigDecimal object
to insert into this Any objecttype - the TypeCode object that is to be inserted into
this Any object's type field
and that describes the java.math.BigDecimal
object being inserted
public Serializable extract_Value()
throws BAD_OPERATION
java.io.Serializable object in this
Any object's value field.java.io.Serializable object stored in
this Any objectBAD_OPERATION - if this Any object
contains something other than a java.io.Serializable
object or the
value field has not yet been setpublic void insert_Value(Serializable v)
java.io.Serializable object
into this Any object's value field.v - the java.io.Serializable object to insert into this
Any object
public void insert_Value(Serializable v,
TypeCode t)
throws MARSHAL
java.io.Serializable object
into this Any object's value field.v - the java.io.Serializable object to insert into this
Any objectt - the TypeCode object that is to be inserted into
this Any object's type field
and that describes the java.io.Serializable
object being insertedMARSHAL - if the ORB has a problem marshalling or
unmarshalling parameters
|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.