org.openorb.property
Class PropertyNamesIteratorImpl

java.lang.Object
  org.omg.PortableServer.Servant
      org.omg.CosPropertyService.PropertyNamesIteratorPOA
          org.openorb.property.PropertyNamesIteratorImpl

All Implemented Interfaces:

org.omg.CORBA.portable.InvokeHandler, PropertyNamesIteratorOperations

public class PropertyNamesIteratorImpl
extends PropertyNamesIteratorPOA

PropertyNamesIteratorImpl is an implementation of the org.omg.CosPropertyService.PropertyNamesIterator 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_property_names operation returns a sequence of names (PropertyNames). If there are additional names, the get_all_property_names operation returns an object supporting the PropertyNamesIterator interface with the additional names.

The PropertyNamesIterator interface allows a client to iterate through the names using the next_one or next_n operations.

Author:

Jerome Daniel, Terence Song

Constructor Summary

PropertyNamesIteratorImpl(java.lang.String[] property_names)
Creates a new instance of PropertyNamesIteratorImpl.

Method Summary

void	destroy() The destroy operation destroys the iterator.
boolean	next_n(int how_many, PropertyNamesHolder property_names) 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(org.omg.CORBA.StringHolder property_name) The next_one operation returns true if an item exists at the current position in the iterator with an output parameter of a property.
void	reset() The reset operation resets the position in an iterator to the first property, if one exists.

Methods inherited from class org.omg.CosPropertyService.PropertyNamesIteratorPOA

_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

PropertyNamesIteratorImpl

public PropertyNamesIteratorImpl(java.lang.String[] property_names)

Creates a new instance of PropertyNamesIteratorImpl.

Parameters:

property_names - the property names that this iterator will return.

Method Detail

reset

public void reset()

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

next_one

public boolean next_one(org.omg.CORBA.StringHolder property_name)

The next_one operation returns true if an item exists at the current position in the iterator with an output parameter of a property. A return of false signifies no more items in the iterator.

Parameters:

property_name - the retrieved property name is returned in the output parameter.

Returns:

true if a property name was retrieved.

next_n

public boolean next_n(int how_many,
                      PropertyNamesHolder property_names)

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 properties sequence with at most the how_many number of properties. A return of false signifies no more items in the iterator.

Parameters:

how_many - the number of property names to retrieve.

property_names - the sequence of retrieved property names is returned in the output parameter.

Returns:

true if at least one property name was retrieved.

destroy

public void destroy()

The destroy operation destroys the iterator.