|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PropertiesIteratorOperations
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.
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. |
Method Detail |
---|
void reset()
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.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.void destroy()
destroy
operation destroys the iterator.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |