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

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


  31 
  32 
  33 /**
  34  * The Holder for <tt>Float</tt>.  For more information on
  35  * Holder files, see <a href="doc-files/generatedfiles.html#holder">
  36  * "Generated Files: Holder Files"</a>.<P>
  37  * A Holder class for a <code>float</code>
  38  * that is used to store "out" and "inout" parameters in IDL methods.
  39  * If an IDL method signature has an IDL <code>float</code> as an "out"
  40  * or "inout" parameter, the programmer must pass an instance of
  41  * <code>FloatHolder</code> as the corresponding
  42  * parameter in the method invocation; for "inout" parameters, the programmer
  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
  45  * value corresponding to the "out" value returned from the server.
  46  * <P>
  47  * If <code>myFloatHolder</code> is an instance of <code>FloatHolder</code>,
  48  * the value stored in its <code>value</code> field can be accessed with
  49  * <code>myFloatHolder.value</code>.
  50  *
  51  * @since       JDK1.2
  52  */
  53 public final class FloatHolder implements Streamable {
  54     /**
  55      * The <code>float</code> value held by this <code>FloatHolder</code>
  56      * object.
  57      */
  58     public float value;
  59 
  60     /**
  61      * Constructs a new <code>FloatHolder</code> object with its
  62      * <code>value</code> field initialized to 0.0.
  63      */
  64     public FloatHolder() {
  65     }
  66 
  67     /**
  68      * Constructs a new <code>FloatHolder</code> object for the given
  69      * <code>float</code>.
  70      * @param initial the <code>float</code> with which to initialize
  71      *                the <code>value</code> field of the new




  31 
  32 
  33 /**
  34  * The Holder for <tt>Float</tt>.  For more information on
  35  * Holder files, see <a href="doc-files/generatedfiles.html#holder">
  36  * "Generated Files: Holder Files"</a>.<P>
  37  * A Holder class for a <code>float</code>
  38  * that is used to store "out" and "inout" parameters in IDL methods.
  39  * If an IDL method signature has an IDL <code>float</code> as an "out"
  40  * or "inout" parameter, the programmer must pass an instance of
  41  * <code>FloatHolder</code> as the corresponding
  42  * parameter in the method invocation; for "inout" parameters, the programmer
  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
  45  * value corresponding to the "out" value returned from the server.
  46  * <P>
  47  * If <code>myFloatHolder</code> is an instance of <code>FloatHolder</code>,
  48  * the value stored in its <code>value</code> field can be accessed with
  49  * <code>myFloatHolder.value</code>.
  50  *
  51  * @since       1.2
  52  */
  53 public final class FloatHolder implements Streamable {
  54     /**
  55      * The <code>float</code> value held by this <code>FloatHolder</code>
  56      * object.
  57      */
  58     public float value;
  59 
  60     /**
  61      * Constructs a new <code>FloatHolder</code> object with its
  62      * <code>value</code> field initialized to 0.0.
  63      */
  64     public FloatHolder() {
  65     }
  66 
  67     /**
  68      * Constructs a new <code>FloatHolder</code> object for the given
  69      * <code>float</code>.
  70      * @param initial the <code>float</code> with which to initialize
  71      *                the <code>value</code> field of the new