duke@1: /* ohair@158: * Copyright (c) 1995, 2001, Oracle and/or its affiliates. All rights reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as ohair@158: * published by the Free Software Foundation. Oracle designates this duke@1: * particular file as subject to the "Classpath" exception as provided ohair@158: * by Oracle in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * ohair@158: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA ohair@158: * or visit www.oracle.com if you need additional information or have any ohair@158: * questions. duke@1: */ duke@1: duke@1: package org.omg.CORBA; duke@1: duke@1: import org.omg.CORBA.portable.Streamable; duke@1: import org.omg.CORBA.portable.InputStream; duke@1: import org.omg.CORBA.portable.OutputStream; duke@1: duke@1: /** duke@1: * The Holder for String. For more information on duke@1: * Holder files, see duke@1: * "Generated Files: Holder Files".
duke@1: * A Holder class for a String
duke@1: * that is used to store "out" and "inout" parameters in IDL operations.
duke@1: * If an IDL operation signature has an IDL string
as an "out"
duke@1: * or "inout" parameter, the programmer must pass an instance of
duke@1: * StringHolder
as the corresponding
duke@1: * parameter in the method invocation; for "inout" parameters, the programmer
duke@1: * must also fill the "in" value to be sent to the server.
duke@1: * Before the method invocation returns, the ORB will fill in the
duke@1: * value corresponding to the "out" value returned from the server.
duke@1: *
duke@1: * If myStringHolder
is an instance of StringHolder
,
duke@1: * the value stored in its value
field can be accessed with
duke@1: * myStringHolder.value
.
duke@1: *
duke@1: * @since JDK1.2
duke@1: */
duke@1: public final class StringHolder implements Streamable {
duke@1:
duke@1: /**
duke@1: * The String
value held by this StringHolder
duke@1: * object.
duke@1: */
duke@1: public String value;
duke@1:
duke@1: /**
duke@1: * Constructs a new StringHolder
object with its
duke@1: * value
field initialized to null
.
duke@1: */
duke@1: public StringHolder() {
duke@1: }
duke@1:
duke@1: /**
duke@1: * Constructs a new StringHolder
object with its
duke@1: * value
field initialized to the given
duke@1: * String
.
duke@1: * @param initial the String
with which to initialize
duke@1: * the value
field of the newly-created
duke@1: * StringHolder
object
duke@1: */
duke@1: public StringHolder(String initial) {
duke@1: value = initial;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Reads the unmarshalled data from input
and assigns it to
duke@1: * the value
field of this StringHolder
object.
duke@1: *
duke@1: * @param input the InputStream containing CDR formatted data from the wire.
duke@1: */
duke@1: public void _read(InputStream input) {
duke@1: value = input.read_string();
duke@1: }
duke@1:
duke@1: /**
duke@1: * Marshals the value held by this StringHolder
object
duke@1: * to the output stream output
.
duke@1: *
duke@1: * @param output the OutputStream which will contain the CDR formatted data.
duke@1: */
duke@1: public void _write(OutputStream output) {
duke@1: output.write_string(value);
duke@1: }
duke@1:
duke@1: /**
duke@1: * Retrieves the TypeCode
object that corresponds to
duke@1: * the value held in this StringHolder
object.
duke@1: *
duke@1: * @return the type code of the value held in this StringHolder
duke@1: * object
duke@1: */
duke@1: public org.omg.CORBA.TypeCode _type() {
duke@1: return ORB.init().get_primitive_tc(TCKind.tk_string);
duke@1: }
duke@1: }