org.infinispan.commons.util

Class FilterSpliterator<T>

java.lang.Object

org.infinispan.commons.util.FilterSpliterator<T>

All Implemented Interfaces:

AutoCloseable, Spliterator<T>, CloseableSpliterator<T>

public class FilterSpliterator<T>
extends Object
implements CloseableSpliterator<T>

Spliterator that only returns entries that pass the given predicate. This spliterator will inherit all of the characteristics of the underlying spliterator, except that it won't return Spliterator.SIZED or Spliterator.SUBSIZED.

The forEachRemaining(Consumer) method should provide better performance than calling tryAdvance(Consumer) until it returns false. This is due to having to capture the argument before testing it and finally invoking the provided Consumer.

Since:

9.3

Author:

wburns

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T,T_CONS,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary

Constructors

Constructor and Description
FilterSpliterator(Spliterator<T> spliterator, Predicate<? super T> predicate)

Method Summary

Modifier and Type	Method and Description
int	characteristics()
void	close()
long	estimateSize()
void	forEachRemaining(Consumer<? super T> action)
boolean	tryAdvance(Consumer<? super T> action)
Spliterator<T>	trySplit()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Spliterator

getComparator, getExactSizeIfKnown, hasCharacteristics

Constructor Detail

FilterSpliterator

public FilterSpliterator(Spliterator<T> spliterator,
                         Predicate<? super T> predicate)

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CloseableSpliterator<T>

tryAdvance

public boolean tryAdvance(Consumer<? super T> action)

Specified by:

tryAdvance in interface Spliterator<T>

forEachRemaining

public void forEachRemaining(Consumer<? super T> action)

Specified by:

forEachRemaining in interface Spliterator<T>

trySplit

public Spliterator<T> trySplit()

Specified by:

trySplit in interface Spliterator<T>

estimateSize

public long estimateSize()

Specified by:

estimateSize in interface Spliterator<T>

characteristics

public int characteristics()

Specified by:

characteristics in interface Spliterator<T>