/* * Copyright (c) 1998, 2004, Oracle and/or its affiliates. All rights reserved. * 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 * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * 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. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ 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 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() ; }