• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/org/omg/CORBA/StringHolder.java@7ef37b2cdcad (annotated)

src/share/classes/org/omg/CORBA/StringHolder.java

Wed, 27 Apr 2016 01:21:28 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:21:28 +0800

changeset 0

7ef37b2cdcad

child 748

6845b95cba6b

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/corba/
changeset: 765:f46df0af2ca8
tag: jdk8u25-b17

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