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