Package nl.vpro.util

Class FilteringIterator<T>

java.lang.Object

nl.vpro.util.FilteringIterator<T>

All Implemented Interfaces:

AutoCloseable, Iterator<T>, CloseableIterator<T>

public class FilteringIterator<T>
extends Object
implements CloseableIterator<T>

Filtering, or Transforming iterator.

Since:

1.3

Author:

Michiel Meeuwissen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilteringIterator.Builder<T>
static class	FilteringIterator.KeepAlive

Nested classes/interfaces inherited from interface nl.vpro.util.CloseableIterator

CloseableIterator.WrappedCloseableIterator<S>, CloseableIterator.WrappedPeekingCloseableIterator<S>

Constructor Summary

Constructors

Constructor	Description
FilteringIterator(Iterator<? extends T> wrapped, Predicate<? super T> filter)
FilteringIterator(Iterator<? extends T> wrapped, Predicate<? super T> filter, FilteringIterator.KeepAlive keepAlive)

Method Summary

Modifier and Type	Method	Description
static <T> FilteringIterator.Builder<T>	builder()
void	close()
long	getPassed()
long	getSkipped()
boolean	hasNext()
static FilteringIterator.KeepAlive	keepAlive(long c, Function<Long,Boolean> callback)
static FilteringIterator.KeepAlive	keepAlive(Function<Long,Boolean> callback)
static FilteringIterator.KeepAlive	keepAliveChars(long c, Function<Character,Boolean> callback)	This translates the 'numberOfRecords' to a character to write if no records are outputted by the iterated since the last call to the callback.
static FilteringIterator.KeepAlive	keepAliveChars(Function<Character,Boolean> callback)
static FilteringIterator.KeepAlive	keepAliveWithoutBreaks(long c, LongConsumer callback)
static FilteringIterator.KeepAlive	keepAliveWithoutBreaks(LongConsumer callback)
T	next()
static FilteringIterator.KeepAlive	noKeepAlive()
void	remove()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.vpro.util.CloseableIterator

peeking, stream

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

FilteringIterator

public FilteringIterator(Iterator<? extends T> wrapped,
 Predicate<? super T> filter)

FilteringIterator

public FilteringIterator(Iterator<? extends T> wrapped,
 Predicate<? super T> filter,
 FilteringIterator.KeepAlive keepAlive)

Method Details

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Specified by:

next in interface Iterator<T>

remove

public void remove()

Specified by:

remove in interface Iterator<T>

noKeepAlive

public static FilteringIterator.KeepAlive noKeepAlive()

keepAliveWithoutBreaks

public static FilteringIterator.KeepAlive keepAliveWithoutBreaks(LongConsumer callback)

keepAliveWithoutBreaks

public static FilteringIterator.KeepAlive keepAliveWithoutBreaks(long c,
 LongConsumer callback)

keepAlive

public static FilteringIterator.KeepAlive keepAlive(Function<Long,Boolean> callback)

keepAliveChars

public static FilteringIterator.KeepAlive keepAliveChars(Function<Character,Boolean> callback)

keepAliveChars

public static FilteringIterator.KeepAlive keepAliveChars(long c,
 Function<Character,Boolean> callback)

This translates the 'numberOfRecords' to a character to write if no records are outputted by the iterated since the last call to the callback. The callback is called with the character. The idea is to write it simply to the stream, to keep it 'alive. The use case is in MediaRestServiceImpl#iterate

Parameters:

c -

callback -

Returns:

keepAlive

public static FilteringIterator.KeepAlive keepAlive(long c,
 Function<Long,Boolean> callback)

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

builder

public static <T> FilteringIterator.Builder<T> builder()

getSkipped

public long getSkipped()

getPassed

public long getPassed()