src/share/classes/org/omg/CORBA/ObjectHolder.java

Wed, 27 Apr 2016 01:21:28 +0800

author
aoqi
date
Wed, 27 Apr 2016 01:21:28 +0800
changeset 0
7ef37b2cdcad
child 748
6845b95cba6b
permissions
-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/corba/
changeset: 765:f46df0af2ca8
tag: jdk8u25-b17

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

mercurial