org.omg.CORBA.BooleanHolder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openjdk-orb Show documentation
JBoss repackaging of the OpenJDK ORB
The newest version!
/*
 * 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 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.
 *
 * @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);
    }
}