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 27 package org.omg.CORBA; 28 29 import org.omg.CORBA.portable.Streamable; 30 import org.omg.CORBA.portable.InputStream; 31 import org.omg.CORBA.portable.OutputStream; 32 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 */ 58 59 public byte value; 60 61 /** 62 * Constructs a new <code>ByteHolder</code> object with its 63 * <code>value</code> field initialized to 0. 64 */ 65 public ByteHolder() { 66 } 67 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 } 78 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 } 89 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 } 99 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 } | 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 27 package org.omg.CORBA; 28 29 import org.omg.CORBA.portable.Streamable; 30 import org.omg.CORBA.portable.InputStream; 31 import org.omg.CORBA.portable.OutputStream; 32 33 /** 34 * The Holder for {@code Byte}. 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} 38 * that is used to store "out" and "inout" parameters in IDL methods. 39 * If an IDL method signature has an IDL {@code octet} as an "out" 40 * or "inout" parameter, the programmer must pass an instance of 41 * {@code ByteHolder} 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} is an instance of {@code ByteHolder}, 48 * the value stored in its {@code value} field can be accessed with 49 * {@code myByteHolder.value}. 50 * 51 * @since JDK1.2 52 */ 53 public final class ByteHolder implements Streamable { 54 /** 55 * The {@code byte} value held by this {@code ByteHolder} 56 * object. 57 */ 58 59 public byte value; 60 61 /** 62 * Constructs a new {@code ByteHolder} object with its 63 * {@code value} field initialized to 0. 64 */ 65 public ByteHolder() { 66 } 67 68 /** 69 * Constructs a new {@code ByteHolder} object for the given 70 * {@code byte}. 71 * @param initial the {@code byte} with which to initialize 72 * the {@code value} field of the new 73 * {@code ByteHolder} object 74 */ 75 public ByteHolder(byte initial) { 76 value = initial; 77 } 78 79 /** 80 * Reads from {@code input} and initalizes the value in 81 * this {@code ByteHolder} 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 } 89 90 /** 91 * Marshals to {@code output} the value in 92 * this {@code ByteHolder} 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 } 99 100 /** 101 * Returns the TypeCode corresponding to the value held in 102 * this {@code ByteHolder} object. 103 * 104 * @return the TypeCode of the value held in 105 * this {@code ByteHolder} object 106 */ 107 public org.omg.CORBA.TypeCode _type() { 108 return ORB.init().get_primitive_tc(TCKind.tk_octet); 109 } 110 } |