/*
* 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 Double
. For more information on Holder files, see
"Generated Files: Holder Files". A Holder class for a double
that is used to store "out" and "inout" parameters in IDL methods. If an IDL method signature has an IDL double
as an "out" or "inout" parameter, the programmer must pass an instance of DoubleHolder
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 myDoubleHolder
is an instance of DoubleHolder
, the value stored in its value
field can be accessed with myDoubleHolder.value
.
Since: JDK1.2
/**
* The Holder for {@code Double}. 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 double}
* that is used to store "out" and "inout" parameters in IDL methods.
* If an IDL method signature has an IDL {@code double} as an "out"
* or "inout" parameter, the programmer must pass an instance of
* {@code DoubleHolder} 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 myDoubleHolder} is an instance of {@code DoubleHolder},
* the value stored in its {@code value} field can be accessed with
* {@code myDoubleHolder.value}.
*
* @since JDK1.2
*/
public final class DoubleHolder implements Streamable {
The double
value held by this DoubleHolder
object. /**
* The {@code double} value held by this {@code DoubleHolder}
* object.
*/
public double value;
Constructs a new DoubleHolder
object with its value
field initialized to 0.0. /**
* Constructs a new {@code DoubleHolder} object with its
* {@code value} field initialized to 0.0.
*/
public DoubleHolder() {
}
Constructs a new DoubleHolder
object for the given double
. Params: - initial – the
double
with which to initialize the value
field of the new DoubleHolder
object
/**
* Constructs a new {@code DoubleHolder} object for the given
* {@code double}.
* @param initial the {@code double} with which to initialize
* the {@code value} field of the new
* {@code DoubleHolder} object
*/
public DoubleHolder(double initial) {
value = initial;
}
Read a double value from the input stream and store it in the
value member.
Params: - input – the
InputStream
to read from.
/**
* Read a double value from the input stream and store it in the
* value member.
*
* @param input the {@code InputStream} to read from.
*/
public void _read(InputStream input) {
value = input.read_double();
}
Write the double value stored in this holder to an OutputStream
. Params: - output – the
OutputStream
to write into.
/**
* Write the double value stored in this holder to an
* {@code OutputStream}.
*
* @param output the {@code OutputStream} to write into.
*/
public void _write(OutputStream output) {
output.write_double(value);
}
Return the TypeCode
of this holder object. Returns: the TypeCode
object.
/**
* Return the {@code TypeCode} of this holder object.
*
* @return the {@code TypeCode} object.
*/
public org.omg.CORBA.TypeCode _type() {
return ORB.init().get_primitive_tc(TCKind.tk_double);
}
}