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