FloatHolder.java revision 704:3ef63dbde965 
1/*
2 * Copyright (c) 1995, 2001, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package org.omg.CORBA;
27
28import org.omg.CORBA.portable.Streamable;
29import org.omg.CORBA.portable.InputStream;
30import org.omg.CORBA.portable.OutputStream;
31
32
33/**
34 * The Holder for {@code Float}. 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}
38 * that is used to store "out" and "inout" parameters in IDL methods.
39 * If an IDL method signature has an IDL {@code float} as an "out"
40 * or "inout" parameter, the programmer must pass an instance of
41 * {@code FloatHolder} 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} is an instance of {@code FloatHolder},
48 * the value stored in its {@code value} field can be accessed with
49 * {@code myFloatHolder.value}.
50 *
51 * @since       JDK1.2
52 */
53public final class FloatHolder implements Streamable {
54    /**
55     * The {@code float} value held by this {@code FloatHolder}
56     * object.
57     */
58    public float value;
59
60    /**
61     * Constructs a new {@code FloatHolder} object with its
62     * {@code value} field initialized to 0.0.
63     */
64    public FloatHolder() {
65    }
66
67    /**
68     * Constructs a new {@code FloatHolder} object for the given
69     * {@code float}.
70     * @param initial the {@code float} with which to initialize
71     *                the {@code value} field of the new
72     *                {@code FloatHolder} object
73     */
74    public FloatHolder(float initial) {
75        value = initial;
76    }
77
78    /**
79     * Read a float from an input stream and initialize the value
80     * member with the float value.
81     *
82     * @param input the {@code InputStream} to read from.
83     */
84    public void _read(InputStream input) {
85        value = input.read_float();
86    }
87
88    /**
89     * Write the float value into an output stream.
90     *
91     * @param output the {@code OutputStream} to write into.
92     */
93    public void _write(OutputStream output) {
94        output.write_float(value);
95    }
96
97    /**
98     * Return the {@code TypeCode} of this Streamable.
99     *
100     * @return the {@code TypeCode} object.
101     */
102    public org.omg.CORBA.TypeCode _type() {
103        return ORB.init().get_primitive_tc(TCKind.tk_float);
104    }
105}
106