/*
* Copyright (c) 1997, 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 Int
. For more information on Holder files, see
"Generated Files: Holder Files". A Holder class for an int
that is used to store "out" and "inout" parameters in IDL methods. If an IDL method signature has an IDL long
as an "out" or "inout" parameter, the programmer must pass an instance of IntHolder
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 myIntHolder
is an instance of IntHolder
, the value stored in its value
field can be accessed with myIntHolder.value
.
Since: JDK1.2
/**
* The Holder for {@code Int}. For more information on
* Holder files, see <a href="doc-files/generatedfiles.html#holder">
* "Generated Files: Holder Files"</a>.<P>
* A Holder class for an {@code int}
* that is used to store "out" and "inout" parameters in IDL methods.
* If an IDL method signature has an IDL {@code long} as an "out"
* or "inout" parameter, the programmer must pass an instance of
* {@code IntHolder} 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 myIntHolder} is an instance of {@code IntHolder},
* the value stored in its {@code value} field can be accessed with
* {@code myIntHolder.value}.
*
* @since JDK1.2
*/
public final class IntHolder implements Streamable {
The int
value held by this IntHolder
object in its value
field. /**
* The {@code int} value held by this {@code IntHolder}
* object in its {@code value} field.
*/
public int value;
Constructs a new IntHolder
object with its value
field initialized to 0
. /**
* Constructs a new {@code IntHolder} object with its
* {@code value} field initialized to {@code 0}.
*/
public IntHolder() {
}
Constructs a new IntHolder
object with its value
field initialized to the given int
. Params: - initial – the
int
with which to initialize the value
field of the newly-created IntHolder
object
/**
* Constructs a new {@code IntHolder} object with its
* {@code value} field initialized to the given
* {@code int}.
* @param initial the {@code int} with which to initialize
* the {@code value} field of the newly-created
* {@code IntHolder} object
*/
public IntHolder(int initial) {
value = initial;
}
Reads unmarshalled data from input
and assigns it to the value
field in this IntHolder
object. Params: - input – the
InputStream
object containing CDR formatted data from the wire
/**
* Reads unmarshalled data from {@code input} and assigns it to
* the {@code value} field in this {@code IntHolder} object.
*
* @param input the {@code InputStream} object containing CDR
* formatted data from the wire
*/
public void _read(InputStream input) {
value = input.read_long();
}
Marshals the value in this IntHolder
object's value
field to the output stream output
. Params: - output – the
OutputStream
object that will contain the CDR formatted data
/**
* Marshals the value in this {@code IntHolder} object's
* {@code value} field to the output stream {@code output}.
*
* @param output the {@code OutputStream} object that will contain
* the CDR formatted data
*/
public void _write(OutputStream output) {
output.write_long(value);
}
Retrieves the TypeCode
object that corresponds to the value held in this IntHolder
object's value
field. Returns: the type code for the value held in this IntHolder
object
/**
* Retrieves the {@code TypeCode} object that corresponds
* to the value held in this {@code IntHolder} object's
* {@code value} field.
*
* @return the type code for the value held in this {@code IntHolder}
* object
*/
public org.omg.CORBA.TypeCode _type() {
return ORB.init().get_primitive_tc(TCKind.tk_long);
}
}