org.eclipse.birt.report.model.api
Class StructureIterator

java.lang.Object
  org.eclipse.birt.report.model.api.StructureIterator

All Implemented Interfaces:

java.util.Iterator

public class StructureIterator

extends java.lang.Object

implements java.util.Iterator

Iterates over the structures within a property or member defined as a list of structures. Each object returned by getNext( ) is of type StructureHandle.

Field Summary

protected int	index The count over the list positions.
protected java.util.ArrayList	list Cached copy of the property list.
protected SimpleValueHandle	valueHandle Handle to the property or member that contains the list.

Constructor Summary

StructureIterator(SimpleValueHandle handle)
Constructs an structure iterator for the property or member that has the list of structures over which to iterate.

Method Summary

boolean	hasNext()
java.lang.Object	next() Returns a handle to the next structure in the list.
void	remove() Removes the structure at the current position.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

valueHandle

protected final SimpleValueHandle valueHandle

Handle to the property or member that contains the list.

list

protected final java.util.ArrayList list

Cached copy of the property list.

index

protected int index

The count over the list positions.

Constructor Detail

StructureIterator

public StructureIterator(SimpleValueHandle handle)

Constructs an structure iterator for the property or member that has the list of structures over which to iterate.

Parameters:

handle - handle to the property or member that has the list of structures over which to iterate

Method Detail

remove

public void remove()

Removes the structure at the current position.

Specified by:

remove in interface java.util.Iterator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator

next

public java.lang.Object next()

Returns a handle to the next structure in the list. The handle is of type StructureHandle

Specified by:

next in interface java.util.Iterator

Returns:

a handle to the next structure in the list

See Also:

StructureHandle