org.xfp.filters.collections
Class Iterator

java.lang.Object
  org.xfp.AttributeContainer
      org.xfp.Filter
          org.xfp.filters.collections.Iterator

public class Iterator

extends Filter

Outputs an Iterator for the specified Collection. Use this filter to iterate through the elements of a Collection. TODO add skip and max properties

Version:

$Id: Iterator.java,v 1.1 2004/03/19 15:56:44 flaviotordini Exp $

Author:

Flavio Tordini

Nested Class Summary

Nested classes inherited from class org.xfp.Filter

Filter.OnErrorEnum, Filter.OnLoopErrorEnum

Field Summary

Fields inherited from class org.xfp.AttributeContainer

name, parentContainer

Constructor Summary

Iterator()

Method Summary

java.util.Iterator	execute(java.util.Collection collection) Executes this filter.
void	reset() Resets filter status after execution.

Methods inherited from class org.xfp.Filter

getOnError, initialize, log, newInstance, perform, toString

Methods inherited from class org.xfp.AttributeContainer

configureAttributes, disposeAttributes, getAttributes, getFullName, getName, initializeAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

Iterator

public Iterator()

Method Detail

execute

public java.util.Iterator execute(java.util.Collection collection)
                           throws java.lang.Exception

Executes this filter.

Parameters:

collection - The collection on which iterate.

Returns:

An Iterator on the Collection

Throws:

java.lang.Exception

reset

public void reset()

Description copied from class: Filter

Resets filter status after execution. This method is called after execute(), even in case of exceptions. Since a Filter instance may be reused (and actually is), you must use this method to reset all your class members to their default value.

Specified by:

reset in class Filter

See Also:

Filter.reset()