DynUnion.java revision 157
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Copyright (c) 1998, 2004, Oracle and/or its affiliates. All rights reserved.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * This code is free software; you can redistribute it and/or modify it
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * under the terms of the GNU General Public License version 2 only, as
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * published by the Free Software Foundation. Oracle designates this
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * particular file as subject to the "Classpath" exception as provided
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * by Oracle in the LICENSE file that accompanied this code.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * This code is distributed in the hope that it will be useful, but WITHOUT
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * version 2 for more details (a copy is included in the LICENSE file that
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * accompanied this code).
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * You should have received a copy of the GNU General Public License version
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * 2 along with this work; if not, write to the Free Software Foundation,
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * or visit www.oracle.com if you need additional information or have any
f38cb554a534c6df738be3f4d23327e69888e634John Wren Kennedy * The <code>DynUnion</code> interface represents a <code>DynAny</code> object
f38cb554a534c6df738be3f4d23327e69888e634John Wren Kennedy * that is associated with an IDL union.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Union values can be traversed using the operations defined in <code>DynAny</code>.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * The first component in the union corresponds to the discriminator;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * the second corresponds to the actual value of the union.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Calling the method <code>next()</code> twice allows you to access both components.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * @deprecated Use the new <a href="../DynamicAny/DynUnion.html">DynUnion</a> instead
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedypublic interface DynUnion extends org.omg.CORBA.Object, org.omg.CORBA.DynAny
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Determines whether the discriminator associated with this union has been assigned
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * a valid default value.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * @return <code>true</code> if the discriminator has a default value;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * <code>false</code> otherwise
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy public boolean set_as_default();
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Determines whether the discriminator associated with this union gets assigned
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * a valid default value.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * @param arg <code>true</code> if the discriminator gets assigned a default value
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Returns a DynAny object reference that must be narrowed to the type
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * of the discriminator in order to insert/get the discriminator value.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * @return a <code>DynAny</code> object reference representing the discriminator value
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy public org.omg.CORBA.DynAny discriminator();
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Returns the TCKind object associated with the discriminator of this union.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * @return the <code>TCKind</code> object associated with the discriminator of this union
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy public org.omg.CORBA.TCKind discriminator_kind();
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Returns a DynAny object reference that is used in order to insert/get
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * a member of this union.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * @return the <code>DynAny</code> object representing a member of this union
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Allows for the inspection of the name of this union member
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * without checking the value of the discriminator.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * @return the name of this union member
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Allows for the assignment of the name of this union member.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * @param arg the new name of this union member
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Returns the TCKind associated with the member of this union.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * @return the <code>TCKind</code> object associated with the member of this union