Package io.github.bakedlibs.dough.collections

Class LoopIterator<T>

java.lang.Object

io.github.bakedlibs.dough.collections.LoopIterator<T>

Type Parameters:

T - The Type of element stored in the given Collection

All Implemented Interfaces:

Streamable<T>, Iterator<T>

public class LoopIterator<T>
extends Object
implements Iterator<T>, Streamable<T>

This is an infite implementation of Iterator. When you pass a Collection or Streamable to the constructor, this instance will represent an Iterator which will iterate over the given Collection, when the end of the Collection is reached, it will start again at the beginning. This will create an infinite Stream of elements. Note that this LoopIterator will create a copy of the given Collection and not operate on the original.

Author:

TheBusyBiscuit

Constructor Summary

Constructors

Constructor	Description
LoopIterator(Streamable<T> streamable)	This will create a new instance of LoopIterator that will operate on the elements of the given Streamable
LoopIterator(Collection<T> collection)	This will create a new instance of LoopIterator that operates on a copy of the given Collection

Method Summary

Modifier and Type	Method	Description
Optional<T>	find(Predicate<T> predicate)	This method loops this LoopIterator until a matching item has been found.
int	getIndex()
boolean	hasNext()
T	next()
Stream<T>	stream()

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, remove

Constructor Details

LoopIterator

public LoopIterator(@Nonnull
 Collection<T> collection)

This will create a new instance of LoopIterator that operates on a copy of the given Collection

Parameters:

collection - The collection to create a LoopIterator of

LoopIterator

public LoopIterator(@Nonnull
 Streamable<T> streamable)

This will create a new instance of LoopIterator that will operate on the elements of the given Streamable

Parameters:

streamable - The streamable to create a LoopIterator of

Method Details

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Specified by:

next in interface Iterator<T>

find

public Optional<T> find(@Nonnull
 Predicate<T> predicate)

This method loops this LoopIterator until a matching item has been found. It will not loop more than once though.

Parameters:

predicate - The Predicate to use for this search

Returns:

An Optional describing the result

stream

public Stream<T> stream()

Specified by:

stream in interface Streamable<T>

getIndex

public int getIndex()