/*
* Copyright (c) 1998, 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 Fixed
. For more information on Holder files, see
"Generated Files: Holder Files".
FixedHolder is a container class for values of IDL type "fixed",
which is mapped to the Java class java.math.BigDecimal.
It is usually used to store "out" and "inout" IDL method parameters.
If an IDL method signature has a fixed as an "out" or "inout" parameter,
the programmer must pass an instance of FixedHolder 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 contained
value corresponding to the "out" value returned from the server.
/**
* The Holder for {@code Fixed}. For more information on
* Holder files, see <a href="doc-files/generatedfiles.html#holder">
* "Generated Files: Holder Files"</a>.<P>
* FixedHolder is a container class for values of IDL type "fixed",
* which is mapped to the Java class java.math.BigDecimal.
* It is usually used to store "out" and "inout" IDL method parameters.
* If an IDL method signature has a fixed as an "out" or "inout" parameter,
* the programmer must pass an instance of FixedHolder 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 contained
* value corresponding to the "out" value returned from the server.
*
*/
public final class FixedHolder implements Streamable {
The value held by the FixedHolder
/**
* The value held by the FixedHolder
*/
public java.math.BigDecimal value;
Construct the FixedHolder without initializing the contained value.
/**
* Construct the FixedHolder without initializing the contained value.
*/
public FixedHolder() {
}
Construct the FixedHolder and initialize it with the given value.
Params: - initial – the value used to initialize the FixedHolder
/**
* Construct the FixedHolder and initialize it with the given value.
* @param initial the value used to initialize the FixedHolder
*/
public FixedHolder(java.math.BigDecimal initial) {
value = initial;
}
Read a fixed point value from the input stream and store it in
the value member.
Params: - input – the
InputStream
to read from.
/**
* Read a fixed point 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_fixed();
}
Write the fixed point value stored in this holder to an OutputStream
. Params: - output – the
OutputStream
to write into.
/**
* Write the fixed point value stored in this holder to an
* {@code OutputStream}.
*
* @param output the {@code OutputStream} to write into.
*/
public void _write(OutputStream output) {
output.write_fixed(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_fixed);
}
}