src/java.corba/share/classes/org/omg/CORBA/ValueBaseHolder.java

*** 28,103 ****
  import org.omg.CORBA.portable.Streamable;
  import org.omg.CORBA.portable.InputStream;
  import org.omg.CORBA.portable.OutputStream;
  
  /**
!  * The Holder for <tt>ValueBase</tt>.  For more information on
   * Holder files, see <a href="doc-files/generatedfiles.html#holder">
   * "Generated Files: Holder Files"</a>.<P>
!  * A Holder class for a <code>java.io.Serializable</code>
   * that is used to store "out" and "inout" parameters in IDL methods.
!  * If an IDL method signature has an IDL <code>ValueBase</code> as an "out"
   * or "inout" parameter, the programmer must pass an instance of
!  * <code>ValueBaseHolder</code> as the corresponding
   * parameter in the method invocation; for "inout" parameters, the programmer
   * must also fill the "in" value to be sent to the server.
   * Before the method invocation returns, the ORB will fill in the
   * value corresponding to the "out" value returned from the server.
   * <P>
!  * If <code>myValueBaseHolder</code> is an instance of <code>ValueBaseHolder</code>,
!  * the value stored in its <code>value</code> field can be accessed with
!  * <code>myValueBaseHolder.value</code>.
   *
   */
  public final class ValueBaseHolder implements Streamable {
  
      /**
!      * The <code>java.io.Serializable</code> value held by this
!      * <code>ValueBaseHolder</code> object.
       */
      public java.io.Serializable value;
  
      /**
!      * Constructs a new <code>ValueBaseHolder</code> object with its
!      * <code>value</code> field initialized to <code>0</code>.
       */
      public ValueBaseHolder() {
      }
  
      /**
!      * Constructs a new <code>ValueBaseHolder</code> object with its
!      * <code>value</code> field initialized to the given
!      * <code>java.io.Serializable</code>.
!      * @param initial the <code>java.io.Serializable</code> with which to initialize
!      *                the <code>value</code> field of the newly-created
!      *                <code>ValueBaseHolder</code> object
       */
      public ValueBaseHolder(java.io.Serializable initial) {
          value = initial;
      }
  
      /**
!      * Reads from <code>input</code> and initalizes the value in the Holder
       * with the unmarshalled data.
       *
       * @param input the InputStream containing CDR formatted data from the wire
       */
      public void _read(InputStream input) {
          value = ((org.omg.CORBA_2_3.portable.InputStream)input).read_value();
      }
  
      /**
!      * Marshals to <code>output</code> the value in the Holder.
       *
       * @param output the OutputStream which will contain the CDR formatted data
       */
      public void _write(OutputStream output) {
          ((org.omg.CORBA_2_3.portable.OutputStream)output).write_value(value);
      }
  
      /**
!      * Returns the <code>TypeCode</code> object
       * corresponding to the value held in the Holder.
       *
       * @return    the TypeCode of the value held in the holder
       */
      public org.omg.CORBA.TypeCode _type() {
--- 28,103 ----
  import org.omg.CORBA.portable.Streamable;
  import org.omg.CORBA.portable.InputStream;
  import org.omg.CORBA.portable.OutputStream;
  
  /**
!  * The Holder for {@code ValueBase}.  For more information on
   * Holder files, see <a href="doc-files/generatedfiles.html#holder">
   * "Generated Files: Holder Files"</a>.<P>
!  * A Holder class for a {@code java.io.Serializable}
   * that is used to store "out" and "inout" parameters in IDL methods.
!  * If an IDL method signature has an IDL {@code ValueBase} as an "out"
   * or "inout" parameter, the programmer must pass an instance of
!  * {@code ValueBaseHolder} as the corresponding
   * parameter in the method invocation; for "inout" parameters, the programmer
   * must also fill the "in" value to be sent to the server.
   * Before the method invocation returns, the ORB will fill in the
   * value corresponding to the "out" value returned from the server.
   * <P>
!  * If {@code myValueBaseHolder} is an instance of {@code ValueBaseHolder},
!  * the value stored in its {@code value} field can be accessed with
!  * {@code myValueBaseHolder.value}.
   *
   */
  public final class ValueBaseHolder implements Streamable {
  
      /**
!      * The {@code java.io.Serializable} value held by this
!      * {@code ValueBaseHolder} object.
       */
      public java.io.Serializable value;
  
      /**
!      * Constructs a new {@code ValueBaseHolder} object with its
!      * {@code value} field initialized to {@code 0}.
       */
      public ValueBaseHolder() {
      }
  
      /**
!      * Constructs a new {@code ValueBaseHolder} object with its
!      * {@code value} field initialized to the given
!      * {@code java.io.Serializable}.
!      * @param initial the {@code java.io.Serializable} with which to initialize
!      *                the {@code value} field of the newly-created
!      *                {@code ValueBaseHolder} object
       */
      public ValueBaseHolder(java.io.Serializable initial) {
          value = initial;
      }
  
      /**
!      * Reads from {@code input} and initalizes the value in the Holder
       * with the unmarshalled data.
       *
       * @param input the InputStream containing CDR formatted data from the wire
       */
      public void _read(InputStream input) {
          value = ((org.omg.CORBA_2_3.portable.InputStream)input).read_value();
      }
  
      /**
!      * Marshals to {@code output} the value in the Holder.
       *
       * @param output the OutputStream which will contain the CDR formatted data
       */
      public void _write(OutputStream output) {
          ((org.omg.CORBA_2_3.portable.OutputStream)output).write_value(value);
      }
  
      /**
!      * Returns the {@code TypeCode} object
       * corresponding to the value held in the Holder.
       *
       * @return    the TypeCode of the value held in the holder
       */
      public org.omg.CORBA.TypeCode _type() {