package org.omg.DynamicAny;
/**
* org/omg/DynamicAny/DynAnyOperations.java .
* Generated by the IDL-to-Java compiler (portable), version "3.2"
* from /var/lib/jenkins/jobs/openjdk/jobs/openjdk10/workspace/jdk-updates_jdk10u/src/java.corba/share/classes/org/omg/DynamicAny/DynamicAny.idl
* Sunday, February 14, 2021 at 5:20:30 PM Coordinated Universal Time
*/
Any values can be dynamically interpreted (traversed) and constructed through DynAny objects.
A DynAny object is associated with a data value which corresponds to a copy of the value
inserted into an any.
A DynAny object may be viewed as an ordered collection of component DynAnys.
For DynAnys representing a basic type, such as long, or a type without components,
such as an empty exception, the ordered collection of components is empty.
Each DynAny object maintains the notion of a current position into its collection
of component DynAnys. The current position is identified by an index value that runs
from 0 to n-1, where n is the number of components.
The special index value -1 indicates a current position that points nowhere.
For values that cannot have a current position (such as an empty exception),
the index value is fixed at -1.
If a DynAny is initialized with a value that has components, the index is initialized to 0.
After creation of an uninitialized DynAny (that is, a DynAny that has no value but a TypeCode
that permits components), the current position depends on the type of value represented by
the DynAny. (The current position is set to 0 or -1, depending on whether the new DynAny
gets default values for its components.)
The iteration operations rewind, seek, and next can be used to change the current position
and the current_component operation returns the component at the current position.
The component_count operation returns the number of components of a DynAny.
Collectively, these operations enable iteration over the components of a DynAny, for example,
to (recursively) examine its contents.
A constructed DynAny object is a DynAny object associated with a constructed type.
There is a different interface, inheriting from the DynAny interface, associated with
each kind of constructed type in IDL (fixed, enum, struct, sequence, union, array,
exception, and value type).
A constructed DynAny object exports operations that enable the creation of new DynAny objects,
each of them associated with a component of the constructed data value.
As an example, a DynStruct is associated with a struct value. This means that the DynStruct
may be seen as owning an ordered collection of components, one for each structure member.
The DynStruct object exports operations that enable the creation of new DynAny objects,
each of them associated with a member of the struct.
If a DynAny object has been obtained from another (constructed) DynAny object,
such as a DynAny representing a structure member that was created from a DynStruct,
the member DynAny is logically contained in the DynStruct.
Calling an insert or get operation leaves the current position unchanged.
Destroying a top-level DynAny object (one that was not obtained as a component of another DynAny)
also destroys any component DynAny objects obtained from it.
Destroying a non-top level DynAny object does nothing.
Invoking operations on a destroyed top-level DynAny or any of its descendants raises OBJECT_NOT_EXIST.
If the programmer wants to destroy a DynAny object but still wants to manipulate some component
of the data value associated with it, then he or she should first create a DynAny for the component
and, after that, make a copy of the created DynAny object.
The behavior of DynAny objects has been defined in order to enable efficient implementations
in terms of allocated memory space and speed of access. DynAny objects are intended to be used
for traversing values extracted from anys or constructing values of anys at runtime.
Their use for other purposes is not recommended.
Insert and get operations are necessary to handle basic DynAny objects
but are also helpful to handle constructed DynAny objects.
Inserting a basic data type value into a constructed DynAny object
implies initializing the current component of the constructed data value
associated with the DynAny object. For example, invoking insert_boolean on a
DynStruct implies inserting a boolean data value at the current position
of the associated struct data value.
A type is consistent for inserting or extracting a value if its TypeCode is equivalent to
the TypeCode contained in the DynAny or, if the DynAny has components, is equivalent to the TypeCode
of the DynAny at the current position.
DynAny and DynAnyFactory objects are intended to be local to the process in which they are
created and used. This means that references to DynAny and DynAnyFactory objects cannot be exported
to other processes, or externalized with ORB.object_to_string().
If any attempt is made to do so, the offending operation will raise a MARSHAL system exception.
Since their interfaces are specified in IDL, DynAny objects export operations defined in the standard
org.omg.CORBA.Object interface. However, any attempt to invoke operations exported through the Object
interface may raise the standard NO_IMPLEMENT exception.
An attempt to use a DynAny object with the DII may raise the NO_IMPLEMENT exception.
/**
* Any values can be dynamically interpreted (traversed) and constructed through DynAny objects.
* A DynAny object is associated with a data value which corresponds to a copy of the value
* inserted into an any.
* <P>A DynAny object may be viewed as an ordered collection of component DynAnys.
* For DynAnys representing a basic type, such as long, or a type without components,
* such as an empty exception, the ordered collection of components is empty.
* Each DynAny object maintains the notion of a current position into its collection
* of component DynAnys. The current position is identified by an index value that runs
* from 0 to n-1, where n is the number of components.
* The special index value -1 indicates a current position that points nowhere.
* For values that cannot have a current position (such as an empty exception),
* the index value is fixed at -1.
* If a DynAny is initialized with a value that has components, the index is initialized to 0.
* After creation of an uninitialized DynAny (that is, a DynAny that has no value but a TypeCode
* that permits components), the current position depends on the type of value represented by
* the DynAny. (The current position is set to 0 or -1, depending on whether the new DynAny
* gets default values for its components.)
* <P>The iteration operations rewind, seek, and next can be used to change the current position
* and the current_component operation returns the component at the current position.
* The component_count operation returns the number of components of a DynAny.
* Collectively, these operations enable iteration over the components of a DynAny, for example,
* to (recursively) examine its contents.
* <P>A constructed DynAny object is a DynAny object associated with a constructed type.
* There is a different interface, inheriting from the DynAny interface, associated with
* each kind of constructed type in IDL (fixed, enum, struct, sequence, union, array,
* exception, and value type).
* <P>A constructed DynAny object exports operations that enable the creation of new DynAny objects,
* each of them associated with a component of the constructed data value.
* As an example, a DynStruct is associated with a struct value. This means that the DynStruct
* may be seen as owning an ordered collection of components, one for each structure member.
* The DynStruct object exports operations that enable the creation of new DynAny objects,
* each of them associated with a member of the struct.
* <P>If a DynAny object has been obtained from another (constructed) DynAny object,
* such as a DynAny representing a structure member that was created from a DynStruct,
* the member DynAny is logically contained in the DynStruct.
* Calling an insert or get operation leaves the current position unchanged.
* Destroying a top-level DynAny object (one that was not obtained as a component of another DynAny)
* also destroys any component DynAny objects obtained from it.
* Destroying a non-top level DynAny object does nothing.
* Invoking operations on a destroyed top-level DynAny or any of its descendants raises OBJECT_NOT_EXIST.
* If the programmer wants to destroy a DynAny object but still wants to manipulate some component
* of the data value associated with it, then he or she should first create a DynAny for the component
* and, after that, make a copy of the created DynAny object.
* <P>The behavior of DynAny objects has been defined in order to enable efficient implementations
* in terms of allocated memory space and speed of access. DynAny objects are intended to be used
* for traversing values extracted from anys or constructing values of anys at runtime.
* Their use for other purposes is not recommended.
* <P>Insert and get operations are necessary to handle basic DynAny objects
* but are also helpful to handle constructed DynAny objects.
* Inserting a basic data type value into a constructed DynAny object
* implies initializing the current component of the constructed data value
* associated with the DynAny object. For example, invoking insert_boolean on a
* DynStruct implies inserting a boolean data value at the current position
* of the associated struct data value.
* A type is consistent for inserting or extracting a value if its TypeCode is equivalent to
* the TypeCode contained in the DynAny or, if the DynAny has components, is equivalent to the TypeCode
* of the DynAny at the current position.
* <P>DynAny and DynAnyFactory objects are intended to be local to the process in which they are
* created and used. This means that references to DynAny and DynAnyFactory objects cannot be exported
* to other processes, or externalized with ORB.object_to_string().
* If any attempt is made to do so, the offending operation will raise a MARSHAL system exception.
* Since their interfaces are specified in IDL, DynAny objects export operations defined in the standard
* org.omg.CORBA.Object interface. However, any attempt to invoke operations exported through the Object
* interface may raise the standard NO_IMPLEMENT exception.
* An attempt to use a DynAny object with the DII may raise the NO_IMPLEMENT exception.
*/
public interface DynAnyOperations
{
Returns the TypeCode associated with this DynAny object.
A DynAny object is created with a TypeCode value assigned to it.
This TypeCode value determines the type of the value handled through the DynAny object.
Note that the TypeCode associated with a DynAny object is initialized at the time the
DynAny is created and cannot be changed during lifetime of the DynAny object.
Returns: The TypeCode associated with this DynAny object
/**
* Returns the TypeCode associated with this DynAny object.
* A DynAny object is created with a TypeCode value assigned to it.
* This TypeCode value determines the type of the value handled through the DynAny object.
* Note that the TypeCode associated with a DynAny object is initialized at the time the
* DynAny is created and cannot be changed during lifetime of the DynAny object.
*
* @return The TypeCode associated with this DynAny object
*/
org.omg.CORBA.TypeCode type ();
Initializes the value associated with a DynAny object with the value
associated with another DynAny object.
The current position of the target DynAny is set to zero for values that have components
and to -1 for values that do not have components.
Params: - dyn_any –
Throws: - TypeMismatch – if the type of the passed DynAny is not equivalent to the type of target DynAny
/**
* Initializes the value associated with a DynAny object with the value
* associated with another DynAny object.
* The current position of the target DynAny is set to zero for values that have components
* and to -1 for values that do not have components.
*
* @param dyn_any
* @exception TypeMismatch if the type of the passed DynAny is not equivalent to the type of target DynAny
*/
void assign (org.omg.DynamicAny.DynAny dyn_any) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch;
Initializes the value associated with a DynAny object with the value contained in an any.
The current position of the target DynAny is set to zero for values that have components
and to -1 for values that do not have components.
Throws: - TypeMismatch – if the type of the passed Any is not equivalent to the type of target DynAny
- InvalidValue – if the passed Any does not contain a legal value (such as a null string)
/**
* Initializes the value associated with a DynAny object with the value contained in an any.
* The current position of the target DynAny is set to zero for values that have components
* and to -1 for values that do not have components.
*
* @exception TypeMismatch if the type of the passed Any is not equivalent to the type of target DynAny
* @exception InvalidValue if the passed Any does not contain a legal value (such as a null string)
*/
void from_any (org.omg.CORBA.Any value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Creates an any value from a DynAny object.
A copy of the TypeCode associated with the DynAny object is assigned to the resulting any.
The value associated with the DynAny object is copied into the any.
Returns: a new Any object with the same value and TypeCode
/**
* Creates an any value from a DynAny object.
* A copy of the TypeCode associated with the DynAny object is assigned to the resulting any.
* The value associated with the DynAny object is copied into the any.
*
* @return a new Any object with the same value and TypeCode
*/
org.omg.CORBA.Any to_any ();
Compares two DynAny values for equality.
Two DynAny values are equal if their TypeCodes are equivalent and, recursively, all component DynAnys
have equal values.
The current position of the two DynAnys being compared has no effect on the result of equal.
Returns: true of the DynAnys are equal, false otherwise
/**
* Compares two DynAny values for equality.
* Two DynAny values are equal if their TypeCodes are equivalent and, recursively, all component DynAnys
* have equal values.
* The current position of the two DynAnys being compared has no effect on the result of equal.
*
* @return true of the DynAnys are equal, false otherwise
*/
boolean equal (org.omg.DynamicAny.DynAny dyn_any);
Destroys a DynAny object.
This operation frees any resources used to represent the data value associated with a DynAny object.
It must be invoked on references obtained from one of the creation operations on the ORB interface
or on a reference returned by DynAny.copy() to avoid resource leaks.
Invoking destroy on component DynAny objects (for example, on objects returned by the
current_component operation) does nothing.
Destruction of a DynAny object implies destruction of all DynAny objects obtained from it.
That is, references to components of a destroyed DynAny become invalid.
Invocations on such references raise OBJECT_NOT_EXIST.
It is possible to manipulate a component of a DynAny beyond the life time of the DynAny
from which the component was obtained by making a copy of the component with the copy operation
before destroying the DynAny from which the component was obtained.
/**
* Destroys a DynAny object.
* This operation frees any resources used to represent the data value associated with a DynAny object.
* It must be invoked on references obtained from one of the creation operations on the ORB interface
* or on a reference returned by DynAny.copy() to avoid resource leaks.
* Invoking destroy on component DynAny objects (for example, on objects returned by the
* current_component operation) does nothing.
* Destruction of a DynAny object implies destruction of all DynAny objects obtained from it.
* That is, references to components of a destroyed DynAny become invalid.
* Invocations on such references raise OBJECT_NOT_EXIST.
* It is possible to manipulate a component of a DynAny beyond the life time of the DynAny
* from which the component was obtained by making a copy of the component with the copy operation
* before destroying the DynAny from which the component was obtained.
*/
void destroy ();
Creates a new DynAny object whose value is a deep copy of the DynAny on which it is invoked.
The operation is polymorphic, that is, invoking it on one of the types derived from DynAny,
such as DynStruct, creates the derived type but returns its reference as the DynAny base type.
Returns: a deep copy of the DynAny object
/**
* Creates a new DynAny object whose value is a deep copy of the DynAny on which it is invoked.
* The operation is polymorphic, that is, invoking it on one of the types derived from DynAny,
* such as DynStruct, creates the derived type but returns its reference as the DynAny base type.
*
* @return a deep copy of the DynAny object
*/
org.omg.DynamicAny.DynAny copy ();
Inserts a boolean value into the DynAny.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a boolean value into the DynAny.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_boolean (boolean value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a byte value into the DynAny. The IDL octet data type is mapped to the Java byte data type.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a byte value into the DynAny. The IDL octet data type is mapped to the Java byte data type.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_octet (byte value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a char value into the DynAny.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a char value into the DynAny.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_char (char value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a short value into the DynAny.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a short value into the DynAny.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_short (short value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a short value into the DynAny. The IDL ushort data type is mapped to the Java short data type.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a short value into the DynAny. The IDL ushort data type is mapped to the Java short data type.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_ushort (short value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts an integer value into the DynAny. The IDL long data type is mapped to the Java int data type.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts an integer value into the DynAny. The IDL long data type is mapped to the Java int data type.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_long (int value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts an integer value into the DynAny. The IDL ulong data type is mapped to the Java int data type.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts an integer value into the DynAny. The IDL ulong data type is mapped to the Java int data type.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_ulong (int value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a float value into the DynAny.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a float value into the DynAny.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_float (float value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a double value into the DynAny.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a double value into the DynAny.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_double (double value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a string value into the DynAny.
Both bounded and unbounded strings are inserted using this method.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- InvalidValue – if the string inserted is longer than the bound of a bounded string
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a string value into the DynAny.
* Both bounded and unbounded strings are inserted using this method.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception InvalidValue if the string inserted is longer than the bound of a bounded string
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_string (String value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a reference to a CORBA object into the DynAny.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a reference to a CORBA object into the DynAny.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_reference (org.omg.CORBA.Object value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a TypeCode object into the DynAny.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a TypeCode object into the DynAny.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_typecode (org.omg.CORBA.TypeCode value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a long value into the DynAny. The IDL long long data type is mapped to the Java long data type.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a long value into the DynAny. The IDL long long data type is mapped to the Java long data type.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_longlong (long value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a long value into the DynAny.
The IDL unsigned long long data type is mapped to the Java long data type.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a long value into the DynAny.
* The IDL unsigned long long data type is mapped to the Java long data type.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_ulonglong (long value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a char value into the DynAny. The IDL wchar data type is mapped to the Java char data type.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a char value into the DynAny. The IDL wchar data type is mapped to the Java char data type.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_wchar (char value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a string value into the DynAny.
Both bounded and unbounded strings are inserted using this method.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- InvalidValue – if the string inserted is longer than the bound of a bounded string
/**
* Inserts a string value into the DynAny.
* Both bounded and unbounded strings are inserted using this method.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception InvalidValue if the string inserted is longer than the bound of a bounded string
*/
void insert_wstring (String value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts an Any value into the Any represented by this DynAny.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts an Any value into the Any represented by this DynAny.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_any (org.omg.CORBA.Any value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts the Any value contained in the parameter DynAny into the Any represented by this DynAny.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts the Any value contained in the parameter DynAny into the Any represented by this DynAny.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_dyn_any (org.omg.DynamicAny.DynAny value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Inserts a reference to a Serializable object into this DynAny.
The IDL ValueBase type is mapped to the Java Serializable type.
Throws: - InvalidValue – if this DynAny has components but has a current position of -1
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Inserts a reference to a Serializable object into this DynAny.
* The IDL ValueBase type is mapped to the Java Serializable type.
*
* @exception InvalidValue if this DynAny has components but has a current position of -1
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
void insert_val (java.io.Serializable value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the boolean value from this DynAny.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the boolean value from this DynAny.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
boolean get_boolean () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the byte value from this DynAny. The IDL octet data type is mapped to the Java byte data type.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the byte value from this DynAny. The IDL octet data type is mapped to the Java byte data type.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
byte get_octet () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the char value from this DynAny.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the char value from this DynAny.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
char get_char () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the short value from this DynAny.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the short value from this DynAny.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
short get_short () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the short value from this DynAny. The IDL ushort data type is mapped to the Java short data type.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the short value from this DynAny. The IDL ushort data type is mapped to the Java short data type.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
short get_ushort () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the integer value from this DynAny. The IDL long data type is mapped to the Java int data type.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the integer value from this DynAny. The IDL long data type is mapped to the Java int data type.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
int get_long () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the integer value from this DynAny. The IDL ulong data type is mapped to the Java int data type.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the integer value from this DynAny. The IDL ulong data type is mapped to the Java int data type.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
int get_ulong () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the float value from this DynAny.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the float value from this DynAny.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
float get_float () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the double value from this DynAny.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the double value from this DynAny.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
double get_double () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the string value from this DynAny.
Both bounded and unbounded strings are extracted using this method.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the string value from this DynAny.
* Both bounded and unbounded strings are extracted using this method.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
String get_string () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the reference to a CORBA Object from this DynAny.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the reference to a CORBA Object from this DynAny.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
org.omg.CORBA.Object get_reference () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the TypeCode object from this DynAny.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the TypeCode object from this DynAny.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
org.omg.CORBA.TypeCode get_typecode () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the long value from this DynAny. The IDL long long data type is mapped to the Java long data type.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the long value from this DynAny. The IDL long long data type is mapped to the Java long data type.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
long get_longlong () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the long value from this DynAny.
The IDL unsigned long long data type is mapped to the Java long data type.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the long value from this DynAny.
* The IDL unsigned long long data type is mapped to the Java long data type.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
long get_ulonglong () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the long value from this DynAny. The IDL wchar data type is mapped to the Java char data type.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the long value from this DynAny. The IDL wchar data type is mapped to the Java char data type.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
char get_wchar () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the string value from this DynAny.
Both bounded and unbounded strings are extracted using this method.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
/**
* Extracts the string value from this DynAny.
* Both bounded and unbounded strings are extracted using this method.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
*/
String get_wstring () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts an Any value contained in the Any represented by this DynAny.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts an Any value contained in the Any represented by this DynAny.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
org.omg.CORBA.Any get_any () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts the Any value contained in the Any represented by this DynAny and returns it wrapped
into a new DynAny.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts the Any value contained in the Any represented by this DynAny and returns it wrapped
* into a new DynAny.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
org.omg.DynamicAny.DynAny get_dyn_any () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Extracts a Serializable object from this DynAny.
The IDL ValueBase type is mapped to the Java Serializable type.
Throws: - TypeMismatch – if the accessed component in the DynAny is of a type
that is not equivalent to the requested type.
- TypeMismatch – if called on a DynAny whose current component itself has components
- InvalidValue – if this DynAny has components but has a current position of -1
/**
* Extracts a Serializable object from this DynAny.
* The IDL ValueBase type is mapped to the Java Serializable type.
*
* @exception TypeMismatch if the accessed component in the DynAny is of a type
* that is not equivalent to the requested type.
* @exception TypeMismatch if called on a DynAny whose current component itself has components
* @exception InvalidValue if this DynAny has components but has a current position of -1
*/
java.io.Serializable get_val () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch, org.omg.DynamicAny.DynAnyPackage.InvalidValue;
Sets the current position to index. The current position is indexed 0 to n-1, that is,
index zero corresponds to the first component. The operation returns true if the resulting
current position indicates a component of the DynAny and false if index indicates
a position that does not correspond to a component.
Calling seek with a negative index is legal. It sets the current position to -1 to indicate
no component and returns false. Passing a non-negative index value for a DynAny that does not
have a component at the corresponding position sets the current position to -1 and returns false.
/**
* Sets the current position to index. The current position is indexed 0 to n-1, that is,
* index zero corresponds to the first component. The operation returns true if the resulting
* current position indicates a component of the DynAny and false if index indicates
* a position that does not correspond to a component.
* Calling seek with a negative index is legal. It sets the current position to -1 to indicate
* no component and returns false. Passing a non-negative index value for a DynAny that does not
* have a component at the corresponding position sets the current position to -1 and returns false.
*/
boolean seek (int index);
Is equivalent to seek(0).
/**
* Is equivalent to seek(0).
*/
void rewind ();
Advances the current position to the next component.
The operation returns true while the resulting current position indicates a component, false otherwise.
A false return value leaves the current position at -1.
Invoking next on a DynAny without components leaves the current position at -1 and returns false.
/**
* Advances the current position to the next component.
* The operation returns true while the resulting current position indicates a component, false otherwise.
* A false return value leaves the current position at -1.
* Invoking next on a DynAny without components leaves the current position at -1 and returns false.
*/
boolean next ();
Returns the number of components of a DynAny.
For a DynAny without components, it returns zero.
The operation only counts the components at the top level.
For example, if component_count is invoked on a DynStruct with a single member,
the return value is 1, irrespective of the type of the member.
- For sequences, the operation returns the current number of elements.
- For structures, exceptions, and value types, the operation returns the number of members.
- For arrays, the operation returns the number of elements.
- For unions, the operation returns 2 if the discriminator indicates that a named member is active,
otherwise, it returns 1.
- For DynFixed and DynEnum, the operation returns zero.
/**
* Returns the number of components of a DynAny.
* For a DynAny without components, it returns zero.
* The operation only counts the components at the top level.
* For example, if component_count is invoked on a DynStruct with a single member,
* the return value is 1, irrespective of the type of the member.
* <UL>
* <LI>For sequences, the operation returns the current number of elements.
* <LI>For structures, exceptions, and value types, the operation returns the number of members.
* <LI>For arrays, the operation returns the number of elements.
* <LI>For unions, the operation returns 2 if the discriminator indicates that a named member is active,
* otherwise, it returns 1.
* <LI>For DynFixed and DynEnum, the operation returns zero.
* </UL>
*/
int component_count ();
Returns the DynAny for the component at the current position.
It does not advance the current position, so repeated calls to current_component
without an intervening call to rewind, next, or seek return the same component.
The returned DynAny object reference can be used to get/set the value of the current component.
If the current component represents a complex type, the returned reference can be narrowed
based on the TypeCode to get the interface corresponding to the to the complex type.
Calling current_component on a DynAny that cannot have components,
such as a DynEnum or an empty exception, raises TypeMismatch.
Calling current_component on a DynAny whose current position is -1 returns a nil reference.
The iteration operations, together with current_component, can be used
to dynamically compose an any value. After creating a dynamic any, such as a DynStruct,
current_component and next can be used to initialize all the components of the value.
Once the dynamic value is completely initialized, to_any creates the corresponding any value.
Throws: - TypeMismatch – If called on a DynAny that cannot have components,
such as a DynEnum or an empty exception
/**
* Returns the DynAny for the component at the current position.
* It does not advance the current position, so repeated calls to current_component
* without an intervening call to rewind, next, or seek return the same component.
* The returned DynAny object reference can be used to get/set the value of the current component.
* If the current component represents a complex type, the returned reference can be narrowed
* based on the TypeCode to get the interface corresponding to the to the complex type.
* Calling current_component on a DynAny that cannot have components,
* such as a DynEnum or an empty exception, raises TypeMismatch.
* Calling current_component on a DynAny whose current position is -1 returns a nil reference.
* The iteration operations, together with current_component, can be used
* to dynamically compose an any value. After creating a dynamic any, such as a DynStruct,
* current_component and next can be used to initialize all the components of the value.
* Once the dynamic value is completely initialized, to_any creates the corresponding any value.
*
* @exception TypeMismatch If called on a DynAny that cannot have components,
* such as a DynEnum or an empty exception
*/
org.omg.DynamicAny.DynAny current_component () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch;
} // interface DynAnyOperations