org.omg.CORBA

Interface DynAny

public interface DynAny extends Object

Deprecated: by {@link org.omg.DynamicAny.DynAny}

The DynAny interface provides possibility to access the components of the CORBA object, stored inside the {@link Any}. The {@link Any} itself allows to read, write and pass as parameter the stored value without knowning its exact data type. The DynAny and derived classes additionally allows to access the members of the sequence, structure, union and get the data about enumeration, value type and CORBA fixed without knowing the exact type at the run time. The returned members are also wrapped into DynAny objects, allowing them to be the nested structures.
Method Summary
voidassign(DynAny from)
Copy one DynAny into another.
DynAnycopy()
Clones this DynAny.
DynAnycurrent_component()
Returns the focused component of this DynAny.
voiddestroy()
Destroys this DynAny, freeing the used resources.
voidfrom_any(Any an_any)
Makes a DynAny from the {@link Any}.
Anyget_any()
Retrieves the {@link Any}, stored inside this DynAny.
booleanget_boolean()
Extract the boolean value that is expected to be stored in this DynAny.
charget_char()
Extract the char value that is expected to be stored in this DynAny.
doubleget_double()
Extract the double value that is expected to be stored in this DynAny.
floatget_float()
Extract the float value that is expected to be stored in this DynAny.
intget_long()
Extract the int (CORBA long) value that is expected to be stored in this DynAny.
longget_longlong()
Extract the long (CORBA long long) value that is expected to be stored in this DynAny.
byteget_octet()
Extract the byte (CORBA octet) value that is expected to be stored in this DynAny.
Objectget_reference()
Extract the CORBA object reference that is expected to be stored in this DynAny.
shortget_short()
Extract the short value that is expected to be stored in this DynAny.
Stringget_string()
Extract the string value that is expected to be stored in this DynAny.
TypeCodeget_typecode()
Extract the {@link TypeCode} value that is expected to be stored in this DynAny.
intget_ulong()
Extract the unsigned int (CORBA ulong) value that is expected to be stored in this DynAny.
longget_ulonglong()
Extract the unsingel long (CORBA unsigned long long )value that is expected to be stored in this DynAny.
shortget_ushort()
Extract the unsigned short value that is expected to be stored in this DynAny.
Serializableget_val()
Extract the value that is expected to be stored in this DynAny.
charget_wchar()
Extract the wide (usually UTF-16) character value that is expected to be stored in this DynAny.
Stringget_wstring()
Extract the wide (usually UFT-16) string that is expected to be stored in this DynAny.
voidinsert_any(Any an_any)
Insert the {@link Any} value into the enclosed {@link Any} inside this DynAny.
voidinsert_boolean(boolean a_x)
Insert the boolean value into the enclosed {@link Any} inside this DynAny
voidinsert_char(char a_x)
Insert the char value into the enclosed {@link Any} inside this DynAny
voidinsert_double(double a_x)
Insert the double value into the enclosed {@link Any} inside this DynAny
voidinsert_float(float a_x)
Insert the float value into the enclosed {@link Any} inside this DynAny
voidinsert_long(int a_x)
Insert the int (CORBA long) value into the enclosed {@link Any} inside this DynAny
voidinsert_longlong(long a_x)
Insert the long (CORBA long long) value into the enclosed {@link Any} inside this DynAny
voidinsert_octet(byte a_x)
Insert the byte (CORBA octet) value into the enclosed {@link Any} inside this DynAny
voidinsert_reference(Object a_x)
Insert the object reference into the enclosed {@link Any} inside this DynAny
voidinsert_short(short a_x)
Insert the short value into the enclosed {@link Any} inside this DynAny
voidinsert_string(String a_x)
Insert the string value into the enclosed {@link Any} inside this DynAny
voidinsert_typecode(TypeCode a_x)
Insert the {@link TypeCode} value into the enclosed {@link Any} inside this DynAny
voidinsert_ulong(int a_x)
Insert the int (CORBA unsinged long) value into the enclosed {@link Any} inside this DynAny
voidinsert_ulonglong(long a_x)
Insert the long (CORBA unsigned long long) value into the enclosed {@link Any} inside this DynAny
voidinsert_ushort(short a_x)
Insert the short (CORBA unsigned short) value into the enclosed {@link Any} inside this DynAny
voidinsert_val(Serializable a_x)
Insert the value into the enclosed {@link Any} inside this DynAny
voidinsert_wchar(char a_x)
Insert the wide char (usually UTF-16) value into the enclosed {@link Any} inside this DynAny
voidinsert_wstring(String a_x)
Insert the wide string (usually UTF-16) into the enclosed {@link Any} inside this DynAny
booleannext()
Advances the internal pointer, described in the {@link #current_component}, one position forward.
voidrewind()
Moves the internal pointer, described in the {@link #current_component}, to the first component.
booleanseek(int p)
Moves the internal pointer, described in the {@link #current_component}, to the given position.
Anyto_any()
Returns the enclosed {@link Any}.
TypeCodetype()
Returns the typecode of the object, inserted into this DynAny.

Method Detail

assign

public void assign(DynAny from)
Copy one DynAny into another.

Parameters: from the DynAny to copy from.

Throws: Invalid if the source DynAny is invalid.

copy

public DynAny copy()
Clones this DynAny.

current_component

public DynAny current_component()
Returns the focused component of this DynAny. The DynAny has the internal pointer (reference) that can point to one of its components. The returned DynAny can be used to get or set the value of the focused component. If the DynAny holds a primitive type with no components, this implementation returns this.

destroy

public void destroy()
Destroys this DynAny, freeing the used resources. In java, resources are freed by the garbage collectors, so this method typically returns without action.

from_any

public void from_any(Any an_any)
Makes a DynAny from the {@link Any}. The passed {@link Any} becomes the enclosed instance of this DynAny, allowing to change/traverse the {@link Any} fields by the {@link DynAny} methods.

get_any

public Any get_any()
Retrieves the {@link Any}, stored inside this DynAny.

Throws: TypeMismatch if the typecode of the accessed Any is not the same as the typecode of this DynAny.

get_boolean

public boolean get_boolean()
Extract the boolean value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_char

public char get_char()
Extract the char value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_double

public double get_double()
Extract the double value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_float

public float get_float()
Extract the float value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_long

public int get_long()
Extract the int (CORBA long) value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_longlong

public long get_longlong()
Extract the long (CORBA long long) value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_octet

public byte get_octet()
Extract the byte (CORBA octet) value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_reference

public Object get_reference()
Extract the CORBA object reference that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_short

public short get_short()
Extract the short value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_string

public String get_string()
Extract the string value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_typecode

public TypeCode get_typecode()
Extract the {@link TypeCode} value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_ulong

public int get_ulong()
Extract the unsigned int (CORBA ulong) value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_ulonglong

public long get_ulonglong()
Extract the unsingel long (CORBA unsigned long long )value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_ushort

public short get_ushort()
Extract the unsigned short value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_val

public Serializable get_val()
Extract the value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_wchar

public char get_wchar()
Extract the wide (usually UTF-16) character value that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

get_wstring

public String get_wstring()
Extract the wide (usually UFT-16) string that is expected to be stored in this DynAny.

Throws: TypeMismatch if this DynAny holds the value of the different type.

insert_any

public void insert_any(Any an_any)
Insert the {@link Any} value into the enclosed {@link Any} inside this DynAny.

Parameters: an_any the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_boolean

public void insert_boolean(boolean a_x)
Insert the boolean value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_char

public void insert_char(char a_x)
Insert the char value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_double

public void insert_double(double a_x)
Insert the double value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_float

public void insert_float(float a_x)
Insert the float value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_long

public void insert_long(int a_x)
Insert the int (CORBA long) value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_longlong

public void insert_longlong(long a_x)
Insert the long (CORBA long long) value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_octet

public void insert_octet(byte a_x)
Insert the byte (CORBA octet) value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_reference

public void insert_reference(Object a_x)
Insert the object reference into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_short

public void insert_short(short a_x)
Insert the short value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_string

public void insert_string(String a_x)
Insert the string value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_typecode

public void insert_typecode(TypeCode a_x)
Insert the {@link TypeCode} value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_ulong

public void insert_ulong(int a_x)
Insert the int (CORBA unsinged long) value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_ulonglong

public void insert_ulonglong(long a_x)
Insert the long (CORBA unsigned long long) value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_ushort

public void insert_ushort(short a_x)
Insert the short (CORBA unsigned short) value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_val

public void insert_val(Serializable a_x)
Insert the value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_wchar

public void insert_wchar(char a_x)
Insert the wide char (usually UTF-16) value into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

insert_wstring

public void insert_wstring(String a_x)
Insert the wide string (usually UTF-16) into the enclosed {@link Any} inside this DynAny

Parameters: a_x the value being inserted.

Throws: InvalidValue if the value type does not match the typecode of the enclosed {@link Any}.

next

public boolean next()
Advances the internal pointer, described in the {@link #current_component}, one position forward.

Returns: true if the pointer now points to the new component, false if there are no more components of this DynAny holds a basic type that is not divided into components.

rewind

public void rewind()
Moves the internal pointer, described in the {@link #current_component}, to the first component.

seek

public boolean seek(int p)
Moves the internal pointer, described in the {@link #current_component}, to the given position.

Parameters: p the number of the internal component on that the internal pointer must be focused.

Returns: true on success or false if there is no component with the given number. If the DynAny holds the basic type, this method returs false p values other than 0.

to_any

public Any to_any()
Returns the enclosed {@link Any}.

Returns: the enclosed {@link Any}.

type

public TypeCode type()
Returns the typecode of the object, inserted into this DynAny.

Returns: the typecode of the inserted {@link Any} or null typecode if no {@link Any has been yet inserted}.