|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.omg.PortableServer.Servant
org.omg.CosPropertyService.PropertiesIteratorPOA
org.openorb.property.PropertiesIteratorImpl
public class PropertiesIteratorImpl
PropertiesIteratorImpl
is an implementation of the
org.omg.CosPropertyService.PropertiesIterator
interface.
An object of this interface type is returned by the
org.omg.CosPropertyService.PropertySet
interface.
A PropertySet
maintains a set of name-value pairs. The
get_all_properties
operation of the PropertySet
interface returns a sequence of Property
structures (Properties).
If there are additional properties, the get_all_properties
operation returns an object supporting the PropertiesIterator
interface with the additional properties.
The PropertiesIterator
interface allows a client to iterate
through the name-value pairs using the next_one
or
next_n
operations.
Constructor Summary | |
---|---|
PropertiesIteratorImpl(Property[] properties)
Creates a new instance of PropertiesIteratorImpl . |
Method Summary | |
---|---|
void |
destroy()
The destroy operation destroys the iterator. |
boolean |
next_n(int how_many,
PropertiesHolder nproperties)
The next_n operation returns true if
an item exists at the current position in the iterator and the
how_many parameter was set greater than zero. |
boolean |
next_one(PropertyHolder aproperty)
The next_one operation returns true
if an item exists at the current position in the iterator with
an output parameter of a property name. |
void |
reset()
The reset operation resets the position in an iterator to the first property name, if one exists. |
Methods inherited from class org.omg.CosPropertyService.PropertiesIteratorPOA |
---|
_all_interfaces, _invoke, _this, _this |
Methods inherited from class org.omg.PortableServer.Servant |
---|
_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PropertiesIteratorImpl(Property[] properties)
PropertiesIteratorImpl
.
properties
- the properties that this iterator will return.Method Detail |
---|
public void reset()
public boolean next_one(PropertyHolder aproperty)
next_one
operation returns true
if an item exists at the current position in the iterator with
an output parameter of a property name. A return of
false
signifies no more items in the iterator.
aproperty
- the retrieved property is returned in the output parameter.
true
if a property name was retrieved.public boolean next_n(int how_many, PropertiesHolder nproperties)
next_n
operation returns true
if
an item exists at the current position in the iterator and the
how_many
parameter was set greater than zero. The
output is a PropertyNames
sequence with at most
the how_many
number of names. A return of
false
signifies no more items in the iterator.
how_many
- the number of properties to retrieve.nproperties
- the sequence of retrieved properties
is returned in the output parameter.
true
if at least one property was retrieved.public void destroy()
destroy
operation destroys the iterator.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |