author | avstepan |
Sun, 13 Sep 2015 23:31:47 +0300 | |
changeset 32688 | 936c391804a5 |
parent 25862 | a5e25d68f971 |
permissions | -rw-r--r-- |
4 | 1 |
/* |
5555 | 2 |
* Copyright (c) 1999, 2001, Oracle and/or its affiliates. All rights reserved. |
4 | 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 |
|
5555 | 7 |
* published by the Free Software Foundation. Oracle designates this |
4 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5555 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
4 | 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 |
* |
|
5555 | 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. |
|
4 | 24 |
*/ |
25 |
||
26 |
package org.omg.CORBA; |
|
27 |
||
28 |
import org.omg.CORBA.portable.Streamable; |
|
29 |
import org.omg.CORBA.portable.InputStream; |
|
30 |
import org.omg.CORBA.portable.OutputStream; |
|
31 |
||
32 |
/** |
|
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
33 |
* The Holder for {@code ValueBase}. For more information on |
4 | 34 |
* Holder files, see <a href="doc-files/generatedfiles.html#holder"> |
35 |
* "Generated Files: Holder Files"</a>.<P> |
|
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
36 |
* A Holder class for a {@code java.io.Serializable} |
4 | 37 |
* that is used to store "out" and "inout" parameters in IDL methods. |
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
38 |
* If an IDL method signature has an IDL {@code ValueBase} as an "out" |
4 | 39 |
* or "inout" parameter, the programmer must pass an instance of |
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
40 |
* {@code ValueBaseHolder} as the corresponding |
4 | 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> |
|
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
46 |
* If {@code myValueBaseHolder} is an instance of {@code ValueBaseHolder}, |
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
47 |
* the value stored in its {@code value} field can be accessed with |
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
48 |
* {@code myValueBaseHolder.value}. |
4 | 49 |
* |
50 |
*/ |
|
51 |
public final class ValueBaseHolder implements Streamable { |
|
52 |
||
53 |
/** |
|
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
54 |
* The {@code java.io.Serializable} value held by this |
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
55 |
* {@code ValueBaseHolder} object. |
4 | 56 |
*/ |
57 |
public java.io.Serializable value; |
|
58 |
||
59 |
/** |
|
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
60 |
* Constructs a new {@code ValueBaseHolder} object with its |
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
61 |
* {@code value} field initialized to {@code 0}. |
4 | 62 |
*/ |
63 |
public ValueBaseHolder() { |
|
64 |
} |
|
65 |
||
66 |
/** |
|
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
67 |
* Constructs a new {@code ValueBaseHolder} object with its |
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
68 |
* {@code value} field initialized to the given |
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
69 |
* {@code java.io.Serializable}. |
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
70 |
* @param initial the {@code java.io.Serializable} with which to initialize |
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
71 |
* the {@code value} field of the newly-created |
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
72 |
* {@code ValueBaseHolder} object |
4 | 73 |
*/ |
74 |
public ValueBaseHolder(java.io.Serializable initial) { |
|
75 |
value = initial; |
|
76 |
} |
|
77 |
||
78 |
/** |
|
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
79 |
* Reads from {@code input} and initalizes the value in the Holder |
4 | 80 |
* with the unmarshalled data. |
81 |
* |
|
82 |
* @param input the InputStream containing CDR formatted data from the wire |
|
83 |
*/ |
|
84 |
public void _read(InputStream input) { |
|
85 |
value = ((org.omg.CORBA_2_3.portable.InputStream)input).read_value(); |
|
86 |
} |
|
87 |
||
88 |
/** |
|
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
89 |
* Marshals to {@code output} the value in the Holder. |
4 | 90 |
* |
91 |
* @param output the OutputStream which will contain the CDR formatted data |
|
92 |
*/ |
|
93 |
public void _write(OutputStream output) { |
|
94 |
((org.omg.CORBA_2_3.portable.OutputStream)output).write_value(value); |
|
95 |
} |
|
96 |
||
97 |
/** |
|
32688
936c391804a5
8133650: replace some <tt> tags (obsolete in html5) in CORBA docs
avstepan
parents:
25862
diff
changeset
|
98 |
* Returns the {@code TypeCode} object |
4 | 99 |
* corresponding to the value held in the Holder. |
100 |
* |
|
101 |
* @return the TypeCode of the value held in the holder |
|
102 |
*/ |
|
103 |
public org.omg.CORBA.TypeCode _type() { |
|
104 |
return ORB.init().get_primitive_tc(TCKind.tk_value); |
|
105 |
} |
|
106 |
||
107 |
} |