Package org.omg.CORBA
Class NVList
java.lang.Object
org.omg.CORBA.NVList
- Direct Known Subclasses:
NVListImpl
A modifiable list containing
NamedValue
objects.
The class NVList
is used as follows:
- to describe arguments for a
Request
object in the Dynamic Invocation Interface and the Dynamic Skeleton Interface - to describe context values in a
Context
object
Each NamedValue
object consists of the following:
- a name, which is a
String
object - a value, as an
Any
object - an argument mode flag
An NVList
object
may be created using one of the following
ORB
methods:
org.omg.CORBA.ORB.create_list
org.omg.CORBA.NVList nv = orb.create_list(3);
The variablenv
represents a newly-createdNVList
object. The argument is a memory-management hint to the orb and does not imply the actual length of the list. If, for example, you want to use anNVList
object in a request, and the method being invoked takes three parameters, you might optimize by supplying 3 to the methodcreate_list
. Note that the newNVList
will not necessarily have a length of 3; it could have a length of 2 or 4, for instance. Note also that you can add any number ofNamedValue
objects to this list regardless of its original length.org.omg.CORBA.ORB.create_operation_list
org.omg.CORBA.NVList nv = orb.create_operation_list(myOperationDef);
The variablenv
represents a newly-createdNVList
object that contains descriptions of the arguments to the method described in the givenOperationDef
object.
The methods in the class NVList
all deal with
the NamedValue
objects in the list.
There are three methods for adding a NamedValue
object,
a method for getting the count of NamedValue
objects in
the list, a method for retrieving a NamedValue
object
at a given index, and a method for removing a NamedValue
object
at a given index.
- Since:
- JDK1.2
- Version:
- 1.14 ,09/09/97
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract NamedValue
add
(int flags) Creates a newNamedValue
object initialized with the given flag and adds it to the end of thisNVList
object.abstract NamedValue
Creates a newNamedValue
object initialized with the given name and flag, and adds it to the end of thisNVList
object.abstract NamedValue
Creates a newNamedValue
object initialized with the given name, value, and flag, and adds it to the end of thisNVList
object.abstract int
count()
Returns the number ofNamedValue
objects that have been added to thisNVList
object.abstract NamedValue
item
(int index) Retrieves theNamedValue
object at the given index.abstract void
remove
(int index) Removes theNamedValue
object at the given index.
-
Constructor Details
-
NVList
public NVList()
-
-
Method Details
-
count
public abstract int count()Returns the number ofNamedValue
objects that have been added to thisNVList
object.- Returns:
- an
int
indicating the number ofNamedValue
objects in thisNVList
.
-
add
Creates a newNamedValue
object initialized with the given flag and adds it to the end of thisNVList
object. The flag can be any one of the argument passing modes:ARG_IN.value
,ARG_OUT.value
, orARG_INOUT.value
.- Parameters:
flags
- one of the argument mode flags- Returns:
- the newly-created
NamedValue
object
-
add_item
Creates a newNamedValue
object initialized with the given name and flag, and adds it to the end of thisNVList
object. The flag can be any one of the argument passing modes:ARG_IN.value
,ARG_OUT.value
, orARG_INOUT.value
.- Parameters:
item_name
- the name for the newNamedValue
objectflags
- one of the argument mode flags- Returns:
- the newly-created
NamedValue
object
-
add_value
Creates a newNamedValue
object initialized with the given name, value, and flag, and adds it to the end of thisNVList
object.- Parameters:
item_name
- the name for the newNamedValue
objectval
- anAny
object containing the value for the newNamedValue
objectflags
- one of the following argument passing modes:ARG_IN.value
,ARG_OUT.value
, orARG_INOUT.value
- Returns:
- the newly created
NamedValue
object
-
item
Retrieves theNamedValue
object at the given index.- Parameters:
index
- the index of the desiredNamedValue
object, which must be between zero and the length of the list minus one, inclusive. The first item is at index zero.- Returns:
- the
NamedValue
object at the given index - Throws:
Bounds
- if the index is greater than or equal to number ofNamedValue
objects
-
remove
Removes theNamedValue
object at the given index. Note that the indices of allNamedValue
objects following the one removed are shifted down by one.- Parameters:
index
- the index of theNamedValue
object to be removed, which must be between zero and the length of the list minus one, inclusive. The first item is at index zero.- Throws:
Bounds
- if the index is greater than or equal to number ofNamedValue
objects in the list
-