org.cactoos.iterator

Class Filtered<X>

java.lang.Object

org.cactoos.iterator.Filtered<X>

Type Parameters:

X - Type of item

All Implemented Interfaces:

Iterator<X>

public final class Filtered<X>
extends Object
implements Iterator<X>

Filtered iterator.

You can use it in order to create a declarative/lazy version of a filtered collection/iterable. For example, this code will create a list of two strings "hello" and "world":

 Iterator<String> list = new Filtered<>(
   new ArrayOf<>(
     "hey", "hello", "world"
   ).iterator(),
   input -> input.length() > 4
 );
 

There is no thread-safety guarantee.

Since:

0.1

Version:

$Id: 74cc73188026005ec1f1047b8914a03394f03e87 $

Author:

Yegor Bugayenko ([email protected])

See Also:

Filtered

Constructor Summary

Constructors

Constructor and Description
Filtered(Iterator<X> src, Func<X,Boolean> fnc) Ctor.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
X	next()
void	remove()

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

Filtered

public Filtered(Iterator<X> src,
                Func<X,Boolean> fnc)

Ctor.

Parameters:

src - Source iterable

fnc - Predicate

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<X>

next

public X next()

Specified by:

next in interface Iterator<X>

remove

public void remove()

Specified by:

remove in interface Iterator<X>