org.omg.DynamicAny

Interface DynAnyOperations

All Known Subinterfaces:

DynAny, DynArray, DynArrayOperations, DynEnum, DynEnumOperations, DynFixed, DynFixedOperations, DynSequence, DynSequenceOperations, DynStruct, DynStructOperations, DynUnion, DynUnionOperations, DynValue, DynValueBox, DynValueBoxOperations, DynValueCommon, DynValueCommonOperations, DynValueOperations

All Known Implementing Classes:

_DynAnyStub, _DynArrayStub, _DynEnumStub, _DynFixedStub, _DynSequenceStub, _DynStructStub, _DynUnionStub, _DynValueStub

public interface DynAnyOperations

Defines the operations, applicable to DynAny.

Method Summary

Methods

Modifier and Type	Method and Description
void	assign(DynAny from) Initialises the value of this DynAny with the value, stored inside the passed DynAny, making a shallow copy.
int	component_count() Get the number number of fields in the enclosed structure or number of memebers in the enclosed array, sequence, enumeration, etc.
DynAny	copy() Fully clones the content of this Any, returning a deep copy.
DynAny	current_component() Returns the focused component of this DynAny.
void	destroy() Destroys this DynAny, freeing the used resources.
boolean	equal(DynAny other) Checks for equality with another Dynamic Any.
void	from_any(Any an_any) Makes a DynAny from the Any.
Any	get_any() This method is used when the wrapped Any contains an instance of another Any itself.
boolean	get_boolean() Extract the boolean value that is expected to be stored in this DynAny.
char	get_char() Extract the char value that is expected to be stored in this DynAny.
double	get_double() Extract the double value that is expected to be stored in this DynAny.
DynAny	get_dyn_any() Return DynAny, wrapping the second (enclosed any) that is stored in the wrapped Any.
float	get_float() Extract the float value that is expected to be stored in this DynAny.
int	get_long() Extract the int (CORBA long) value that is expected to be stored in this DynAny.
long	get_longlong() Extract the long (CORBA long long) value that is expected to be stored in this DynAny.
byte	get_octet() Extract the byte (CORBA octet) value that is expected to be stored in this DynAny.
Object	get_reference() Extract the CORBA object reference that is expected to be stored in this DynAny.
short	get_short() Extract the short value that is expected to be stored in this DynAny.
String	get_string() Extract the string value that is expected to be stored in this DynAny.
TypeCode	get_typecode() Extract the TypeCode value that is expected to be stored in this DynAny.
int	get_ulong() Extract the unsigned int (CORBA ulong) value that is expected to be stored in this DynAny.
long	get_ulonglong() Extract the unsingel long (CORBA unsigned long long )value that is expected to be stored in this DynAny.
short	get_ushort() Extract the unsigned short value that is expected to be stored in this DynAny.
Serializable	get_val() Extract the value that is expected to be stored in this DynAny.
char	get_wchar() Extract the wide (usually UTF-16) character value that is expected to be stored in this DynAny.
String	get_wstring() Extract the wide (usually UFT-16) string that is expected to be stored in this DynAny.
void	insert_any(Any an_any) Insert the Any value into the enclosed Any inside this DynAny.
void	insert_boolean(boolean a_x) Insert the boolean value into the enclosed Any inside this DynAny
void	insert_char(char a_x) Insert the char value into the enclosed Any inside this DynAny
void	insert_double(double a_x) Insert the double value into the enclosed Any inside this DynAny
void	insert_dyn_any(DynAny insert_it) Insert a value at the current position.
void	insert_float(float a_x) Insert the float value into the enclosed Any inside this DynAny
void	insert_long(int a_x) Insert the int (CORBA long) value into the enclosed Any inside this DynAny
void	insert_longlong(long a_x) Insert the long (CORBA long long) value into the enclosed Any inside this DynAny
void	insert_octet(byte a_x) Insert the byte (CORBA octet) value into the enclosed Any inside this DynAny
void	insert_reference(Object a_x) Insert the object reference into the enclosed Any inside this DynAny
void	insert_short(short a_x) Insert the short value into the enclosed Any inside this DynAny
void	insert_string(String a_x) Insert the string value into the enclosed Any inside this DynAny
void	insert_typecode(TypeCode a_x) Insert the TypeCode value into the enclosed Any inside this DynAny
void	insert_ulong(int a_x) Insert the int (CORBA unsinged long) value into the enclosed Any inside this DynAny
void	insert_ulonglong(long a_x) Insert the long (CORBA unsigned long long) value into the enclosed Any inside this DynAny
void	insert_ushort(short a_x) Insert the short (CORBA unsigned short) value into the enclosed Any inside this DynAny
void	insert_val(Serializable a_x) Insert the value into the enclosed Any inside this DynAny
void	insert_wchar(char a_x) Insert the wide char (usually UTF-16) value into the enclosed Any inside this DynAny
void	insert_wstring(String a_x) Insert the wide string (usually UTF-16) into the enclosed Any inside this DynAny
boolean	next() Advances the internal pointer, described in the current_component(), one position forward.
void	rewind() Moves the internal pointer, described in the current_component(), to the first component.
boolean	seek(int p) Moves the internal pointer, described in the current_component(), to the given position.
Any	to_any() Returns a shallow copy of the enclosed Any,
TypeCode	type() Returns the typecode of the object, inserted into this DynAny.

Method Detail

assign

void assign(DynAny from)
            throws TypeMismatch

Initialises the value of this DynAny with the value, stored inside the passed DynAny, making a shallow copy.

Parameters:

from - the DynAny to copy from.

Throws:

TypeMismatch - if the source DynAny is invalid.

copy

DynAny copy()

Fully clones the content of this Any, returning a deep copy.

current_component

DynAny current_component()
                         throws TypeMismatch

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 null.

Throws:

TypeMismatch - if called on DynAny that cannot have active components, like DynEnum.

destroy

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

void from_any(Any an_any)
              throws TypeMismatch,
                     InvalidValue

Makes a DynAny from the Any. The passed Any becomes the enclosed instance of this DynAny, allowing to change/traverse the Any fields by the DynAny methods.

Throws:

TypeMismatch - if the type of this DynAny differs from the type of the passed Any. The DynAny cannot be reused with the enclosed type different from that it was initially created.

InvalidValue - if the value, stored in the passed parameter, is otherwise invalid.

get_any

Any get_any()
            throws TypeMismatch,
                   InvalidValue

This method is used when the wrapped Any contains an instance of another Any itself. The method returns this second enclosed Any.

Throws:

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

InvalidValue

get_boolean

boolean get_boolean()
                    throws TypeMismatch,
                           InvalidValue

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.

InvalidValue

get_char

char get_char()
              throws TypeMismatch,
                     InvalidValue

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.

InvalidValue

get_double

double get_double()
                  throws TypeMismatch,
                         InvalidValue

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.

InvalidValue

get_float

float get_float()
                throws TypeMismatch,
                       InvalidValue

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.

InvalidValue

get_long

int get_long()
             throws TypeMismatch,
                    InvalidValue

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.

InvalidValue

get_longlong

long get_longlong()
                  throws TypeMismatch,
                         InvalidValue

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.

InvalidValue

get_octet

byte get_octet()
               throws TypeMismatch,
                      InvalidValue

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.

InvalidValue

get_reference

Object get_reference()
                     throws TypeMismatch,
                            InvalidValue

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.

InvalidValue

get_short

short get_short()
                throws TypeMismatch,
                       InvalidValue

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.

InvalidValue

get_string

String get_string()
                  throws TypeMismatch,
                         InvalidValue

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.

InvalidValue

get_typecode

TypeCode get_typecode()
                      throws TypeMismatch,
                             InvalidValue

Extract the TypeCode value that is expected to be stored in this DynAny.

Throws:

TypeMismatch - if this DynAny holds the value of the different type.

InvalidValue

get_ulong

int get_ulong()
              throws TypeMismatch,
                     InvalidValue

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.

InvalidValue

get_ulonglong

long get_ulonglong()
                   throws TypeMismatch,
                          InvalidValue

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.

InvalidValue

get_ushort

short get_ushort()
                 throws TypeMismatch,
                        InvalidValue

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.

InvalidValue

get_val

Serializable get_val()
                     throws TypeMismatch,
                            InvalidValue

Extract the value that is expected to be stored in this DynAny.

Throws:

TypeMismatch - if this DynAny holds the value of the different type.

InvalidValue

get_wchar

char get_wchar()
               throws TypeMismatch,
                      InvalidValue

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.

InvalidValue

get_wstring

String get_wstring()
                   throws TypeMismatch,
                          InvalidValue

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.

InvalidValue

insert_any

void insert_any(Any an_any)
                throws TypeMismatch,
                       InvalidValue

Insert the Any value into the enclosed 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 Any.

TypeMismatch

insert_boolean

void insert_boolean(boolean a_x)
                    throws InvalidValue,
                           TypeMismatch

Insert the boolean value into the enclosed 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 Any.

TypeMismatch

insert_char

void insert_char(char a_x)
                 throws InvalidValue,
                        TypeMismatch

Insert the char value into the enclosed 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 Any.

TypeMismatch

insert_double

void insert_double(double a_x)
                   throws InvalidValue,
                          TypeMismatch

Insert the double value into the enclosed 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 Any.

TypeMismatch

insert_float

void insert_float(float a_x)
                  throws InvalidValue,
                         TypeMismatch

Insert the float value into the enclosed 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 Any.

TypeMismatch

insert_long

void insert_long(int a_x)
                 throws InvalidValue,
                        TypeMismatch

Insert the int (CORBA long) value into the enclosed 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 Any.

TypeMismatch

insert_longlong

void insert_longlong(long a_x)
                     throws InvalidValue,
                            TypeMismatch

Insert the long (CORBA long long) value into the enclosed 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 Any.

TypeMismatch

insert_octet

void insert_octet(byte a_x)
                  throws InvalidValue,
                         TypeMismatch

Insert the byte (CORBA octet) value into the enclosed 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 Any.

TypeMismatch

insert_reference

void insert_reference(Object a_x)
                      throws InvalidValue,
                             TypeMismatch

Insert the object reference into the enclosed 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 Any.

TypeMismatch

insert_short

void insert_short(short a_x)
                  throws InvalidValue,
                         TypeMismatch

Insert the short value into the enclosed 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 Any.

TypeMismatch

insert_string

void insert_string(String a_x)
                   throws InvalidValue,
                          TypeMismatch

Insert the string value into the enclosed 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 Any.

TypeMismatch

insert_typecode

void insert_typecode(TypeCode a_x)
                     throws InvalidValue,
                            TypeMismatch

Insert the TypeCode value into the enclosed 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 Any.

TypeMismatch

insert_ulong

void insert_ulong(int a_x)
                  throws InvalidValue,
                         TypeMismatch

Insert the int (CORBA unsinged long) value into the enclosed 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 Any.

TypeMismatch

insert_ulonglong

void insert_ulonglong(long a_x)
                      throws InvalidValue,
                             TypeMismatch

Insert the long (CORBA unsigned long long) value into the enclosed 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 Any.

TypeMismatch

insert_ushort

void insert_ushort(short a_x)
                   throws InvalidValue,
                          TypeMismatch

Insert the short (CORBA unsigned short) value into the enclosed 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 Any.

TypeMismatch

insert_val

void insert_val(Serializable a_x)
                throws InvalidValue,
                       TypeMismatch

Insert the value into the enclosed 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 Any.

TypeMismatch

insert_wchar

void insert_wchar(char a_x)
                  throws InvalidValue,
                         TypeMismatch

Insert the wide char (usually UTF-16) value into the enclosed 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 Any.

TypeMismatch

insert_wstring

void insert_wstring(String a_x)
                    throws InvalidValue,
                           TypeMismatch

Insert the wide string (usually UTF-16) into the enclosed 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 Any.

TypeMismatch

next

boolean next()

Advances the internal pointer, described in the 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

void rewind()

Moves the internal pointer, described in the current_component(), to the first component.

seek

boolean seek(int p)

Moves the internal pointer, described in the 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

Any to_any()

Returns a shallow copy of the enclosed Any,

Returns:

shallow copy of the enclosed Any.

type

TypeCode type()

Returns the typecode of the object, inserted into this DynAny.

Returns:

the typecode of the inserted Any or null typecode if no has been yet inserted.

insert_dyn_any

void insert_dyn_any(DynAny insert_it)
                    throws TypeMismatch,
                           InvalidValue

Insert a value at the current position.

Parameters:

insert_it - a value to insert.

Throws:

TypeMismatch - if the component at the current position has a different type.

InvalidValue - if the current position points nowhere.

equal

boolean equal(DynAny other)

Checks for equality with another Dynamic Any.

component_count

int component_count()

Get the number number of fields in the enclosed structure or number of memebers in the enclosed array, sequence, enumeration, etc. This method only counts elements at the top level. For instance, if invoked on a DynStruct with a single member, it returns 1, irrespective of the type of the member.

Returns:

number of components or 0 if the enclosed Any is not divideable.

get_dyn_any

DynAny get_dyn_any()
                   throws TypeMismatch,
                          InvalidValue

Return DynAny, wrapping the second (enclosed any) that is stored in the wrapped Any.

Throws:

TypeMismatch - if the wrapped Any does not store another Any.

InvalidValue - if the current position points nowhere.