KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > omg > CORBA > DynUnion


1 /*
2  * @(#)DynUnion.java 1.16 04/05/18
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */

7
8
9 package org.omg.CORBA;
10
11 /**
12  * The <code>DynUnion</code> interface represents a <code>DynAny</code> object
13  * that is associated with an IDL union.
14  * Union values can be traversed using the operations defined in <code>DynAny</code>.
15  * The first component in the union corresponds to the discriminator;
16  * the second corresponds to the actual value of the union.
17  * Calling the method <code>next()</code> twice allows you to access both components.
18  * @deprecated Use the new <a HREF="../DynamicAny/DynUnion.html">DynUnion</a> instead
19  */

20 @Deprecated JavaDoc
21 public interface DynUnion extends org.omg.CORBA.Object JavaDoc, org.omg.CORBA.DynAny JavaDoc
22 {
23     /**
24      * Determines whether the discriminator associated with this union has been assigned
25      * a valid default value.
26      * @return <code>true</code> if the discriminator has a default value;
27      * <code>false</code> otherwise
28      */

29     public boolean set_as_default();
30
31     /**
32     * Determines whether the discriminator associated with this union gets assigned
33     * a valid default value.
34     * @param arg <code>true</code> if the discriminator gets assigned a default value
35     */

36     public void set_as_default(boolean arg);
37
38     /**
39     * Returns a DynAny object reference that must be narrowed to the type
40     * of the discriminator in order to insert/get the discriminator value.
41     * @return a <code>DynAny</code> object reference representing the discriminator value
42     */

43     public org.omg.CORBA.DynAny JavaDoc discriminator();
44
45     /**
46     * Returns the TCKind object associated with the discriminator of this union.
47     * @return the <code>TCKind</code> object associated with the discriminator of this union
48     */

49     public org.omg.CORBA.TCKind JavaDoc discriminator_kind();
50
51     /**
52     * Returns a DynAny object reference that is used in order to insert/get
53     * a member of this union.
54     * @return the <code>DynAny</code> object representing a member of this union
55     */

56     public org.omg.CORBA.DynAny JavaDoc member();
57
58     /**
59     * Allows for the inspection of the name of this union member
60     * without checking the value of the discriminator.
61     * @return the name of this union member
62     */

63     public String JavaDoc member_name();
64
65     /**
66     * Allows for the assignment of the name of this union member.
67     * @param arg the new name of this union member
68     */

69     public void member_name(String JavaDoc arg);
70
71     /**
72     * Returns the TCKind associated with the member of this union.
73     * @return the <code>TCKind</code> object associated with the member of this union
74     */

75     public org.omg.CORBA.TCKind JavaDoc member_kind();
76 }
77
Popular Tags