org.omg.CORBA.DynAny Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
* v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License v2.0
* w/Classpath exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause OR GPL-2.0 WITH
* Classpath-exception-2.0
*/
package org.omg.CORBA;
/** Enables org.omg.CORBA.Any values to be dynamically
* interpreted (traversed) and
* constructed. A DynAny object is associated with a data value
* which may correspond to a copy of the value inserted into an Any.
* The 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 DynAny instead
*/
// @Deprecated
public interface DynAny extends org.omg.CORBA.Object
{
/**
* Returns the TypeCode of the object inserted into
* this DynAny.
*
* @return the TypeCode object.
*/
public org.omg.CORBA.TypeCode type() ;
/**
* Copy the contents from one Dynamic Any into another.
*
* @param dyn_any the DynAny object whose contents
* are assigned to this DynAny.
* @throws org.omg.CORBA.DynAnyPackage.Invalid if the source DynAny is
* invalid
*/
public void assign(org.omg.CORBA.DynAny dyn_any)
throws org.omg.CORBA.DynAnyPackage.Invalid;
/**
* Make a DynAny object from an Any
* object.
*
* @param value the Any object.
* @throws org.omg.CORBA.DynAnyPackage.Invalid if the source Any object is
* empty or bad
*/
public void from_any(org.omg.CORBA.Any value)
throws org.omg.CORBA.DynAnyPackage.Invalid;
/**
* Convert a DynAny object to an Any
* object.
*
* @return the Any object.
* @throws org.omg.CORBA.DynAnyPackage.Invalid if this 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 DynAny object and frees any resources
* used to represent the data value associated with it. This method
* also destroys all DynAny objects obtained from it.
*
* Destruction of DynAny objects should be handled with
* care, taking into account issues dealing with the representation of
* data values associated with DynAny objects. A programmer
* who wants to destroy a DynAny object but still be able
* to manipulate some component of the data value associated with it,
* should first create a DynAny object for the component
* and then make a copy of the created DynAny object.
*/
public void destroy() ;
/**
* Clones this DynAny object.
*
* @return a copy of this DynAny object
*/
public org.omg.CORBA.DynAny copy() ;
/**
* Inserts the given boolean as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the boolean to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_boolean(boolean value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given byte as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the byte to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_octet(byte value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given char as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the char to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_char(char value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given short as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the short to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_short(short value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given short as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the short to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_ushort(short value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given int as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the int to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_long(int value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given int as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the int to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_ulong(int value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given float as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the float to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_float(float value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given double as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the double to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_double(double value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given String object as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the String to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_string(String value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given org.omg.CORBA.Object as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the org.omg.CORBA.Object to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_reference(org.omg.CORBA.Object value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given org.omg.CORBA.TypeCode as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the org.omg.CORBA.TypeCode to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_typecode(org.omg.CORBA.TypeCode value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given long as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the long to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_longlong(long value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given long as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the long to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_ulonglong(long value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given char as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the char to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_wchar(char value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given String as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the String to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_wstring(String value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Inserts the given org.omg.CORBA.Any object as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the org.omg.CORBA.Any object to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this 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 java.io.Serializable object as the value for this
* DynAny object.
*
*
If this method is called on a constructed DynAny
* object, it initializes the next component of the constructed data
* value associated with this DynAny object.
*
* @param value the java.io.Serializable object to insert into this
* DynAny object
* @throws org.omg.CORBA.DynAnyPackage.InvalidValue
* if the value inserted is not consistent with the type
* of the accessed component in this DynAny object
*/
public void insert_val(java.io.Serializable value)
throws org.omg.CORBA.DynAnyPackage.InvalidValue;
/**
* Retrieves the java.io.Serializable object contained
* in this DynAny object.
*
* @return the java.io.Serializable object that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a 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 boolean contained
* in this DynAny object.
*
* @return the boolean that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a boolean
*/
public boolean get_boolean()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the byte contained
* in this DynAny object.
*
* @return the byte that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a byte
*/
public byte get_octet()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the char contained
* in this DynAny object.
*
* @return the char that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a char
*/
public char get_char()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the short contained
* in this DynAny object.
*
* @return the short that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a short
*/
public short get_short()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the short contained
* in this DynAny object.
*
* @return the short that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a short
*/
public short get_ushort()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the int contained
* in this DynAny object.
*
* @return the int that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a int
*/
public int get_long()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the int contained
* in this DynAny object.
*
* @return the int that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a int
*/
public int get_ulong()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the float contained
* in this DynAny object.
*
* @return the float that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a float
*/
public float get_float()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the double contained
* in this DynAny object.
*
* @return the double that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a double
*/
public double get_double()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the String contained
* in this DynAny object.
*
* @return the String that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a String
*/
public String get_string()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the org.omg.CORBA.Other contained
* in this DynAny object.
*
* @return the org.omg.CORBA.Other that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for an org.omg.CORBA.Other
*/
public org.omg.CORBA.Object get_reference()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the org.omg.CORBA.TypeCode contained
* in this DynAny object.
*
* @return the org.omg.CORBA.TypeCode that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a org.omg.CORBA.TypeCode
*/
public org.omg.CORBA.TypeCode get_typecode()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the long contained
* in this DynAny object.
*
* @return the long that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a long
*/
public long get_longlong()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the long contained
* in this DynAny object.
*
* @return the long that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a long
*/
public long get_ulonglong()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the char contained
* in this DynAny object.
*
* @return the char that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a char
*/
public char get_wchar()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the String contained
* in this DynAny object.
*
* @return the String that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for a String
*/
public String get_wstring()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Retrieves the org.omg.CORBA.Any contained
* in this DynAny object.
*
* @return the org.omg.CORBA.Any that is the
* value for this DynAny object
* @throws org.omg.CORBA.DynAnyPackage.TypeMismatch
* if the type code of the accessed component in this
* DynAny object is not equivalent to
* the type code for an org.omg.CORBA.Any
*/
public org.omg.CORBA.Any get_any()
throws org.omg.CORBA.DynAnyPackage.TypeMismatch;
/**
* Returns a DynAny object reference that can
* be used to get/set the value of the component currently accessed.
* The appropriate insert method
* can be called on the resulting DynAny object
* to initialize the component.
* The appropriate get method
* can be called on the resulting DynAny object
* to extract the value of the component.
*
* @return a 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 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 DynAny object is created.
*
* @return true if the pointer points to a component;
* false if there are no more components or this
* 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 int indicating the position to which
* the pointer should move. The first position is 0.
* @return true if the pointer points to a component;
* false if there is no component at the designated
* index. If this DynAny object is associated with a
* basic type, this method returns false for any index
* other than 0.
*/
public boolean seek(int index) ;
/**
* Moves the internal pointer to the first component.
*/
public void rewind() ;
}