org.omg.CORBA.ByteHolder Maven / Gradle / Ivy

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
 * v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License v2.0
 * w/Classpath exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause OR GPL-2.0 WITH
 * Classpath-exception-2.0
 */

package org.omg.CORBA;

import org.omg.CORBA.portable.Streamable;
import org.omg.CORBA.portable.InputStream;
import org.omg.CORBA.portable.OutputStream;

/**
 * The Holder for Byte.  For more information on 
 * Holder files, see 
 * "Generated Files: Holder Files".
 * A Holder class for a byte
 * that is used to store "out" and "inout" parameters in IDL methods.
 * If an IDL method signature has an IDL octet as an "out"
 * or "inout" parameter, the programmer must pass an instance of
 * ByteHolder as the corresponding
 * parameter in the method invocation; for "inout" parameters, the programmer
 * must also fill the "in" value to be sent to the server.
 * Before the method invocation returns, the ORB will fill in the
 * value corresponding to the "out" value returned from the server.
 * 
 * If myByteHolder is an instance of ByteHolder,
 * the value stored in its value field can be accessed with
 * myByteHolder.value.
 *
 * @version     1.14, 09/09/97
 * @since       JDK1.2
 */
public final class ByteHolder implements Streamable {
    /**
     * The byte value held by this ByteHolder
     * object.
     */

    public byte value;

    /**
     * Constructs a new ByteHolder object with its
     * value field initialized to 0.
     */
    public ByteHolder() {
    }

    /**
     * Constructs a new ByteHolder object for the given
     * byte.
     * @param initial the byte with which to initialize
     *                the value field of the new
     *                ByteHolder object
     */
    public ByteHolder(byte initial) {
        value = initial;
    }

    /**
     * Reads from input and initalizes the value in
     * this ByteHolder object
     * with the unmarshalled data.
     *
     * @param input the InputStream containing CDR formatted data from the wire.
     */
    public void _read(InputStream input) {
        value = input.read_octet();
    }

    /**
     * Marshals to output the value in 
     * this ByteHolder object.
     *
     * @param output the OutputStream which will contain the CDR formatted data.
     */
    public void _write(OutputStream output) {
        output.write_octet(value);
    }

    /**
     * Returns the TypeCode corresponding to the value held in
     * this ByteHolder object.
     *
     * @return    the TypeCode of the value held in 
     *               this ByteHolder object
     */
    public org.omg.CORBA.TypeCode _type() {
        return ORB.init().get_primitive_tc(TCKind.tk_octet);
    }
}