cutthecrap.utils.striterators

Class Expander

java.lang.Object

cutthecrap.utils.striterators.FilterBase

cutthecrap.utils.striterators.Expander

All Implemented Interfaces:

IContextMgr, IFilter, IPropertySet, Serializable, Cloneable

public abstract class Expander
extends FilterBase
implements IContextMgr

Expander Used with Expanderator by Striterator to expand returned objects. Derivations must implement expand method. If an Expander wants to track the context it should return a non-null value for getContextMgr. This ensures that the Expanderator will not optimize itself away in a tail recursion operation that would prevent the correct protocol implementation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Expander()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Iterator	expand(Object obj)
Iterator	filterOnce(Iterator src, Object context) Wrap the source iterator with this filter.
protected IContextMgr	getContextMgr()
void	popContext() callback to implementation when expansion is complete
void	pushContext(Object context) Hook gives the implementation an opportunity to push context onto a stack.

Methods inherited from class cutthecrap.utils.striterators.FilterBase

addFilter, filter, getProperty, getRequiredProperty, setProperty, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Expander

public Expander()

Method Detail

filterOnce

public final Iterator filterOnce(Iterator src,
                  Object context)

Description copied from class: FilterBase

Wrap the source iterator with this filter.

Specified by:

filterOnce in class FilterBase

Parameters:

src - The source iterator.

context - The iterator evaluation context.

Returns:

The wrapped iterator.

expand

protected abstract Iterator expand(Object obj)

popContext

public void popContext()

callback to implementation when expansion is complete

Specified by:

popContext in interface IContextMgr

pushContext

public void pushContext(Object context)

Description copied from interface: IContextMgr

Hook gives the implementation an opportunity to push context onto a stack.

Specified by:

pushContext in interface IContextMgr

Parameters:

context - The context object.

getContextMgr

protected IContextMgr getContextMgr()