duke@1: /*
ohair@158:  * Copyright (c) 1996, 1999, 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: /**
duke@1:  * An object used in the DII and DSI to describe
duke@1:  * arguments and return values. <code>NamedValue</code> objects
duke@1:  * are also used in the <code>Context</code>
duke@1:  * object routines to pass lists of property names and values.
duke@1:  * <P>
duke@1:  * A <code>NamedValue</code> object contains:
duke@1:  * <UL>
duke@1:  * <LI>a name -- If the <code>NamedValue</code> object is used to
duke@1:  * describe arguments to a request, the name will be an argument
duke@1:  * identifier specified in the OMG IDL interface definition
duke@1:  * for the operation being described.
duke@1:  * <LI>a value -- an <code>Any</code> object
duke@1:  * <LI>an argument mode flag -- one of the following:
duke@1:  *   <UL>
duke@1:  *    <LI><code>ARG_IN.value</code>
duke@1:  *    <LI><code>ARG_OUT.value</code>
duke@1:  *    <LI><code>ARG_INOUT.value</code>
duke@1:  *    <LI>zero -- if this <code>NamedValue</code> object represents a property
duke@1:  *                in a <code>Context</code> object rather than a parameter or
duke@1:  *                return value
duke@1:  *   </UL>
duke@1:  * </UL>
duke@1:  * <P>
duke@1:  * The class <code>NamedValue</code> has three methods, which
duke@1:  * access its fields.  The following code fragment demonstrates
duke@1:  * creating a <code>NamedValue</code> object and then accessing
duke@1:  * its fields:
duke@1:  * <PRE>
duke@1:  *    ORB orb = ORB.init(args, null);
duke@1:  *    String s = "argument_1";
duke@1:  *    org.omg.CORBA.Any myAny = orb.create_any();
duke@1:  *    myAny.insert_long(12345);
duke@1:  *    int in = org.omg.CORBA.ARG_IN.value;
duke@1: 
duke@1:  *    org.omg.CORBA.NamedValue nv = orb.create_named_value(
duke@1:  *        s, myAny, in);
duke@1:  *    System.out.println("This nv name is " + nv.name());
duke@1:  *    try {
duke@1:  *        System.out.println("This nv value is " + nv.value().extract_long());
duke@1:  *        System.out.println("This nv flag is " + nv.flags());
duke@1:  *    } catch (org.omg.CORBA.BAD_OPERATION b) {
duke@1:  *      System.out.println("extract failed");
duke@1:  *    }
duke@1:  * </PRE>
duke@1:  *
duke@1:  * <P>
duke@1:  * If this code fragment were put into a <code>main</code> method,
duke@1:  * the output would be something like the following:
duke@1:  * <PRE>
duke@1:  *    This nv name is argument_1
duke@1:  *    This nv value is 12345
duke@1:  *    This nv flag is 1
duke@1:  * </PRE>
duke@1:  * <P>
duke@1:  * Note that the method <code>value</code> returns an <code>Any</code>
duke@1:  * object. In order to access the <code>long</code> contained in the
duke@1:  * <code>Any</code> object,
duke@1:  * we used the method <code>extract_long</code>.
duke@1:  *
duke@1:  * @see Any
duke@1:  * @see ARG_IN
duke@1:  * @see ARG_INOUT
duke@1:  * @see ARG_OUT
duke@1:  *
duke@1:  * @since       JDK1.2
duke@1:  */
duke@1: 
duke@1: public abstract class NamedValue {
duke@1: 
duke@1:     /**
duke@1:      * Retrieves the name for this <code>NamedValue</code> object.
duke@1:      *
duke@1:      * @return                  a <code>String</code> object representing
duke@1:      *                    the name of this <code>NamedValue</code> object
duke@1:      */
duke@1: 
duke@1:     public abstract String name();
duke@1: 
duke@1:     /**
duke@1:      * Retrieves the value for this <code>NamedValue</code> object.
duke@1:      *
duke@1:      * @return                  an <code>Any</code> object containing
duke@1:      *                    the value of this <code>NamedValue</code> object
duke@1:      */
duke@1: 
duke@1:     public abstract Any value();
duke@1: 
duke@1:     /**
duke@1:      * Retrieves the argument mode flag for this <code>NamedValue</code> object.
duke@1:      *
duke@1:      * @return                  an <code>int</code> representing the argument
duke@1:      *                    mode for this <code>NamedValue</code> object
duke@1:      */
duke@1: 
duke@1:     public abstract int flags();
duke@1: 
duke@1: }