Mercurial > jdk8-mips64-public > corba / annotate
src/share/classes/org/omg/CORBA/ObjectHolder.java@91006f157c46 (annotated)
src/share/classes/org/omg/CORBA/ObjectHolder.java
Tue, 25 May 2010 15:52:11 -0700
- author
- ohair
- date
- Tue, 25 May 2010 15:52:11 -0700
- changeset 158
- 91006f157c46
- parent 1
- 55540e827aef
- child 748
- 6845b95cba6b
- permissions
- -rw-r--r--
6943119: Rebrand source copyright notices
Reviewed-by: darcy
| duke@1 | 1 | /* |
| ohair@158 | 2 | * Copyright (c) 1996, 2001, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@158 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@158 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@158 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@158 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@158 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package org.omg.CORBA; |
| duke@1 | 27 | |
| duke@1 | 28 | import org.omg.CORBA.portable.Streamable; |
| duke@1 | 29 | import org.omg.CORBA.portable.InputStream; |
| duke@1 | 30 | import org.omg.CORBA.portable.OutputStream; |
| duke@1 | 31 | |
| duke@1 | 32 | |
| duke@1 | 33 | /** |
| duke@1 | 34 | * The Holder for <tt>Object</tt>. For more information on |
| duke@1 | 35 | * Holder files, see <a href="doc-files/generatedfiles.html#holder"> |
| duke@1 | 36 | * "Generated Files: Holder Files"</a>.<P> |
| duke@1 | 37 | * A Holder class for a CORBA object reference (a value of type |
| duke@1 | 38 | * <code>org.omg.CORBA.Object</code>). It is usually |
| duke@1 | 39 | * used to store "out" and "inout" parameters in IDL methods. |
| duke@1 | 40 | * If an IDL method signature has a CORBA Object reference as an "out" |
| duke@1 | 41 | * or "inout" parameter, the programmer must pass an instance of |
| duke@1 | 42 | * <code>ObjectHolder</code> as the corresponding |
| duke@1 | 43 | * parameter in the method invocation; for "inout" parameters, the programmer |
| duke@1 | 44 | * must also fill the "in" value to be sent to the server. |
| duke@1 | 45 | * Before the method invocation returns, the ORB will fill in the |
| duke@1 | 46 | * value corresponding to the "out" value returned from the server. |
| duke@1 | 47 | * <P> |
| duke@1 | 48 | * If <code>myObjectHolder</code> is an instance of <code>ObjectHolder</code>, |
| duke@1 | 49 | * the value stored in its <code>value</code> field can be accessed with |
| duke@1 | 50 | * <code>myObjectHolder.value</code>. |
| duke@1 | 51 | * |
| duke@1 | 52 | * @since JDK1.2 |
| duke@1 | 53 | */ |
| duke@1 | 54 | public final class ObjectHolder implements Streamable { |
| duke@1 | 55 | /** |
| duke@1 | 56 | * The <code>Object</code> value held by this <code>ObjectHolder</code> |
| duke@1 | 57 | * object. |
| duke@1 | 58 | */ |
| duke@1 | 59 | public Object value; |
| duke@1 | 60 | |
| duke@1 | 61 | /** |
| duke@1 | 62 | * Constructs a new <code>ObjectHolder</code> object with its |
| duke@1 | 63 | * <code>value</code> field initialized to <code>null</code>. |
| duke@1 | 64 | */ |
| duke@1 | 65 | public ObjectHolder() { |
| duke@1 | 66 | } |
| duke@1 | 67 | |
| duke@1 | 68 | /** |
| duke@1 | 69 | * Constructs a new <code>ObjectHolder</code> object with its |
| duke@1 | 70 | * <code>value</code> field initialized to the given |
| duke@1 | 71 | * <code>Object</code>. |
| duke@1 | 72 | * @param initial the <code>Object</code> with which to initialize |
| duke@1 | 73 | * the <code>value</code> field of the newly-created |
| duke@1 | 74 | * <code>ObjectHolder</code> object |
| duke@1 | 75 | */ |
| duke@1 | 76 | public ObjectHolder(Object initial) { |
| duke@1 | 77 | value = initial; |
| duke@1 | 78 | } |
| duke@1 | 79 | |
| duke@1 | 80 | /** |
| duke@1 | 81 | * Reads from <code>input</code> and initalizes the value in |
| duke@1 | 82 | * this <code>ObjectHolder</code> object |
| duke@1 | 83 | * with the unmarshalled data. |
| duke@1 | 84 | * |
| duke@1 | 85 | * @param input the InputStream containing CDR formatted data from the wire. |
| duke@1 | 86 | */ |
| duke@1 | 87 | public void _read(InputStream input) { |
| duke@1 | 88 | value = input.read_Object(); |
| duke@1 | 89 | } |
| duke@1 | 90 | |
| duke@1 | 91 | /** |
| duke@1 | 92 | * Marshals to <code>output</code> the value in |
| duke@1 | 93 | * this <code>ObjectHolder</code> object. |
| duke@1 | 94 | * |
| duke@1 | 95 | * @param output the OutputStream which will contain the CDR formatted data. |
| duke@1 | 96 | */ |
| duke@1 | 97 | public void _write(OutputStream output) { |
| duke@1 | 98 | output.write_Object(value); |
| duke@1 | 99 | } |
| duke@1 | 100 | |
| duke@1 | 101 | /** |
| duke@1 | 102 | * Returns the TypeCode corresponding to the value held in |
| duke@1 | 103 | * this <code>ObjectHolder</code> object |
| duke@1 | 104 | * |
| duke@1 | 105 | * @return the TypeCode of the value held in |
| duke@1 | 106 | * this <code>ObjectHolder</code> object |
| duke@1 | 107 | */ |
| duke@1 | 108 | public org.omg.CORBA.TypeCode _type() { |
| duke@1 | 109 | return org.omg.CORBA.ORB.init().get_primitive_tc(TCKind.tk_objref); |
| duke@1 | 110 | } |
| duke@1 | 111 | } |
