/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * particular file as subject to the "Classpath" exception as provided

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 */

// IDL

// File: DynamicAny.idl

#ifndef _DYNAMIC_ANY_IDL_

#define _DYNAMIC_ANY_IDL_

#pragma prefix "omg.org"

#include <orb.idl>

/**

* An any can be passed to a program that doesn't have any static information for the

type of the any (code generated for the type by an IDL compiler has not been

compiled with the object implementation). As a result, the object receiving the any

does not have a portable method of using it.

<P>DynAnys enable traversal of the data value associated with an any at

runtime and extraction of the primitive constituents of the data value. This is especially

helpful for writing powerful generic servers (bridges, event channels supporting

filtering).

<P>Similarly, this facility enables the construction of an any at runtime, without having

static knowledge of its type. This is especially helpful for writing generic clients

(bridges, browsers, debuggers, user interface tools).

*/

module DynamicAny {

    /**

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

    */

    interface DynAny {

	#pragma sun_localservant DynAny ""

        exception InvalidValue {};

        exception TypeMismatch {};

        /**

        * 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

        */

        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.

        *

        * @param dyn_any

        * @exception TypeMismatch if the type of the passed DynAny is not equivalent to the type of target DynAny

        */

        void assign(in DynAny dyn_any)

            raises(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.

        *

        * @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(in any value)

            raises(TypeMismatch, 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.

        *

        * @return a new Any object with the same value and TypeCode

        */

        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.

        *

        * @return true of the DynAnys are equal, false otherwise

        */

        boolean equal(in 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.

        */

        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.

        *

        * @return a deep copy of the DynAny object

        */

        DynAny copy();

        /**

        * 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(in boolean value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in octet value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in char value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in short value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in unsigned short value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in long value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in unsigned long value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in float value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in double value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in string value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in Object value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in CORBA::TypeCode value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in long long value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in unsigned long long value)

            raises(TypeMismatch, InvalidValue);

//        void insert_longdouble(in long double value)

//            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in wchar value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in wstring value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in any value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in DynAny value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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(in ValueBase value)

            raises(TypeMismatch, InvalidValue);

        /**

        * 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()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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

        */

        octet get_octet()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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

        */

        unsigned short get_ushort()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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

        */

        long get_long()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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

        */

        unsigned long get_ulong()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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

        */

        Object get_reference()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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

        */

        CORBA::TypeCode get_typecode()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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 long get_longlong()

            raises(TypeMismatch, InvalidValue);

        /**

        * 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