Package com.github.fracpete.javautils.enumerate

Class Enumerator<T>

java.lang.Object

com.github.fracpete.javautils.enumerate.Enumerator<T>

Type Parameters:

T - the element type of the Iterator

All Implemented Interfaces:

java.io.Serializable, java.util.Iterator<Enumerated<T>>

public class Enumerator<T>
extends java.lang.Object
implements java.util.Iterator<Enumerated<T>>, java.io.Serializable

Wraps an Iterator around an iterator.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Index	the index.
protected java.util.Iterator<T>	m_Iterator	the base iterable object.
protected int	m_Start	the starting index.
protected int	m_Step	the step size.

Constructor Summary

Constructors

Constructor	Description
Enumerator(java.lang.Iterable<T> iterable)	Initializes the iterator.
Enumerator(java.lang.Iterable<T> iterable, int start)	Initializes the iterator.
Enumerator(java.lang.Iterable<T> iterable, int start, int step)	Initializes the iterator.
Enumerator(java.util.Iterator<T> iterator)	Initializes the iterator.
Enumerator(java.util.Iterator<T> iterator, int start)	Initializes the iterator.
Enumerator(java.util.Iterator<T> iterator, int start, int step)	Initializes the iterator.
Enumerator(T[] array)	Initializes the array.
Enumerator(T[] array, int start)	Initializes the array.
Enumerator(T[] array, int start, int step)	Initializes the array.

Method Summary

Modifier and Type	Method	Description
int	getStart()	Returns the starting index.
int	getStep()	Returns the step size between indices of elements.
boolean	hasNext()	Whether there is another element available.
Enumerated<T>	next()	Returns the next element wrapper.
java.lang.String	toString()	Returns a simple string representation of the wrapper.

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from class java.lang.Object

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

Field Detail

m_Iterator

protected java.util.Iterator<T> m_Iterator

the base iterable object.

m_Index

protected int m_Index

the index.

m_Start

protected int m_Start

the starting index.

m_Step

protected int m_Step

the step size.

Constructor Detail

Enumerator

public Enumerator(java.lang.Iterable<T> iterable)

Initializes the iterator. Uses starting index 0 and step size 1.

Parameters:

iterable - the iterable

Enumerator

public Enumerator(java.lang.Iterable<T> iterable,
                  int start)

Initializes the iterator. Uses step size 1.

Parameters:

iterable - the iterator

start - the starting index

Enumerator

public Enumerator(java.lang.Iterable<T> iterable,
                  int start,
                  int step)

Initializes the iterator.

Parameters:

iterable - the iterator

start - the starting index

step - the steps between indices

Enumerator

public Enumerator(T[] array)

Initializes the array. Uses starting index 0 and step size 1.

Parameters:

array - the array

Enumerator

public Enumerator(T[] array,
                  int start)

Initializes the array. Uses step size 1.

Parameters:

array - the array

start - the starting index

Enumerator

public Enumerator(T[] array,
                  int start,
                  int step)

Initializes the array.

Parameters:

array - the array

start - the starting index

step - the steps between indices

Enumerator

public Enumerator(java.util.Iterator<T> iterator)

Initializes the iterator. Uses starting index 0 and step size 1.

Parameters:

iterator - the iterator

Enumerator

public Enumerator(java.util.Iterator<T> iterator,
                  int start)

Initializes the iterator. Uses step size 1.

Parameters:

iterator - the iterator

start - the starting index

Enumerator

public Enumerator(java.util.Iterator<T> iterator,
                  int start,
                  int step)

Initializes the iterator.

Parameters:

iterator - the iterator

start - the starting index

step - the steps between indices

Method Detail

getStart

public int getStart()

Returns the starting index.

Returns:

the first index

getStep

public int getStep()

Returns the step size between indices of elements.

Returns:

the step size

hasNext

public boolean hasNext()

Whether there is another element available.

Specified by:

hasNext in interface java.util.Iterator<T>

Returns:

true if another element available

next

public Enumerated<T> next()

Returns the next element wrapper.

Specified by:

next in interface java.util.Iterator<T>

Returns:

the next wrapper

toString

public java.lang.String toString()

Returns a simple string representation of the wrapper.

Overrides:

toString in class java.lang.Object

Returns:

the string representation