StringHolder.java revision 608:7e06bf1dcb09
113628Salexsch/* 213628Salexsch * Copyright (c) 1995, 2001, Oracle and/or its affiliates. All rights reserved. 313628Salexsch * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 413628Salexsch * 513628Salexsch * This code is free software; you can redistribute it and/or modify it 613628Salexsch * under the terms of the GNU General Public License version 2 only, as 713628Salexsch * published by the Free Software Foundation. Oracle designates this 813628Salexsch * particular file as subject to the "Classpath" exception as provided 913628Salexsch * by Oracle in the LICENSE file that accompanied this code. 1013628Salexsch * 1113628Salexsch * This code is distributed in the hope that it will be useful, but WITHOUT 1213628Salexsch * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1313628Salexsch * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1413628Salexsch * version 2 for more details (a copy is included in the LICENSE file that 1513628Salexsch * accompanied this code). 1613628Salexsch * 1713628Salexsch * You should have received a copy of the GNU General Public License version 1813628Salexsch * 2 along with this work; if not, write to the Free Software Foundation, 1913628Salexsch * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2013628Salexsch * 2113628Salexsch * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2213628Salexsch * or visit www.oracle.com if you need additional information or have any 2313628Salexsch * questions. 2413628Salexsch */ 2513628Salexsch 2613628Salexschpackage org.omg.CORBA; 2713628Salexsch 2813628Salexschimport org.omg.CORBA.portable.Streamable; 2913628Salexschimport org.omg.CORBA.portable.InputStream; 3013628Salexschimport org.omg.CORBA.portable.OutputStream; 3113628Salexsch 3213628Salexsch/** 3313628Salexsch * The Holder for <tt>String</tt>. For more information on 3413628Salexsch * Holder files, see <a href="doc-files/generatedfiles.html#holder"> 3513628Salexsch * "Generated Files: Holder Files"</a>.<P> 3613628Salexsch * A Holder class for a <code>String</code> 3713628Salexsch * that is used to store "out" and "inout" parameters in IDL operations. 3813628Salexsch * If an IDL operation signature has an IDL <code>string</code> as an "out" 3913628Salexsch * or "inout" parameter, the programmer must pass an instance of 4013628Salexsch * <code>StringHolder</code> as the corresponding 4113628Salexsch * parameter in the method invocation; for "inout" parameters, the programmer 4213628Salexsch * must also fill the "in" value to be sent to the server. 4313628Salexsch * Before the method invocation returns, the ORB will fill in the 4413628Salexsch * value corresponding to the "out" value returned from the server. 4513628Salexsch * <P> 4613628Salexsch * If <code>myStringHolder</code> is an instance of <code>StringHolder</code>, 4713628Salexsch * the value stored in its <code>value</code> field can be accessed with 4813628Salexsch * <code>myStringHolder.value</code>. 4913628Salexsch * 5013628Salexsch * @since JDK1.2 51 */ 52public final class StringHolder implements Streamable { 53 54 /** 55 * The <code>String</code> value held by this <code>StringHolder</code> 56 * object. 57 */ 58 public String value; 59 60 /** 61 * Constructs a new <code>StringHolder</code> object with its 62 * <code>value</code> field initialized to <code>null</code>. 63 */ 64 public StringHolder() { 65 } 66 67 /** 68 * Constructs a new <code>StringHolder</code> object with its 69 * <code>value</code> field initialized to the given 70 * <code>String</code>. 71 * @param initial the <code>String</code> with which to initialize 72 * the <code>value</code> field of the newly-created 73 * <code>StringHolder</code> object 74 */ 75 public StringHolder(String initial) { 76 value = initial; 77 } 78 79 /** 80 * Reads the unmarshalled data from <code>input</code> and assigns it to 81 * the <code>value</code> field of this <code>StringHolder</code> object. 82 * 83 * @param input the InputStream containing CDR formatted data from the wire. 84 */ 85 public void _read(InputStream input) { 86 value = input.read_string(); 87 } 88 89 /** 90 * Marshals the value held by this <code>StringHolder</code> object 91 * to the output stream <code>output</code>. 92 * 93 * @param output the OutputStream which will contain the CDR formatted data. 94 */ 95 public void _write(OutputStream output) { 96 output.write_string(value); 97 } 98 99 /** 100 * Retrieves the <code>TypeCode</code> object that corresponds to 101 * the value held in this <code>StringHolder</code> object. 102 * 103 * @return the type code of the value held in this <code>StringHolder</code> 104 * object 105 */ 106 public org.omg.CORBA.TypeCode _type() { 107 return ORB.init().get_primitive_tc(TCKind.tk_string); 108 } 109} 110