FilterIterator (dom4j API)

java.lang.Object
- org.dom4j.tree.FilterIterator<T>

All Implemented Interfaces:

Iterator<T>

Direct Known Subclasses:

ElementIterator, ElementNameIterator, ElementQNameIterator
```
public abstract class FilterIterator<T>
extends Object
implements Iterator<T>
```
Deprecated.
THIS CLASS WILL BE REMOVED IN dom4j-1.6 !!

FilterIterator is an abstract base class which is useful for implementors of Iteratorwhich filter an existing iterator.

Field Summary

Fields
Modifier and Type Field Description

protected Iterator<T> proxy
Deprecated.

Constructor Summary

Constructors
Constructor Description

FilterIterator(Iterator<T> proxy)
Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected T`	`findNext()`	Deprecated.
`boolean`	`hasNext()`	Deprecated.
`protected abstract boolean`	`matches(T element)`	Deprecated. Filter method to perform some matching on the given element.
`T`	`next()`	Deprecated.
`void`	`remove()`	Deprecated. Always throws UnsupportedOperationException as this class does look-ahead with its internal iterator.

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

- Field Detail
  - proxy
```
protected Iterator<T> proxy
```
    Deprecated.
- Constructor Detail
  - FilterIterator
```
public FilterIterator(Iterator<T> proxy)
```
    Deprecated.
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Deprecated.
    
    Specified by:
    
    hasNext in interface Iterator<T>
  - next
```
public T next()
       throws NoSuchElementException
```
    Deprecated.
    
    Specified by:
    
    next in interface Iterator<T>
    
    Throws:
    
    NoSuchElementException
  - remove
```
public void remove()
```
    Deprecated.
    
    Always throws UnsupportedOperationException as this class does look-ahead with its internal iterator.
    
    Specified by:
    
    remove in interface Iterator<T>
    
    Throws:
    
    UnsupportedOperationException - always
  - matches
```
protected abstract boolean matches(T element)
```
    Deprecated.
    
    Filter method to perform some matching on the given element.
    
    Parameters:
    
    element - DOCUMENT ME!
    
    Returns:
    
    true if the given element matches the filter and should be appear in the iteration
  - findNext
```
protected T findNext()
```
    Deprecated.