duke@1: /* ohair@158: * Copyright (c) 1998, 2004, Oracle and/or its affiliates. All rights reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as ohair@158: * published by the Free Software Foundation. Oracle designates this duke@1: * particular file as subject to the "Classpath" exception as provided ohair@158: * by Oracle in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * ohair@158: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA ohair@158: * or visit www.oracle.com if you need additional information or have any ohair@158: * questions. duke@1: */ duke@1: duke@1: duke@1: package org.omg.CORBA; duke@1: duke@1: duke@1: /** Enables org.omg.CORBA.Any values to be dynamically duke@1: * interpreted (traversed) and duke@1: * constructed. A DynAny object is associated with a data value duke@1: * which may correspond to a copy of the value inserted into an Any. duke@1: * The DynAny APIs enable traversal of the data value associated with an duke@1: * Any at runtime and extraction of the primitive constituents of the duke@1: * data value. duke@1: * @deprecated Use the new DynAny instead duke@1: */ duke@1: @Deprecated duke@1: public interface DynAny extends org.omg.CORBA.Object duke@1: { duke@1: /** duke@1: * Returns the TypeCode of the object inserted into duke@1: * this DynAny. duke@1: * duke@1: * @return the TypeCode object. duke@1: */ duke@1: public org.omg.CORBA.TypeCode type() ; duke@1: duke@1: /** duke@1: * Copy the contents from one Dynamic Any into another. duke@1: * duke@1: * @param dyn_any the DynAny object whose contents duke@1: * are assigned to this DynAny. duke@1: * @throws Invalid if the source DynAny is duke@1: * invalid duke@1: */ duke@1: public void assign(org.omg.CORBA.DynAny dyn_any) duke@1: throws org.omg.CORBA.DynAnyPackage.Invalid; duke@1: duke@1: /** duke@1: * Make a DynAny object from an Any duke@1: * object. duke@1: * duke@1: * @param value the Any object. duke@1: * @throws Invalid if the source Any object is duke@1: * empty or bad duke@1: */ duke@1: public void from_any(org.omg.CORBA.Any value) duke@1: throws org.omg.CORBA.DynAnyPackage.Invalid; duke@1: duke@1: /** duke@1: * Convert a DynAny object to an Any duke@1: * object. duke@1: * duke@1: * @return the Any object. duke@1: * @throws Invalid if this DynAny is empty or duke@1: * bad. duke@1: * created or does not contain a meaningful value duke@1: */ duke@1: public org.omg.CORBA.Any to_any() duke@1: throws org.omg.CORBA.DynAnyPackage.Invalid; duke@1: duke@1: /** duke@1: * Destroys this DynAny object and frees any resources duke@1: * used to represent the data value associated with it. This method duke@1: * also destroys all DynAny objects obtained from it. duke@1: *

duke@1: * Destruction of DynAny objects should be handled with duke@1: * care, taking into account issues dealing with the representation of duke@1: * data values associated with DynAny objects. A programmer duke@1: * who wants to destroy a DynAny object but still be able duke@1: * to manipulate some component of the data value associated with it, duke@1: * should first create a DynAny object for the component duke@1: * and then make a copy of the created DynAny object. duke@1: */ duke@1: public void destroy() ; duke@1: duke@1: /** duke@1: * Clones this DynAny object. duke@1: * duke@1: * @return a copy of this DynAny object duke@1: */ duke@1: public org.omg.CORBA.DynAny copy() ; duke@1: duke@1: /** duke@1: * Inserts the given boolean as the value for this duke@1: * DynAny object. duke@1: * duke@1: *

If this method is called on a constructed DynAny duke@1: * object, it initializes the next component of the constructed data duke@1: * value associated with this DynAny object. duke@1: * duke@1: * @param value the java.io.Serializable object to insert into this duke@1: * DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.InvalidValue duke@1: * if the value inserted is not consistent with the type duke@1: * of the accessed component in this DynAny object duke@1: */ duke@1: public void insert_val(java.io.Serializable value) duke@1: throws org.omg.CORBA.DynAnyPackage.InvalidValue; duke@1: duke@1: /** duke@1: * Retrieves the java.io.Serializable object contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the java.io.Serializable object that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a java.io.Serializable object duke@1: */ duke@1: public java.io.Serializable get_val() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: // orbos 98-01-18: Objects By Value -- end duke@1: duke@1: /** duke@1: * Retrieves the boolean contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the boolean that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a boolean duke@1: */ duke@1: public boolean get_boolean() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the byte contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the byte that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a byte duke@1: */ duke@1: public byte get_octet() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: /** duke@1: * Retrieves the char contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the char that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a char duke@1: */ duke@1: public char get_char() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the short contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the short that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a short duke@1: */ duke@1: public short get_short() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the short contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the short that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a short duke@1: */ duke@1: public short get_ushort() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the int contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the int that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a int duke@1: */ duke@1: public int get_long() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the int contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the int that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a int duke@1: */ duke@1: public int get_ulong() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the float contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the float that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a float duke@1: */ duke@1: public float get_float() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the double contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the double that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a double duke@1: */ duke@1: public double get_double() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the String contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the String that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a String duke@1: */ duke@1: public String get_string() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the org.omg.CORBA.Other contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the org.omg.CORBA.Other that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for an org.omg.CORBA.Other duke@1: */ duke@1: public org.omg.CORBA.Object get_reference() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the org.omg.CORBA.TypeCode contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the org.omg.CORBA.TypeCode that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a org.omg.CORBA.TypeCode duke@1: */ duke@1: public org.omg.CORBA.TypeCode get_typecode() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the long contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the long that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a long duke@1: */ duke@1: public long get_longlong() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the long contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the long that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a long duke@1: */ duke@1: public long get_ulonglong() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the char contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the char that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a char duke@1: */ duke@1: public char get_wchar() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the String contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the String that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for a String duke@1: */ duke@1: public String get_wstring() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: duke@1: /** duke@1: * Retrieves the org.omg.CORBA.Any contained duke@1: * in this DynAny object. duke@1: * duke@1: * @return the org.omg.CORBA.Any that is the duke@1: * value for this DynAny object duke@1: * @throws org.omg.CORBA.DynAnyPackage.TypeMismatch duke@1: * if the type code of the accessed component in this duke@1: * DynAny object is not equivalent to duke@1: * the type code for an org.omg.CORBA.Any duke@1: */ duke@1: public org.omg.CORBA.Any get_any() duke@1: throws org.omg.CORBA.DynAnyPackage.TypeMismatch; duke@1: duke@1: /** duke@1: * Returns a DynAny object reference that can duke@1: * be used to get/set the value of the component currently accessed. duke@1: * The appropriate insert method duke@1: * can be called on the resulting DynAny object duke@1: * to initialize the component. duke@1: * The appropriate get method duke@1: * can be called on the resulting DynAny object duke@1: * to extract the value of the component. duke@1: * duke@1: * @return a DynAny object reference that can be duke@1: * used to retrieve or set the value of the component currently duke@1: * accessed duke@1: */ duke@1: public org.omg.CORBA.DynAny current_component() ; duke@1: duke@1: /** duke@1: * Moves to the next component of this DynAny object. duke@1: * This method is used for iterating through the components of duke@1: * a constructed type, effectively moving a pointer from one duke@1: * component to the next. The pointer starts out on the first duke@1: * component when a DynAny object is created. duke@1: * duke@1: * @return true if the pointer points to a component; duke@1: * false if there are no more components or this duke@1: * DynAny is associated with a basic type rather than duke@1: * a constructed type duke@1: */ duke@1: public boolean next() ; duke@1: duke@1: /** duke@1: * Moves the internal pointer to the given index. Logically, this method duke@1: * sets a new offset for this pointer. duke@1: * duke@1: * @param index an int indicating the position to which duke@1: * the pointer should move. The first position is 0. duke@1: * @return true if the pointer points to a component; duke@1: * false if there is no component at the designated duke@1: * index. If this DynAny object is associated with a duke@1: * basic type, this method returns false for any index duke@1: * other than 0. duke@1: */ duke@1: public boolean seek(int index) ; duke@1: duke@1: /** duke@1: * Moves the internal pointer to the first component. duke@1: */ duke@1: public void rewind() ; duke@1: }