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