DynValueOperations


1   package org.omg.DynamicAny;
2   
3   
4   /**
5   * org/omg/DynamicAny/DynValueOperations.java .
6   * Generated by the IDL-to-Java compiler (portable), version "3.2"
7   * from ../../../../src/share/classes/org/omg/DynamicAny/DynamicAny.idl
8   * Saturday, February 9, 2008 9:40:12 AM GMT
9   */
10  
11  
12  /**
13      * DynValue objects support the manipulation of IDL non-boxed value types.
14      * The DynValue interface can represent both null and non-null value types.
15      * For a DynValue representing a non-null value type, the DynValue's components comprise
16      * the public and private members of the value type, including those inherited from concrete base value types,
17      * in the order of definition. A DynValue representing a null value type has no components
18      * and a current position of -1.
19      * <P>Warning: Indiscriminantly changing the contents of private value type members can cause the value type
20      * implementation to break by violating internal constraints. Access to private members is provided to support
21      * such activities as ORB bridging and debugging and should not be used to arbitrarily violate
22      * the encapsulation of the value type. 
23      */
24  public interface DynValueOperations  extends org.omg.DynamicAny.DynValueCommonOperations  
25  {
26  
27    /**
28          * Returns the name of the member at the current position.
29          * This operation may return an empty string since the TypeCode of the value being
30          * manipulated may not contain the names of members.
31          *
32          * @exception TypeMismatch if the DynValue represents a null value type.
33          * @exception InvalidValue if the current position does not indicate a member
34          */
35    String   current_member_name () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch  , org.omg.DynamicAny.DynAnyPackage.InvalidValue  ;
36  
37    /**
38          * Returns the TCKind associated with the member at the current position.
39          *
40          * @exception TypeMismatch if the DynValue represents a null value type.
41          * @exception InvalidValue if the current position does not indicate a member
42          */
43    org.omg.CORBA.TCKind   current_member_kind () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch  , org.omg.DynamicAny.DynAnyPackage.InvalidValue  ;
44  
45    /**
46          * Returns a sequence of NameValuePairs describing the name and the value of each member
47          * in the value type.
48          * The sequence contains members in the same order as the declaration order of members
49          * as indicated by the DynValue's TypeCode. The current position is not affected.
50          * The member names in the returned sequence will be empty strings if the DynValue's TypeCode
51          * does not contain member names.
52          *
53          * @exception InvalidValue if this object represents a null value type
54          */
55    org.omg.DynamicAny.NameValuePair  [] get_members () throws org.omg.DynamicAny.DynAnyPackage.InvalidValue  ;
56  
57    /**
58          * Initializes the value type's members from a sequence of NameValuePairs.
59          * The operation sets the current position to zero if the passed sequences has non-zero length. Otherwise,
60          * if an empty sequence is passed, the current position is set to -1.
61          * A null value type can be initialized to a non-null value type using this method.
62          * <P>Members must appear in the NameValuePairs in the order in which they appear in the IDL specification
63          * of the value type as indicated by the DynValue's TypeCode or they must be empty strings.
64          * The operation makes no attempt to assign member values based on member names.
65          *
66          * @exception TypeMismatch if the member names supplied in the passed sequence do not match the
67          *            corresponding member name in the DynValue's TypeCode and they are not empty strings
68          * @exception InvalidValue if the passed sequence has a number of elements that disagrees
69          *            with the number of members as indicated by the DynValue's TypeCode
70          */
71    void set_members (org.omg.DynamicAny.NameValuePair  [] value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch  , org.omg.DynamicAny.DynAnyPackage.InvalidValue  ;
72  
73    /**
74          * Returns a sequence of NameDynAnyPairs describing the name and the value of each member
75          * in the value type.
76          * The sequence contains members in the same order as the declaration order of members
77          * as indicated by the DynValue's TypeCode. The current position is not affected.
78          * The member names in the returned sequence will be empty strings if the DynValue's TypeCode
79          * does not contain member names.
80          *
81          * @exception InvalidValue if this object represents a null value type
82          */
83    org.omg.DynamicAny.NameDynAnyPair  [] get_members_as_dyn_any () throws org.omg.DynamicAny.DynAnyPackage.InvalidValue  ;
84  
85    /**
86          * Initializes the value type's members from a sequence of NameDynAnyPairs.
87          * The operation sets the current position to zero if the passed sequences has non-zero length. Otherwise,
88          * if an empty sequence is passed, the current position is set to -1.
89          * A null value type can be initialized to a non-null value type using this method.
90          * <P>Members must appear in the NameDynAnyPairs in the order in which they appear in the IDL specification
91          * of the value type as indicated by the DynValue's TypeCode or they must be empty strings.
92          * The operation makes no attempt to assign member values based on member names.
93          *
94          * @exception TypeMismatch if the member names supplied in the passed sequence do not match the
95          *            corresponding member name in the DynValue's TypeCode and they are not empty strings
96          * @exception InvalidValue if the passed sequence has a number of elements that disagrees
97          *            with the number of members as indicated by the DynValue's TypeCode
98          */
99    void set_members_as_dyn_any (org.omg.DynamicAny.NameDynAnyPair  [] value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch  , org.omg.DynamicAny.DynAnyPackage.InvalidValue  ;
100 } // interface DynValueOperations
101
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags