StringHolder.java revision 704:3ef63dbde965 
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
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 String}.  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 String}
37 * that is used to store "out" and "inout" parameters in IDL operations.
38 * If an IDL operation signature has an IDL {@code string} as an "out"
39 * or "inout" parameter, the programmer must pass an instance of
40 * {@code StringHolder} 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 myStringHolder} is an instance of {@code StringHolder},
47 * the value stored in its {@code value} field can be accessed with
48 * {@code myStringHolder.value}.
49 *
50 * @since       JDK1.2
51 */
52public final class StringHolder implements Streamable {
53
54    /**
55     * The {@code String} value held by this {@code StringHolder}
56     * object.
57     */
58    public String value;
59
60    /**
61     * Constructs a new {@code StringHolder} object with its
62     * {@code value} field initialized to {@code null}.
63     */
64    public StringHolder() {
65    }
66
67    /**
68     * Constructs a new {@code StringHolder} object with its
69     * {@code value} field initialized to the given
70     * {@code String}.
71     * @param initial the {@code String} with which to initialize
72     *                the {@code value} field of the newly-created
73     *                {@code StringHolder} object
74     */
75    public StringHolder(String initial) {
76        value = initial;
77    }
78
79    /**
80     * Reads the unmarshalled data from {@code input} and assigns it to
81     * the {@code value} field of this {@code StringHolder} object.
82     *
83     * @param input the InputStream containing CDR formatted data from the wire.
84     */
85    public void _read(InputStream input) {
86        value = input.read_string();
87    }
88
89    /**
90     * Marshals the value held by this {@code StringHolder} object
91     * 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_string(value);
97    }
98
99    /**
100     * Retrieves the {@code TypeCode} object that corresponds to
101     * the value held in this {@code StringHolder} object.
102     *
103     * @return    the type code of the value held in this {@code StringHolder}
104     *            object
105     */
106    public org.omg.CORBA.TypeCode _type() {
107        return ORB.init().get_primitive_tc(TCKind.tk_string);
108    }
109}
110