/*
* Copyright (c) 1995, 2015, 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 Short
. For more information on Holder files, see
"Generated Files: Holder Files".
A Holder class for a short
that is used to store "out" and "inout" parameters in IDL operations. If an IDL operation signature has an IDL short
as an "out" or "inout" parameter, the programmer must pass an instance of ShortHolder
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 myShortHolder
is an instance of ShortHolder
, the value stored in its value
field can be accessed with myShortHolder.value
.
Since: JDK1.2
/**
* The Holder for {@code Short}. 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 short}
* that is used to store "out" and "inout" parameters in IDL operations.
* If an IDL operation signature has an IDL {@code short} as an "out"
* or "inout" parameter, the programmer must pass an instance of
* {@code ShortHolder} 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 myShortHolder} is an instance of {@code ShortHolder},
* the value stored in its {@code value} field can be accessed with
* {@code myShortHolder.value}.
*
* @since JDK1.2
*/
public final class ShortHolder implements Streamable {
The short
value held by this ShortHolder
object. /**
* The {@code short} value held by this {@code ShortHolder}
* object.
*/
public short value;
Constructs a new ShortHolder
object with its value
field initialized to 0
. /**
* Constructs a new {@code ShortHolder} object with its
* {@code value} field initialized to {@code 0}.
*/
public ShortHolder() {
}
Constructs a new ShortHolder
object with its value
field initialized to the given short
. Params: - initial – the
short
with which to initialize the value
field of the newly-created ShortHolder
object
/**
* Constructs a new {@code ShortHolder} object with its
* {@code value} field initialized to the given
* {@code short}.
* @param initial the {@code short} with which to initialize
* the {@code value} field of the newly-created
* {@code ShortHolder} object
*/
public ShortHolder(short initial) {
value = initial;
}
Reads from input
and initalizes the value in this ShortHolder
object with the unmarshalled data. Params: - input – the InputStream containing CDR formatted data from the wire.
/**
* Reads from {@code input} and initalizes the value in
* this {@code ShortHolder} object
* with the unmarshalled data.
*
* @param input the InputStream containing CDR formatted data from the wire.
*/
public void _read(InputStream input) {
value = input.read_short();
}
Marshals to output
the value in this ShortHolder
object. Params: - output – the OutputStream which will contain the CDR formatted data.
/**
* Marshals to {@code output} the value in
* this {@code ShortHolder} object.
*
* @param output the OutputStream which will contain the CDR formatted data.
*/
public void _write(OutputStream output) {
output.write_short(value);
}
Returns the TypeCode corresponding to the value held in this ShortHolder
object. Returns: the TypeCode of the value held in this ShortHolder
object
/**
* Returns the TypeCode corresponding to the value held in
* this {@code ShortHolder} object.
*
* @return the TypeCode of the value held in
* this {@code ShortHolder} object
*/
public org.omg.CORBA.TypeCode _type() {
return ORB.init().get_primitive_tc(TCKind.tk_short);
}
}