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

Mon, 14 Jun 2010 11:28:53 -0700

author
jjg
date
Mon, 14 Jun 2010 11:28:53 -0700
changeset 173
032585ad970d
parent 158
91006f157c46
child 748
6845b95cba6b
permissions
-rw-r--r--

6960831: fix CORBA build warnings
Reviewed-by: darcy

duke@1 1 /*
ohair@158 2 * Copyright (c) 1997, 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 * The Holder for <tt>Int</tt>. For more information on
duke@1 34 * Holder files, see <a href="doc-files/generatedfiles.html#holder">
duke@1 35 * "Generated Files: Holder Files"</a>.<P>
duke@1 36 * A Holder class for an <code>int</code>
duke@1 37 * that is used to store "out" and "inout" parameters in IDL methods.
duke@1 38 * If an IDL method signature has an IDL <code>long</code> as an "out"
duke@1 39 * or "inout" parameter, the programmer must pass an instance of
duke@1 40 * <code>IntHolder</code> as the corresponding
duke@1 41 * parameter in the method invocation; for "inout" parameters, the programmer
duke@1 42 * must also fill the "in" value to be sent to the server.
duke@1 43 * Before the method invocation returns, the ORB will fill in the
duke@1 44 * value corresponding to the "out" value returned from the server.
duke@1 45 * <P>
duke@1 46 * If <code>myIntHolder</code> is an instance of <code>IntHolder</code>,
duke@1 47 * the value stored in its <code>value</code> field can be accessed with
duke@1 48 * <code>myIntHolder.value</code>.
duke@1 49 *
duke@1 50 * @since JDK1.2
duke@1 51 */
duke@1 52 public final class IntHolder implements Streamable {
duke@1 53
duke@1 54 /**
duke@1 55 * The <code>int</code> value held by this <code>IntHolder</code>
duke@1 56 * object in its <code>value</code> field.
duke@1 57 */
duke@1 58 public int value;
duke@1 59
duke@1 60 /**
duke@1 61 * Constructs a new <code>IntHolder</code> object with its
duke@1 62 * <code>value</code> field initialized to <code>0</code>.
duke@1 63 */
duke@1 64 public IntHolder() {
duke@1 65 }
duke@1 66
duke@1 67 /**
duke@1 68 * Constructs a new <code>IntHolder</code> object with its
duke@1 69 * <code>value</code> field initialized to the given
duke@1 70 * <code>int</code>.
duke@1 71 * @param initial the <code>int</code> with which to initialize
duke@1 72 * the <code>value</code> field of the newly-created
duke@1 73 * <code>IntHolder</code> object
duke@1 74 */
duke@1 75 public IntHolder(int initial) {
duke@1 76 value = initial;
duke@1 77 }
duke@1 78
duke@1 79 /**
duke@1 80 * Reads unmarshalled data from <code>input</code> and assigns it to
duke@1 81 * the <code>value</code> field in this <code>IntHolder</code> object.
duke@1 82 *
duke@1 83 * @param input the <code>InputStream</code> object containing CDR
duke@1 84 * formatted data from the wire
duke@1 85 */
duke@1 86 public void _read(InputStream input) {
duke@1 87 value = input.read_long();
duke@1 88 }
duke@1 89
duke@1 90 /**
duke@1 91 * Marshals the value in this <code>IntHolder</code> object's
duke@1 92 * <code>value</code> field to the output stream <code>output</code>.
duke@1 93 *
duke@1 94 * @param output the <code>OutputStream</code> object that will contain
duke@1 95 * the CDR formatted data
duke@1 96 */
duke@1 97 public void _write(OutputStream output) {
duke@1 98 output.write_long(value);
duke@1 99 }
duke@1 100
duke@1 101 /**
duke@1 102 * Retrieves the <code>TypeCode</code> object that corresponds
duke@1 103 * to the value held in this <code>IntHolder</code> object's
duke@1 104 * <code>value</code> field.
duke@1 105 *
duke@1 106 * @return the type code for the value held in this <code>IntHolder</code>
duke@1 107 * object
duke@1 108 */
duke@1 109 public org.omg.CORBA.TypeCode _type() {
duke@1 110 return ORB.init().get_primitive_tc(TCKind.tk_long);
duke@1 111 }
duke@1 112 }

mercurial