corba/src/java.corba/share/classes/org/omg/CORBA/PrincipalHolder.java
changeset 32688 936c391804a5
parent 25862 a5e25d68f971
equal deleted inserted replaced
32550:6521875cb63e 32688:936c391804a5
    29 import org.omg.CORBA.portable.InputStream;
    29 import org.omg.CORBA.portable.InputStream;
    30 import org.omg.CORBA.portable.OutputStream;
    30 import org.omg.CORBA.portable.OutputStream;
    31 
    31 
    32 
    32 
    33 /**
    33 /**
    34  * The Holder for <tt>Principal</tt>.  For more information on
    34  * The Holder for {@code Principal}. For more information on
    35  * Holder files, see <a href="doc-files/generatedfiles.html#holder">
    35  * Holder files, see <a href="doc-files/generatedfiles.html#holder">
    36  * "Generated Files: Holder Files"</a>.<P>
    36  * "Generated Files: Holder Files"</a>.<P>
    37  * A container class for values of type <code>Principal</code>
    37  * A container class for values of type {@code Principal}
    38  * that is used to store "out" and "inout" parameters in IDL methods.
    38  * that is used to store "out" and "inout" parameters in IDL methods.
    39  * If an IDL method signature has an IDL <code>Principal</code> as an "out"
    39  * If an IDL method signature has an IDL {@code Principal} as an "out"
    40  * or "inout" parameter, the programmer must pass an instance of
    40  * or "inout" parameter, the programmer must pass an instance of
    41  * <code>PrincipalHolder</code> as the corresponding
    41  * {@code PrincipalHolder} as the corresponding
    42  * parameter in the method invocation; for "inout" parameters, the programmer
    42  * parameter in the method invocation; for "inout" parameters, the programmer
    43  * must also fill the "in" value to be sent to the server.
    43  * must also fill the "in" value to be sent to the server.
    44  * Before the method invocation returns, the ORB will fill in the
    44  * Before the method invocation returns, the ORB will fill in the
    45  * value corresponding to the "out" value returned from the server.
    45  * value corresponding to the "out" value returned from the server.
    46  * <P>
    46  * <P>
    47  * If <code>myPrincipalHolder</code> is an instance of <code>PrincipalHolder</code>,
    47  * If {@code myPrincipalHolder} is an instance of {@code PrincipalHolder},
    48  * the value stored in its <code>value</code> field can be accessed with
    48  * the value stored in its {@code value} field can be accessed with
    49  * <code>myPrincipalHolder.value</code>.
    49  * {@code myPrincipalHolder.value}.
    50  *
    50  *
    51  * @since       JDK1.2
    51  * @since       JDK1.2
    52  * @deprecated Deprecated by CORBA 2.2.
    52  * @deprecated Deprecated by CORBA 2.2.
    53  */
    53  */
    54 @Deprecated
    54 @Deprecated
    55 public final class PrincipalHolder implements Streamable {
    55 public final class PrincipalHolder implements Streamable {
    56     /**
    56     /**
    57      * The <code>Principal</code> value held by this <code>PrincipalHolder</code>
    57      * The {@code Principal} value held by this {@code PrincipalHolder}
    58      * object.
    58      * object.
    59      */
    59      */
    60     public Principal value;
    60     public Principal value;
    61 
    61 
    62     /**
    62     /**
    63      * Constructs a new <code>PrincipalHolder</code> object with its
    63      * Constructs a new {@code PrincipalHolder} object with its
    64      * <code>value</code> field initialized to <code>null</code>.
    64      * {@code value} field initialized to {@code null}.
    65      */
    65      */
    66     public PrincipalHolder() {
    66     public PrincipalHolder() {
    67     }
    67     }
    68 
    68 
    69     /**
    69     /**
    70      * Constructs a new <code>PrincipalHolder</code> object with its
    70      * Constructs a new {@code PrincipalHolder} object with its
    71      * <code>value</code> field initialized to the given
    71      * {@code value} field initialized to the given
    72      * <code>Principal</code> object.
    72      * {@code Principal} object.
    73      * @param initial the <code>Principal</code> with which to initialize
    73      * @param initial the {@code Principal} with which to initialize
    74      *                the <code>value</code> field of the newly-created
    74      *                the {@code value} field of the newly-created
    75      *                <code>PrincipalHolder</code> object
    75      *                {@code PrincipalHolder} object
    76      */
    76      */
    77     public PrincipalHolder(Principal initial) {
    77     public PrincipalHolder(Principal initial) {
    78         value = initial;
    78         value = initial;
    79     }
    79     }
    80 
    80