org.omg.CORBA.BooleanHolder Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
* v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License v2.0
* w/Classpath exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause OR GPL-2.0 WITH
* Classpath-exception-2.0
*/
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 Boolean. For more information on
* Holder files, see
* "Generated Files: Holder Files".
* A Holder class for a boolean
* that is used to store "out" and "inout" parameters in IDL methods.
* If an IDL method signature has an IDL boolean as an "out"
* or "inout" parameter, the programmer must pass an instance of
* BooleanHolder 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 myBooleanHolder is an instance of BooleanHolder,
* the value stored in its value field can be accessed with
* myBooleanHolder.value.
*
* @version 1.14, 09/09/97
* @since JDK1.2
*/
public final class BooleanHolder implements Streamable {
/**
* The boolean value held by this BooleanHolder
* object.
*/
public boolean value;
/**
* Constructs a new BooleanHolder object with its
* value field initialized to false.
*/
public BooleanHolder() {
}
/**
* Constructs a new BooleanHolder object with its
* value field initialized with the given boolean.
* @param initial the boolean with which to initialize
* the value field of the newly-created
* BooleanHolder object
*/
public BooleanHolder(boolean initial) {
value = initial;
}
/**
* Reads unmarshalled data from input and assigns it to this
* BooleanHolder object's value field.
*
* @param input the InputStream object containing
* CDR formatted data from the wire
*/
public void _read(InputStream input) {
value = input.read_boolean();
}
/**
* Marshals the value in this BooleanHolder object's
* value field to the output stream output.
*
* @param output the OutputStream which will contain the CDR formatted data
*/
public void _write(OutputStream output) {
output.write_boolean(value);
}
/**
* Retrieves the TypeCode object that corresponds to the
* value held in this BooleanHolder object.
*
* @return the TypeCode for the value held
* in this BooleanHolder object
*/
public TypeCode _type() {
return ORB.init().get_primitive_tc(TCKind.tk_boolean);
}
}