< prev index next >
src/java.corba/share/classes/org/omg/CORBA/DynAny.java
Print this page
*** 25,727 ****
package org.omg.CORBA;
! /** Enables <tt>org.omg.CORBA.Any</tt> values to be dynamically
* interpreted (traversed) and
! * constructed. A <tt>DynAny</tt> object is associated with a data value
! * which may correspond to a copy of the value inserted into an <tt>Any</tt>.
! * The <tt>DynAny</tt> APIs enable traversal of the data value associated with an
* Any at runtime and extraction of the primitive constituents of the
* data value.
* @deprecated Use the new <a href="../DynamicAny/DynAny.html">DynAny</a> instead
*/
@Deprecated
public interface DynAny extends org.omg.CORBA.Object
{
/**
! * Returns the <code>TypeCode</code> of the object inserted into
! * this <code>DynAny</code>.
*
! * @return the <code>TypeCode</code> object.
*/
public org.omg.CORBA.TypeCode type() ;
/**
* Copy the contents from one Dynamic Any into another.
*
! * @param dyn_any the <code>DynAny</code> object whose contents
! * are assigned to this <code>DynAny</code>.
* @throws org.omg.CORBA.DynAnyPackage.Invalid if the source
! * <code>DynAny</code> is invalid
*/
public void assign(org.omg.CORBA.DynAny dyn_any)
throws org.omg.CORBA.DynAnyPackage.Invalid;
/**
! * Make a <code>DynAny</code> object from an <code>Any</code>
* object.
*
! * @param value the <code>Any</code> object.
* @throws org.omg.CORBA.DynAnyPackage.Invalid if the source
! * <code>Any</code> object is empty or bad
*/
public void from_any(org.omg.CORBA.Any value)
throws org.omg.CORBA.DynAnyPackage.Invalid;
/**
! * Convert a <code>DynAny</code> object to an <code>Any</code>
* object.
*
! * @return the <code>Any</code> object.
* @throws org.omg.CORBA.DynAnyPackage.Invalid if this
! * <code>DynAny</code> is empty or bad.
* created or does not contain a meaningful value
*/
public org.omg.CORBA.Any to_any()
throws org.omg.CORBA.DynAnyPackage.Invalid;
/**
! * Destroys this <code>DynAny</code> object and frees any resources
* used to represent the data value associated with it. This method
! * also destroys all <code>DynAny</code> objects obtained from it.
* <p>
! * Destruction of <code>DynAny</code> objects should be handled with
* care, taking into account issues dealing with the representation of
! * data values associated with <code>DynAny</code> objects. A programmer
! * who wants to destroy a <code>DynAny</code> object but still be able
* to manipulate some component of the data value associated with it,
! * should first create a <code>DynAny</code> object for the component
! * and then make a copy of the created <code>DynAny</code> object.
*/
public void destroy() ;
/**
! * Clones this <code>DynAny</code> object.
*
! * @return a copy of this <code>DynAny</code> object
*/
public org.omg.CORBA.DynAny copy() ;
/**
! * Inserts the given <code>boolean</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>boolean</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_boolean(boolean value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>byte</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>byte</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_octet(byte value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>char</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>char</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_char(char value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>short</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>short</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_short(short value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>short</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>short</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_ushort(short value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>int</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>int</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_long(int value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>int</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>int</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_ulong(int value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>float</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>float</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_float(float value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>double</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>double</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_double(double value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>String</code> object as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>String</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_string(String value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>org.omg.CORBA.Object</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>org.omg.CORBA.Object</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_reference(org.omg.CORBA.Object value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>org.omg.CORBA.TypeCode</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>org.omg.CORBA.TypeCode</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_typecode(org.omg.CORBA.TypeCode value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>long</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>long</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_longlong(long value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>long</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>long</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_ulonglong(long value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>char</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>char</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_wchar(char value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>String</code> as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>String</code> to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_wstring(String value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given <code>org.omg.CORBA.Any</code> object as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>org.omg.CORBA.Any</code> object to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_any(org.omg.CORBA.Any value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
// orbos 98-01-18: Objects By Value -- begin
/**
! * Inserts the given <code>java.io.Serializable</code> object as the value for this
! * <code>DynAny</code> object.
*
! * <p> If this method is called on a constructed <code>DynAny</code>
* object, it initializes the next component of the constructed data
! * value associated with this <code>DynAny</code> object.
*
! * @param value the <code>java.io.Serializable</code> object to insert into this
! * <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this <code>DynAny</code> object
*/
public void insert_val(java.io.Serializable value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Retrieves the <code>java.io.Serializable</code> object contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>java.io.Serializable</code> object that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>java.io.Serializable</code> object
*/
public java.io.Serializable get_val()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
// orbos 98-01-18: Objects By Value -- end
/**
! * Retrieves the <code>boolean</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>boolean</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>boolean</code>
*/
public boolean get_boolean()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>byte</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>byte</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>byte</code>
*/
public byte get_octet()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>char</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>char</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>char</code>
*/
public char get_char()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>short</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>short</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>short</code>
*/
public short get_short()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>short</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>short</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>short</code>
*/
public short get_ushort()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>int</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>int</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>int</code>
*/
public int get_long()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>int</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>int</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>int</code>
*/
public int get_ulong()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>float</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>float</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>float</code>
*/
public float get_float()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>double</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>double</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>double</code>
*/
public double get_double()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>String</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>String</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>String</code>
*/
public String get_string()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>org.omg.CORBA.Other</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>org.omg.CORBA.Other</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for an <code>org.omg.CORBA.Other</code>
*/
public org.omg.CORBA.Object get_reference()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>org.omg.CORBA.TypeCode</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>org.omg.CORBA.TypeCode</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>org.omg.CORBA.TypeCode</code>
*/
public org.omg.CORBA.TypeCode get_typecode()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>long</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>long</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>long</code>
*/
public long get_longlong()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>long</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>long</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>long</code>
*/
public long get_ulonglong()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>char</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>char</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>char</code>
*/
public char get_wchar()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>String</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>String</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for a <code>String</code>
*/
public String get_wstring()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the <code>org.omg.CORBA.Any</code> contained
! * in this <code>DynAny</code> object.
*
! * @return the <code>org.omg.CORBA.Any</code> that is the
! * value for this <code>DynAny</code> object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * <code>DynAny</code> object is not equivalent to
! * the type code for an <code>org.omg.CORBA.Any</code>
*/
public org.omg.CORBA.Any get_any()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Returns a <code>DynAny</code> object reference that can
* be used to get/set the value of the component currently accessed.
! * The appropriate <code>insert</code> method
! * can be called on the resulting <code>DynAny</code> object
* to initialize the component.
! * The appropriate <code>get</code> method
! * can be called on the resulting <code>DynAny</code> object
* to extract the value of the component.
*
! * @return a <code>DynAny</code> object reference that can be
* used to retrieve or set the value of the component currently
* accessed
*/
public org.omg.CORBA.DynAny current_component() ;
/**
! * Moves to the next component of this <code>DynAny</code> object.
* This method is used for iterating through the components of
* a constructed type, effectively moving a pointer from one
* component to the next. The pointer starts out on the first
! * component when a <code>DynAny</code> object is created.
*
! * @return <code>true</code> if the pointer points to a component;
! * <code>false</code> if there are no more components or this
! * <code>DynAny</code> is associated with a basic type rather than
* a constructed type
*/
public boolean next() ;
/**
* Moves the internal pointer to the given index. Logically, this method
* sets a new offset for this pointer.
*
! * @param index an <code>int</code> indicating the position to which
* the pointer should move. The first position is 0.
! * @return <code>true</code> if the pointer points to a component;
! * <code>false</code> if there is no component at the designated
! * index. If this <code>DynAny</code> object is associated with a
! * basic type, this method returns <code>false</code> for any index
* other than 0.
*/
public boolean seek(int index) ;
/**
--- 25,728 ----
package org.omg.CORBA;
! /**
! * Enables {@code org.omg.CORBA.Any} values to be dynamically
* interpreted (traversed) and
! * constructed. A {@code DynAny} object is associated with a data value
! * which may correspond to a copy of the value inserted into an {@code Any}.
! * The {@code DynAny} APIs enable traversal of the data value associated with an
* Any at runtime and extraction of the primitive constituents of the
* data value.
* @deprecated Use the new <a href="../DynamicAny/DynAny.html">DynAny</a> instead
*/
@Deprecated
public interface DynAny extends org.omg.CORBA.Object
{
/**
! * Returns the {@code TypeCode} of the object inserted into
! * this {@code DynAny}.
*
! * @return the {@code TypeCode} object.
*/
public org.omg.CORBA.TypeCode type() ;
/**
* Copy the contents from one Dynamic Any into another.
*
! * @param dyn_any the {@code DynAny} object whose contents
! * are assigned to this {@code DynAny}.
* @throws org.omg.CORBA.DynAnyPackage.Invalid if the source
! * {@code DynAny} is invalid
*/
public void assign(org.omg.CORBA.DynAny dyn_any)
throws org.omg.CORBA.DynAnyPackage.Invalid;
/**
! * Make a {@code DynAny} object from an {@code Any}
* object.
*
! * @param value the {@code Any} object.
* @throws org.omg.CORBA.DynAnyPackage.Invalid if the source
! * {@code Any} object is empty or bad
*/
public void from_any(org.omg.CORBA.Any value)
throws org.omg.CORBA.DynAnyPackage.Invalid;
/**
! * Convert a {@code DynAny} object to an {@code Any}
* object.
*
! * @return the {@code Any} object.
* @throws org.omg.CORBA.DynAnyPackage.Invalid if this
! * {@code DynAny} is empty or bad.
* created or does not contain a meaningful value
*/
public org.omg.CORBA.Any to_any()
throws org.omg.CORBA.DynAnyPackage.Invalid;
/**
! * Destroys this {@code DynAny} object and frees any resources
* used to represent the data value associated with it. This method
! * also destroys all {@code DynAny} objects obtained from it.
* <p>
! * Destruction of {@code DynAny} objects should be handled with
* care, taking into account issues dealing with the representation of
! * data values associated with {@code DynAny} objects. A programmer
! * who wants to destroy a {@code DynAny} object but still be able
* to manipulate some component of the data value associated with it,
! * should first create a {@code DynAny} object for the component
! * and then make a copy of the created {@code DynAny} object.
*/
public void destroy() ;
/**
! * Clones this {@code DynAny} object.
*
! * @return a copy of this {@code DynAny} object
*/
public org.omg.CORBA.DynAny copy() ;
/**
! * Inserts the given {@code boolean} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code boolean} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_boolean(boolean value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code byte} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code byte} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_octet(byte value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code char} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code char} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_char(char value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code short} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code short} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_short(short value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code short} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code short} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_ushort(short value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code int} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code int} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_long(int value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code int} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code int} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_ulong(int value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code float} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code float} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_float(float value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code double} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code double} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_double(double value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code String} object as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code String} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_string(String value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code org.omg.CORBA.Object} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code org.omg.CORBA.Object} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_reference(org.omg.CORBA.Object value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code org.omg.CORBA.TypeCode} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code org.omg.CORBA.TypeCode} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_typecode(org.omg.CORBA.TypeCode value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code long} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code long} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_longlong(long value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code long} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code long} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_ulonglong(long value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code char} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code char} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_wchar(char value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code String} as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code String} to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_wstring(String value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Inserts the given {@code org.omg.CORBA.Any} object as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code org.omg.CORBA.Any} object to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_any(org.omg.CORBA.Any value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
// orbos 98-01-18: Objects By Value -- begin
/**
! * Inserts the given {@code java.io.Serializable} object as the value for this
! * {@code DynAny} object.
*
! * <p> If this method is called on a constructed {@code DynAny}
* object, it initializes the next component of the constructed data
! * value associated with this {@code DynAny} object.
*
! * @param value the {@code java.io.Serializable} object to insert into this
! * {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
! * of the accessed component in this {@code DynAny} object
*/
public void insert_val(java.io.Serializable value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
! * Retrieves the {@code java.io.Serializable} object contained
! * in this {@code DynAny} object.
*
! * @return the {@code java.io.Serializable} object that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code java.io.Serializable} object
*/
public java.io.Serializable get_val()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
// orbos 98-01-18: Objects By Value -- end
/**
! * Retrieves the {@code boolean} contained
! * in this {@code DynAny} object.
*
! * @return the {@code boolean} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code boolean}
*/
public boolean get_boolean()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code byte} contained
! * in this {@code DynAny} object.
*
! * @return the {@code byte} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code byte}
*/
public byte get_octet()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code char} contained
! * in this {@code DynAny} object.
*
! * @return the {@code char} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code char}
*/
public char get_char()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code short} contained
! * in this {@code DynAny} object.
*
! * @return the {@code short} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code short}
*/
public short get_short()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code short} contained
! * in this {@code DynAny} object.
*
! * @return the {@code short} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code short}
*/
public short get_ushort()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code int} contained
! * in this {@code DynAny} object.
*
! * @return the {@code int} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code int}
*/
public int get_long()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code int} contained
! * in this {@code DynAny} object.
*
! * @return the {@code int} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code int}
*/
public int get_ulong()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code float} contained
! * in this {@code DynAny} object.
*
! * @return the {@code float} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code float}
*/
public float get_float()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code double} contained
! * in this {@code DynAny} object.
*
! * @return the {@code double} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code double}
*/
public double get_double()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code String} contained
! * in this {@code DynAny} object.
*
! * @return the {@code String} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code String}
*/
public String get_string()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code org.omg.CORBA.Other} contained
! * in this {@code DynAny} object.
*
! * @return the {@code org.omg.CORBA.Other} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for an {@code org.omg.CORBA.Other}
*/
public org.omg.CORBA.Object get_reference()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code org.omg.CORBA.TypeCode} contained
! * in this {@code DynAny} object.
*
! * @return the {@code org.omg.CORBA.TypeCode} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code org.omg.CORBA.TypeCode}
*/
public org.omg.CORBA.TypeCode get_typecode()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code long} contained
! * in this {@code DynAny} object.
*
! * @return the {@code long} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code long}
*/
public long get_longlong()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code long} contained
! * in this {@code DynAny} object.
*
! * @return the {@code long} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code long}
*/
public long get_ulonglong()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code char} contained
! * in this {@code DynAny} object.
*
! * @return the {@code char} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code char}
*/
public char get_wchar()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code String} contained
! * in this {@code DynAny} object.
*
! * @return the {@code String} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for a {@code String}
*/
public String get_wstring()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Retrieves the {@code org.omg.CORBA.Any} contained
! * in this {@code DynAny} object.
*
! * @return the {@code org.omg.CORBA.Any} that is the
! * value for this {@code DynAny} object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
! * {@code DynAny} object is not equivalent to
! * the type code for an {@code org.omg.CORBA.Any}
*/
public org.omg.CORBA.Any get_any()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
! * Returns a {@code DynAny} object reference that can
* be used to get/set the value of the component currently accessed.
! * The appropriate {@code insert} method
! * can be called on the resulting {@code DynAny} object
* to initialize the component.
! * The appropriate {@code get} method
! * can be called on the resulting {@code DynAny} object
* to extract the value of the component.
*
! * @return a {@code DynAny} object reference that can be
* used to retrieve or set the value of the component currently
* accessed
*/
public org.omg.CORBA.DynAny current_component() ;
/**
! * Moves to the next component of this {@code DynAny} object.
* This method is used for iterating through the components of
* a constructed type, effectively moving a pointer from one
* component to the next. The pointer starts out on the first
! * component when a {@code DynAny} object is created.
*
! * @return {@code true} if the pointer points to a component;
! * {@code false} if there are no more components or this
! * {@code DynAny} is associated with a basic type rather than
* a constructed type
*/
public boolean next() ;
/**
* Moves the internal pointer to the given index. Logically, this method
* sets a new offset for this pointer.
*
! * @param index an {@code int} indicating the position to which
* the pointer should move. The first position is 0.
! * @return {@code true} if the pointer points to a component;
! * {@code false} if there is no component at the designated
! * index. If this {@code DynAny} object is associated with a
! * basic type, this method returns {@code false} for any index
* other than 0.
*/
public boolean seek(int index) ;
/**
< prev index next >