1 /*
   2  * Copyright (c) 1996, 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 
  26 package org.omg.CORBA;
  27 
  28 import org.omg.CORBA.portable.Streamable;
  29 import org.omg.CORBA.portable.InputStream;
  30 import org.omg.CORBA.portable.OutputStream;
  31 
  32 /**
  33  * The Holder for {@code TypeCode}. 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 TypeCode} object
  37  * that is used to store "out" and "inout" parameters in IDL operations.
  38  * If an IDL operation signature has an IDL {@code TypeCode} as an "out"
  39  * or "inout" parameter, the programmer must pass an instance of
  40  * {@code TypeCodeHolder} 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 myTypeCodeHolder} is an instance of {@code TypeCodeHolder},
  47  * the value stored in its {@code value} field can be accessed with
  48  * {@code myTypeCodeHolder.value}.
  49  *
  50  * @since       JDK1.2
  51  */
  52 public final class TypeCodeHolder implements Streamable {
  53 
  54     /**
  55      * The {@code TypeCode} value held by
  56      * this {@code TypeCodeHolder} object.
  57      */
  58     public TypeCode value;
  59 
  60     /**
  61      * Constructs a new {@code TypeCodeHolder} object with its
  62      * {@code value} field initialized to {@code null}.
  63      */
  64     public TypeCodeHolder() {
  65     }
  66 
  67     /**
  68      * Constructs a new {@code TypeCodeHolder} object with its
  69      * {@code value} field initialized to the given
  70      * {@code TypeCode} object.
  71      * @param initial the {@code TypeCode} object with which to initialize
  72      *                the {@code value} field of the newly-created
  73      *                {@code TypeCodeHolder} object
  74      */
  75     public TypeCodeHolder(TypeCode initial) {
  76         value = initial;
  77     }
  78 
  79     /**
  80      * Reads from {@code input} and initalizes the value in
  81      * this {@code TypeCodeHolder} object
  82      * with the unmarshalled data.
  83      *
  84      * @param input the InputStream containing CDR formatted data from the wire
  85      */
  86     public void _read(InputStream input) {
  87         value = input.read_TypeCode();
  88     }
  89 
  90     /**
  91      * Marshals to {@code output} the value in
  92      * this {@code TypeCodeHolder} object.
  93      *
  94      * @param output the OutputStream which will contain the CDR formatted data
  95      */
  96     public void _write(OutputStream output) {
  97         output.write_TypeCode(value);
  98     }
  99 
 100     /**
 101      * Returns the TypeCode corresponding to the value held in
 102      * this {@code TypeCodeHolder} object.
 103      *
 104      * @return    the TypeCode of the value held in
 105      *             this {@code TypeCodeHolder} object
 106      */
 107     public org.omg.CORBA.TypeCode _type() {
 108         return ORB.init().get_primitive_tc(TCKind.tk_TypeCode);
 109     }
 110 }