001: /*
002: * Copyright 1996-1999 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package org.omg.CORBA;
027:
028: /**
029: * An object used in the DII and DSI to describe
030: * arguments and return values. <code>NamedValue</code> objects
031: * are also used in the <code>Context</code>
032: * object routines to pass lists of property names and values.
033: * <P>
034: * A <code>NamedValue</code> object contains:
035: * <UL>
036: * <LI>a name -- If the <code>NamedValue</code> object is used to
037: * describe arguments to a request, the name will be an argument
038: * identifier specified in the OMG IDL interface definition
039: * for the operation being described.
040: * <LI>a value -- an <code>Any</code> object
041: * <LI>an argument mode flag -- one of the following:
042: * <UL>
043: * <LI><code>ARG_IN.value</code>
044: * <LI><code>ARG_OUT.value</code>
045: * <LI><code>ARG_INOUT.value</code>
046: * <LI>zero -- if this <code>NamedValue</code> object represents a property
047: * in a <code>Context</code> object rather than a parameter or
048: * return value
049: * </UL>
050: * </UL>
051: * <P>
052: * The class <code>NamedValue</code> has three methods, which
053: * access its fields. The following code fragment demonstrates
054: * creating a <code>NamedValue</code> object and then accessing
055: * its fields:
056: * <PRE>
057: * ORB orb = ORB.init(args, null);
058: * String s = "argument_1";
059: * org.omg.CORBA.Any myAny = orb.create_any();
060: * myAny.insert_long(12345);
061: * int in = org.omg.CORBA.ARG_IN.value;
062:
063: * org.omg.CORBA.NamedValue nv = orb.create_named_value(
064: * s, myAny, in);
065: * System.out.println("This nv name is " + nv.name());
066: * try {
067: * System.out.println("This nv value is " + nv.value().extract_long());
068: * System.out.println("This nv flag is " + nv.flags());
069: * } catch (org.omg.CORBA.BAD_OPERATION b) {
070: * System.out.println("extract failed");
071: * }
072: * </PRE>
073: *
074: * <P>
075: * If this code fragment were put into a <code>main</code> method,
076: * the output would be something like the following:
077: * <PRE>
078: * This nv name is argument_1
079: * This nv value is 12345
080: * This nv flag is 1
081: * </PRE>
082: * <P>
083: * Note that the method <code>value</code> returns an <code>Any</code>
084: * object. In order to access the <code>long</code> contained in the
085: * <code>Any</code> object,
086: * we used the method <code>extract_long</code>.
087: *
088: * @see Any
089: * @see ARG_IN
090: * @see ARG_INOUT
091: * @see ARG_OUT
092: *
093: * @version 1.12 ,09/09/97
094: * @since JDK1.2
095: */
096:
097: public abstract class NamedValue {
098:
099: /**
100: * Retrieves the name for this <code>NamedValue</code> object.
101: *
102: * @return a <code>String</code> object representing
103: * the name of this <code>NamedValue</code> object
104: */
105:
106: public abstract String name();
107:
108: /**
109: * Retrieves the value for this <code>NamedValue</code> object.
110: *
111: * @return an <code>Any</code> object containing
112: * the value of this <code>NamedValue</code> object
113: */
114:
115: public abstract Any value();
116:
117: /**
118: * Retrieves the argument mode flag for this <code>NamedValue</code> object.
119: *
120: * @return an <code>int</code> representing the argument
121: * mode for this <code>NamedValue</code> object
122: */
123:
124: public abstract int flags();
125:
126: }
|