< prev index next >
src/java.corba/share/classes/org/omg/CORBA/DoubleHolder.java
Print this page
*** 28,107 ****
import org.omg.CORBA.portable.Streamable;
import org.omg.CORBA.portable.InputStream;
import org.omg.CORBA.portable.OutputStream;
/**
! * The Holder for <tt>Double</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>double</code>
* that is used to store "out" and "inout" parameters in IDL methods.
! * If an IDL method signature has an IDL <code>double</code> as an "out"
* or "inout" parameter, the programmer must pass an instance of
! * <code>DoubleHolder</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>myDoubleHolder</code> is an instance of <code>DoubleHolder</code>,
! * the value stored in its <code>value</code> field can be accessed with
! * <code>myDoubleHolder.value</code>.
*
* @since JDK1.2
*/
public final class DoubleHolder implements Streamable {
/**
! * The <code>double</code> value held by this <code>DoubleHolder</code>
* object.
*/
public double value;
/**
! * Constructs a new <code>DoubleHolder</code> object with its
! * <code>value</code> field initialized to 0.0.
*/
public DoubleHolder() {
}
/**
! * Constructs a new <code>DoubleHolder</code> object for the given
! * <code>double</code>.
! * @param initial the <code>double</code> with which to initialize
! * the <code>value</code> field of the new
! * <code>DoubleHolder</code> object
*/
public DoubleHolder(double initial) {
value = initial;
}
/**
* Read a double value from the input stream and store it in the
* value member.
*
! * @param input the <code>InputStream</code> to read from.
*/
public void _read(InputStream input) {
value = input.read_double();
}
/**
* Write the double value stored in this holder to an
! * <code>OutputStream</code>.
*
! * @param output the <code>OutputStream</code> to write into.
*/
public void _write(OutputStream output) {
output.write_double(value);
}
/**
! * Return the <code>TypeCode</code> of this holder object.
*
! * @return the <code>TypeCode</code> object.
*/
public org.omg.CORBA.TypeCode _type() {
return ORB.init().get_primitive_tc(TCKind.tk_double);
}
--- 28,107 ----
import org.omg.CORBA.portable.Streamable;
import org.omg.CORBA.portable.InputStream;
import org.omg.CORBA.portable.OutputStream;
/**
! * 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 {@code double} value held by this {@code DoubleHolder}
* object.
*/
public double value;
/**
! * Constructs a new {@code DoubleHolder} object with its
! * {@code value} field initialized to 0.0.
*/
public DoubleHolder() {
}
/**
! * 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.
*
! * @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
! * {@code OutputStream}.
*
! * @param output the {@code OutputStream} to write into.
*/
public void _write(OutputStream output) {
output.write_double(value);
}
/**
! * 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);
}
< prev index next >