Mercurial > jdk8-mips64-public > corba / file revision
src/share/classes/org/omg/CORBA/ByteHolder.java@52ad44f9a3ec
src/share/classes/org/omg/CORBA/ByteHolder.java
Tue, 22 Oct 2013 11:40:27 +0100
- author
- alanb
- date
- Tue, 22 Oct 2013 11:40:27 +0100
- changeset 533
- 52ad44f9a3ec
- parent 158
- 91006f157c46
- child 748
- 6845b95cba6b
- permissions
- -rw-r--r--
8021257: com.sun.corba.se.** should be on restricted package list
Reviewed-by: chegar, coffeys, smarks
Contributed-by: alan.bateman@oralce.com, mark.sheppard@oracle.com
1 /*
2 * Copyright (c) 1997, 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 */
27 package org.omg.CORBA;
29 import org.omg.CORBA.portable.Streamable;
30 import org.omg.CORBA.portable.InputStream;
31 import org.omg.CORBA.portable.OutputStream;
33 /**
34 * The Holder for <tt>Byte</tt>. 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>byte</code>
38 * that is used to store "out" and "inout" parameters in IDL methods.
39 * If an IDL method signature has an IDL <code>octet</code> as an "out"
40 * or "inout" parameter, the programmer must pass an instance of
41 * <code>ByteHolder</code> 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>myByteHolder</code> is an instance of <code>ByteHolder</code>,
48 * the value stored in its <code>value</code> field can be accessed with
49 * <code>myByteHolder.value</code>.
50 *
51 * @since JDK1.2
52 */
53 public final class ByteHolder implements Streamable {
54 /**
55 * The <code>byte</code> value held by this <code>ByteHolder</code>
56 * object.
57 */
59 public byte value;
61 /**
62 * Constructs a new <code>ByteHolder</code> object with its
63 * <code>value</code> field initialized to 0.
64 */
65 public ByteHolder() {
66 }
68 /**
69 * Constructs a new <code>ByteHolder</code> object for the given
70 * <code>byte</code>.
71 * @param initial the <code>byte</code> with which to initialize
72 * the <code>value</code> field of the new
73 * <code>ByteHolder</code> object
74 */
75 public ByteHolder(byte initial) {
76 value = initial;
77 }
79 /**
80 * Reads from <code>input</code> and initalizes the value in
81 * this <code>ByteHolder</code> 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_octet();
88 }
90 /**
91 * Marshals to <code>output</code> the value in
92 * this <code>ByteHolder</code> object.
93 *
94 * @param output the OutputStream which will contain the CDR formatted data.
95 */
96 public void _write(OutputStream output) {
97 output.write_octet(value);
98 }
100 /**
101 * Returns the TypeCode corresponding to the value held in
102 * this <code>ByteHolder</code> object.
103 *
104 * @return the TypeCode of the value held in
105 * this <code>ByteHolder</code> object
106 */
107 public org.omg.CORBA.TypeCode _type() {
108 return ORB.init().get_primitive_tc(TCKind.tk_octet);
109 }
110 }
