Interface CloseableIterator<E extends @Nullable Object>

Type Parameters:

E - the element type

All Superinterfaces:

AutoCloseable, Closeable, Iterator<E>, Iterator<E>, Resource<IOException>, ResourceIterator<E, IOException>

public interface CloseableIterator<E extends @Nullable Object>
extends ResourceIterator<E, IOException>, Closeable

Represents a ResourceIterator that is also Closeable, closing with an IOException

Since:

0.4.0

Method Summary

Modifier and Type	Method	Description
default CloseableIterator<E>	dropWhile(Predicate<? super E> predicate)	Return an iterator over the elements after the leading elements that satisfy predicate
default CloseableIterator<E>	filter(Predicate<? super E> predicate)	Return an iterator over the elements that satisfy predicate
default CloseableIterator<E>	limit(long limit)	Return an iterator over at most limit elements
default <R extends @Nullable Object> CloseableIterator<R>	map(Function<? super E, ? extends R> mapper)	Return an iterator that applies mapper to each element
default CloseableIterator<E>	peek(Consumer<? super E> action)	Return an iterator that applies action to each element as it is returned
default CloseableIterator<E>	skip(long skip)	Return an iterator over the elements after the first skip
default CloseableIterator<E>	takeWhile(Predicate<? super E> predicate)	Return an iterator over the leading elements that satisfy predicate

Methods inherited from interface Closeable

close

Methods inherited from interface Iterator

forEachRemaining, hasNext, next, remove

Methods inherited from interface Resource

close

Method Details

filter

default CloseableIterator<E> filter(Predicate<? super E> predicate)

Description copied from interface: Iterator

Return an iterator over the elements that satisfy predicate

Specified by:

filter in interface Iterator<E extends @Nullable Object>

Specified by:

filter in interface ResourceIterator<E extends @Nullable Object, IOException>

Parameters:

predicate - the predicate each element must satisfy

Returns:

the filtered iterator

Since:

0.6.0

map

default <R extends @Nullable Object>
CloseableIterator<R> map(Function<? super E, ? extends R> mapper)

Description copied from interface: Iterator

Return an iterator that applies mapper to each element

Specified by:

map in interface Iterator<E extends @Nullable Object>

Specified by:

map in interface ResourceIterator<E extends @Nullable Object, IOException>

Type Parameters:

R - the mapped element type

Parameters:

mapper - the function applied to each element

Returns:

the mapped iterator

Since:

0.5.0

peek

default CloseableIterator<E> peek(Consumer<? super E> action)

Description copied from interface: Iterator

Return an iterator that applies action to each element as it is returned

Specified by:

peek in interface Iterator<E extends @Nullable Object>

Specified by:

peek in interface ResourceIterator<E extends @Nullable Object, IOException>

Parameters:

action - the action applied to each element

Returns:

the peeking iterator

Since:

0.6.0

limit

default CloseableIterator<E> limit(long limit)

Description copied from interface: Iterator

Return an iterator over at most limit elements

Specified by:

limit in interface Iterator<E extends @Nullable Object>

Specified by:

limit in interface ResourceIterator<E extends @Nullable Object, IOException>

Parameters:

limit - the maximum number of elements

Returns:

the truncated iterator

Since:

0.6.0

skip

default CloseableIterator<E> skip(long skip)

Description copied from interface: Iterator

Return an iterator over the elements after the first skip

Specified by:

skip in interface Iterator<E extends @Nullable Object>

Specified by:

skip in interface ResourceIterator<E extends @Nullable Object, IOException>

Parameters:

skip - the number of leading elements to discard

Returns:

the remaining iterator

Since:

0.6.0

takeWhile

default CloseableIterator<E> takeWhile(Predicate<? super E> predicate)

Description copied from interface: Iterator

Return an iterator over the leading elements that satisfy predicate

Specified by:

takeWhile in interface Iterator<E extends @Nullable Object>

Specified by:

takeWhile in interface ResourceIterator<E extends @Nullable Object, IOException>

Parameters:

predicate - the predicate the leading elements must satisfy

Returns:

the leading iterator

Since:

0.6.0

dropWhile

default CloseableIterator<E> dropWhile(Predicate<? super E> predicate)

Description copied from interface: Iterator

Return an iterator over the elements after the leading elements that satisfy predicate

Specified by:

dropWhile in interface Iterator<E extends @Nullable Object>

Specified by:

dropWhile in interface ResourceIterator<E extends @Nullable Object, IOException>

Parameters:

predicate - the predicate the skipped leading elements satisfy

Returns:

the remaining iterator

Since:

0.6.0