CharHolder.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
26
27package org.omg.CORBA;
28
29import org.omg.CORBA.portable.Streamable;
30import org.omg.CORBA.portable.InputStream;
31import org.omg.CORBA.portable.OutputStream;
32
33/**
34 * The Holder for {@code Char}. For more information on
35 * Holder files, see <a href="doc-files/generatedfiles.html#holder">
36 * "Generated Files: Holder Files"</a>.<P>
37 * A Holder class for a {@code char}
38 * that is used to store "out" and "inout" parameters in IDL methods.
39 * If an IDL method signature has an IDL {@code char} as an "out"
40 * or "inout" parameter, the programmer must pass an instance of
41 * {@code CharHolder} as the corresponding
42 * parameter in the method invocation; for "inout" parameters, the programmer
43 * must also fill the "in" value to be sent to the server.
44 * Before the method invocation returns, the ORB will fill in the
45 * value corresponding to the "out" value returned from the server.
46 * <P>
47 * If {@code myCharHolder} is an instance of {@code CharHolder},
48 * the value stored in its {@code value} field can be accessed with
49 * {@code myCharHolder.value}.
50 *
51 * @since       JDK1.2
52 */
53public final class CharHolder implements Streamable {
54
55    /**
56     * The {@code char} value held by this {@code CharHolder}
57     * object.
58     */
59    public char value;
60
61    /**
62     * Constructs a new {@code CharHolder} object with its
63     * {@code value} field initialized to {@code 0}.
64     */
65    public CharHolder() {
66    }
67
68    /**
69     * Constructs a new {@code CharHolder} object for the given
70     * {@code char}.
71     * @param initial the {@code char} with which to initialize
72     *                the {@code value} field of the new
73     *                {@code CharHolder} object
74     */
75    public CharHolder(char initial) {
76        value = initial;
77    }
78
79    /**
80     * Reads from {@code input} and initalizes the value in
81     * this {@code CharHolder} 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_char();
88    }
89
90    /**
91     * Marshals to {@code output} the value in
92     * this {@code CharHolder} object.
93     *
94     * @param output the OutputStream which will contain the CDR formatted data
95     */
96    public void _write(OutputStream output) {
97        output.write_char(value);
98    }
99
100    /**
101     * Returns the {@code TypeCode} object  corresponding
102     * to the value held in
103     * this {@code CharHolder} object.
104     *
105     * @return    the TypeCode of the value held in
106     *            this {@code CharHolder} object
107     */
108    public org.omg.CORBA.TypeCode _type() {
109        return ORB.init().get_primitive_tc(TCKind.tk_char);
110    }
111}
112