src/share/classes/org/omg/CORBA/StringHolder.java

Print this page
rev 597 : 8047722: @since tag cleanup in corba
Reviewed-by:


  30 import org.omg.CORBA.portable.OutputStream;
  31 
  32 /**
  33  * The Holder for <tt>String</tt>.  For more information on
  34  * Holder files, see <a href="doc-files/generatedfiles.html#holder">
  35  * "Generated Files: Holder Files"</a>.<P>
  36  * A Holder class for a <code>String</code>
  37  * that is used to store "out" and "inout" parameters in IDL operations.
  38  * If an IDL operation signature has an IDL <code>string</code> as an "out"
  39  * or "inout" parameter, the programmer must pass an instance of
  40  * <code>StringHolder</code> as the corresponding
  41  * parameter in the method invocation; for "inout" parameters, the programmer
  42  * must also fill the "in" value to be sent to the server.
  43  * Before the method invocation returns, the ORB will fill in the
  44  * value corresponding to the "out" value returned from the server.
  45  * <P>
  46  * If <code>myStringHolder</code> is an instance of <code>StringHolder</code>,
  47  * the value stored in its <code>value</code> field can be accessed with
  48  * <code>myStringHolder.value</code>.
  49  *
  50  * @since       JDK1.2
  51  */
  52 public final class StringHolder implements Streamable {
  53 
  54     /**
  55      * The <code>String</code> value held by this <code>StringHolder</code>
  56      * object.
  57      */
  58     public String value;
  59 
  60     /**
  61      * Constructs a new <code>StringHolder</code> object with its
  62      * <code>value</code> field initialized to <code>null</code>.
  63      */
  64     public StringHolder() {
  65     }
  66 
  67     /**
  68      * Constructs a new <code>StringHolder</code> object with its
  69      * <code>value</code> field initialized to the given
  70      * <code>String</code>.




  30 import org.omg.CORBA.portable.OutputStream;
  31 
  32 /**
  33  * The Holder for <tt>String</tt>.  For more information on
  34  * Holder files, see <a href="doc-files/generatedfiles.html#holder">
  35  * "Generated Files: Holder Files"</a>.<P>
  36  * A Holder class for a <code>String</code>
  37  * that is used to store "out" and "inout" parameters in IDL operations.
  38  * If an IDL operation signature has an IDL <code>string</code> as an "out"
  39  * or "inout" parameter, the programmer must pass an instance of
  40  * <code>StringHolder</code> as the corresponding
  41  * parameter in the method invocation; for "inout" parameters, the programmer
  42  * must also fill the "in" value to be sent to the server.
  43  * Before the method invocation returns, the ORB will fill in the
  44  * value corresponding to the "out" value returned from the server.
  45  * <P>
  46  * If <code>myStringHolder</code> is an instance of <code>StringHolder</code>,
  47  * the value stored in its <code>value</code> field can be accessed with
  48  * <code>myStringHolder.value</code>.
  49  *
  50  * @since       1.2
  51  */
  52 public final class StringHolder implements Streamable {
  53 
  54     /**
  55      * The <code>String</code> value held by this <code>StringHolder</code>
  56      * object.
  57      */
  58     public String value;
  59 
  60     /**
  61      * Constructs a new <code>StringHolder</code> object with its
  62      * <code>value</code> field initialized to <code>null</code>.
  63      */
  64     public StringHolder() {
  65     }
  66 
  67     /**
  68      * Constructs a new <code>StringHolder</code> object with its
  69      * <code>value</code> field initialized to the given
  70      * <code>String</code>.