1 /*
   2  * Copyright (c) 1995, 2001, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package org.omg.CORBA;
  26 
  27 import org.omg.CORBA.portable.Streamable;
  28 import org.omg.CORBA.portable.InputStream;
  29 import org.omg.CORBA.portable.OutputStream;
  30 
  31 
  32 /**
  33  * The Holder for {@code Boolean}. For more information on
  34  * Holder files, see <a href="doc-files/generatedfiles.html#holder">
  35  * "Generated Files: Holder Files"</a>.<P>
  36  * A Holder class for a {@code boolean}
  37  * that is used to store "out" and "inout" parameters in IDL methods.
  38  * If an IDL method signature has an IDL {@code boolean} as an "out"
  39  * or "inout" parameter, the programmer must pass an instance of
  40  * {@code BooleanHolder} as the corresponding
  41  * parameter in the method invocation; for "inout" parameters, the programmer
  42  * must also fill the "in" value to be sent to the server.
  43  * Before the method invocation returns, the ORB will fill in the
  44  * value corresponding to the "out" value returned from the server.
  45  * <P>
  46  * If {@code myBooleanHolder} is an instance of {@code BooleanHolder},
  47  * the value stored in its {@code value} field can be accessed with
  48  * {@code myBooleanHolder.value}.
  49  *
  50  * @since       JDK1.2
  51  */
  52 public final class BooleanHolder implements Streamable {
  53 
  54     /**
  55      * The {@code boolean} value held by this {@code BooleanHolder}
  56      * object.
  57      */
  58     public boolean value;
  59 
  60     /**
  61      * Constructs a new {@code BooleanHolder} object with its
  62      * {@code value} field initialized to {@code false}.
  63      */
  64     public BooleanHolder() {
  65     }
  66 
  67     /**
  68      * Constructs a new {@code BooleanHolder} object with its
  69      * {@code value} field initialized with the given {@code boolean}.
  70      * @param initial the {@code boolean} with which to initialize
  71      *                the {@code value} field of the newly-created
  72      *                {@code BooleanHolder} object
  73      */
  74     public BooleanHolder(boolean initial) {
  75         value = initial;
  76     }
  77 
  78     /**
  79      * Reads unmarshalled data from {@code input} and assigns it to this
  80      * {@code BooleanHolder} object's {@code value} field.
  81      *
  82      * @param input the {@code InputStream} object containing
  83      *              CDR formatted data from the wire
  84      */
  85     public void _read(InputStream input) {
  86         value = input.read_boolean();
  87     }
  88 
  89     /**
  90      * Marshals the value in this {@code BooleanHolder} object's
  91      * {@code value} field to the output stream {@code output}.
  92      *
  93      * @param output the OutputStream which will contain the CDR formatted data
  94      */
  95     public void _write(OutputStream output) {
  96         output.write_boolean(value);
  97     }
  98 
  99     /**
 100      * Retrieves the {@code TypeCode} object that corresponds to the
 101      * value held in this {@code BooleanHolder} object.
 102      *
 103      * @return    the {@code TypeCode} for the value held
 104      *            in this {@code BooleanHolder} object
 105      */
 106     public TypeCode _type() {
 107         return ORB.init().get_primitive_tc(TCKind.tk_boolean);
 108     }
 109 }