org.openorb.property
Class PropertiesIteratorImpl

java.lang.Object
  |
  +--org.omg.PortableServer.Servant
        |
        +--org.omg.CosPropertyService.PropertiesIteratorPOA
              |
              +--org.openorb.property.PropertiesIteratorImpl

All Implemented Interfaces:

org.omg.CORBA.portable.InvokeHandler, PropertiesIteratorOperations

public class PropertiesIteratorImpl

extends PropertiesIteratorPOA

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.

Author:

Jerome Daniel, Terence Song

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, _get_interface, _is_a, _non_existent, _object_id, _orb, _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

PropertiesIteratorImpl

public PropertiesIteratorImpl(Property[] properties)

Creates a new instance of PropertiesIteratorImpl.

Parameters:

properties - the properties that this iterator will return.

Method Detail

reset

public void reset()

The reset operation resets the position in an iterator to the first property name, if one exists.

next_one

public 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. A return of false signifies no more items in the iterator.

Parameters:

aproperty - the retrieved property is returned in the output parameter.

Returns:

true if a property name was retrieved.

next_n

public 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. 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.

Parameters:

how_many - the number of properties to retrieve.

nproperties - the sequence of retrieved properties is returned in the output parameter.

Returns:

true if at least one property was retrieved.

destroy

public void destroy()

The destroy operation destroys the iterator.