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