/*
 * Copyright (c) 1995, 2001, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package org.omg.CORBA;

import org.omg.CORBA.portable.Streamable;
import org.omg.CORBA.portable.InputStream;
import org.omg.CORBA.portable.OutputStream;


The Holder for Float. For more information on Holder files, see 
"Generated Files: Holder Files".
 A Holder class for a float that is used to store "out" and "inout" parameters in IDL methods. If an IDL method signature has an IDL float as an "out" or "inout" parameter, the programmer must pass an instance of FloatHolder 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. 
 If myFloatHolder is an instance of FloatHolder, the value stored in its value field can be accessed with myFloatHolder.value. 
Since:
      JDK1.2/**
 * The Holder for {@code Float}. 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 float}
 * that is used to store "out" and "inout" parameters in IDL methods.
 * If an IDL method signature has an IDL {@code float} as an "out"
 * or "inout" parameter, the programmer must pass an instance of
 * {@code FloatHolder} 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 myFloatHolder} is an instance of {@code FloatHolder},
 * the value stored in its {@code value} field can be accessed with
 * {@code myFloatHolder.value}.
 *
 * @since       JDK1.2
 */
public final class FloatHolder implements Streamable {
    
The float value held by this FloatHolder object. /**
     * The {@code float} value held by this {@code FloatHolder}
     * object.
     */
    public float value;

    
Constructs a new FloatHolder object with its value field initialized to 0.0. /**
     * Constructs a new {@code FloatHolder} object with its
     * {@code value} field initialized to 0.0.
     */
    public FloatHolder() {
    }

    
Constructs a new FloatHolder object for the given float. 
Params:
initial – the float with which to initialize the value field of the new FloatHolder object/**
     * Constructs a new {@code FloatHolder} object for the given
     * {@code float}.
     * @param initial the {@code float} with which to initialize
     *                the {@code value} field of the new
     *                {@code FloatHolder} object
     */
    public FloatHolder(float initial) {
        value = initial;
    }

    
Read a float from an input stream and initialize the value
member with the float value.
Params:
input – the InputStream to read from./**
     * Read a float from an input stream and initialize the value
     * member with the float value.
     *
     * @param input the {@code InputStream} to read from.
     */
    public void _read(InputStream input) {
        value = input.read_float();
    }

    
Write the float value into an output stream.
Params:
output – the OutputStream to write into./**
     * Write the float value into an output stream.
     *
     * @param output the {@code OutputStream} to write into.
     */
    public void _write(OutputStream output) {
        output.write_float(value);
    }

    
Return the TypeCode of this Streamable. 
Returns:
the TypeCode object./**
     * Return the {@code TypeCode} of this Streamable.
     *
     * @return the {@code TypeCode} object.
     */
    public org.omg.CORBA.TypeCode _type() {
        return ORB.init().get_primitive_tc(TCKind.tk_float);
    }
}