openconnector

Class FilteredIterator

java.lang.Object

openconnector.FilteredIterator

All Implemented Interfaces:

java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>

public class FilteredIterator
extends java.lang.Object
implements java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>

An iterator that wraps another iterator and filters such that the returned objects must match the provided filter.

If possible, Connector implementations should natively implement filtering by querying rather than using a FilterIterator. A FilterIterator can be slow an resource intensive.

Constructor Summary

Constructors

Constructor and Description
FilteredIterator(java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> it, Filter f) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
static boolean	matches(java.util.Map<java.lang.String,java.lang.Object> obj, Filter f)
java.util.Map<java.lang.String,java.lang.Object>	next()
void	remove() Not implemented - throws an UnsupportedOperationException.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

FilteredIterator

public FilteredIterator(java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> it,
                        Filter f)

Constructor.

Parameters:

it - The Iterator that is being wrapped.

f - The Filter to use to filter the iterator results. If null, the iterator is not filtered.

Throws:

java.lang.IllegalArgumentException - If the given iterator is null.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>

Returns:

whether this iterator has any more elements.

next

public java.util.Map<java.lang.String,java.lang.Object> next()
                                                      throws java.util.NoSuchElementException

Specified by:

next in interface java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>

Returns:

the next element from this iterator or throw

Throws:

java.util.NoSuchElementException - if the iterator has been exhausted.

remove

public void remove()
            throws java.lang.UnsupportedOperationException

Not implemented - throws an UnsupportedOperationException.

Specified by:

remove in interface java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>

Throws:

java.lang.UnsupportedOperationException

matches

public static boolean matches(java.util.Map<java.lang.String,java.lang.Object> obj,
                              Filter f)

Returns:

whether the given map matches the given filter.