duke@1: /*
ohair@158:  * Copyright (c) 1995, 2001, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@158:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@158:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@158:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@158:  * or visit www.oracle.com if you need additional information or have any
ohair@158:  * questions.
duke@1:  */
duke@1: package org.omg.CORBA;
duke@1: 
duke@1: import org.omg.CORBA.portable.Streamable;
duke@1: import org.omg.CORBA.portable.InputStream;
duke@1: import org.omg.CORBA.portable.OutputStream;
duke@1: 
duke@1: 
duke@1: /**
duke@1:  * The Holder for <tt>Boolean</tt>.  For more information on
duke@1:  * Holder files, see <a href="doc-files/generatedfiles.html#holder">
duke@1:  * "Generated Files: Holder Files"</a>.<P>
duke@1:  * A Holder class for a <code>boolean</code>
duke@1:  * that is used to store "out" and "inout" parameters in IDL methods.
duke@1:  * If an IDL method signature has an IDL <code>boolean</code> as an "out"
duke@1:  * or "inout" parameter, the programmer must pass an instance of
duke@1:  * <code>BooleanHolder</code> as the corresponding
duke@1:  * parameter in the method invocation; for "inout" parameters, the programmer
duke@1:  * must also fill the "in" value to be sent to the server.
duke@1:  * Before the method invocation returns, the ORB will fill in the
duke@1:  * value corresponding to the "out" value returned from the server.
duke@1:  * <P>
duke@1:  * If <code>myBooleanHolder</code> is an instance of <code>BooleanHolder</code>,
duke@1:  * the value stored in its <code>value</code> field can be accessed with
duke@1:  * <code>myBooleanHolder.value</code>.
duke@1:  *
duke@1:  * @since       JDK1.2
duke@1:  */
duke@1: public final class BooleanHolder implements Streamable {
duke@1: 
duke@1:     /**
duke@1:      * The <code>boolean</code> value held by this <code>BooleanHolder</code>
duke@1:      * object.
duke@1:      */
duke@1:     public boolean value;
duke@1: 
duke@1:     /**
duke@1:      * Constructs a new <code>BooleanHolder</code> object with its
duke@1:      * <code>value</code> field initialized to <code>false</code>.
duke@1:      */
duke@1:     public BooleanHolder() {
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Constructs a new <code>BooleanHolder</code> object with its
duke@1:      * <code>value</code> field initialized with the given <code>boolean</code>.
duke@1:      * @param initial the <code>boolean</code> with which to initialize
duke@1:      *                the <code>value</code> field of the newly-created
duke@1:      *                <code>BooleanHolder</code> object
duke@1:      */
duke@1:     public BooleanHolder(boolean initial) {
duke@1:         value = initial;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Reads unmarshalled data from <code>input</code> and assigns it to this
duke@1:      * <code>BooleanHolder</code> object's <code>value</code> field.
duke@1:      *
duke@1:      * @param input the <code>InputStream</code> object containing
duke@1:      *              CDR formatted data from the wire
duke@1:      */
duke@1:     public void _read(InputStream input) {
duke@1:         value = input.read_boolean();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Marshals the value in this <code>BooleanHolder</code> object's
duke@1:      * <code>value</code> field to the output stream <code>output</code>.
duke@1:      *
duke@1:      * @param output the OutputStream which will contain the CDR formatted data
duke@1:      */
duke@1:     public void _write(OutputStream output) {
duke@1:         output.write_boolean(value);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Retrieves the <code>TypeCode</code> object that corresponds to the
duke@1:      * value held in this <code>BooleanHolder</code> object.
duke@1:      *
duke@1:      * @return    the <code>TypeCode</code> for the value held
duke@1:      *            in this <code>BooleanHolder</code> object
duke@1:      */
duke@1:     public TypeCode _type() {
duke@1:         return ORB.init().get_primitive_tc(TCKind.tk_boolean);
duke@1:     }
duke@1: }