com.github.fracpete.javautils.enumerate

Class Enumeration<T>

java.lang.Object

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

Type Parameters:

T - the element type of the Iterable/Iterator

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Enumerated<T>>

public class Enumeration<T>
extends java.lang.Object
implements java.lang.Iterable<Enumerated<T>>, java.io.Serializable

Provides an enumerated wrapper around an Iterable/Iterator object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Iterator<T>	m_Iterator the iterator to wrap.
protected int	m_Start the starting index.
protected int	m_Step the step size.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<Enumerated<T>>	iterator() Returns the iterator.
java.lang.String	toString() Returns a simple string representation of the wrapper.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

m_Iterator

protected java.util.Iterator<T> m_Iterator

the iterator to wrap.

m_Start

protected int m_Start

the starting index.

m_Step

protected int m_Step

the step size.

Constructor Detail

Enumeration

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

Initializes the wrapper.

Parameters:

iterable - the iterable to wrap

Enumeration

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

Initializes the wrapper.

Parameters:

iterable - the iterable to wrap

Enumeration

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

Initializes the wrapper.

Parameters:

iterable - the iterable to wrap

Enumeration

public Enumeration(T[] array)

Initializes the wrapper.

Parameters:

array - the array to wrap

Enumeration

public Enumeration(T[] array,
                   int start)

Initializes the wrapper.

Parameters:

array - the array to wrap

Enumeration

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

Initializes the wrapper.

Parameters:

array - the array to wrap

Enumeration

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

Initializes the wrapper.

Parameters:

iterator - the iterator to wrap

Enumeration

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

Initializes the wrapper.

Parameters:

iterator - the iterator to wrap

Enumeration

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

Initializes the wrapper.

Parameters:

iterator - the iterator to wrap

Method Detail

iterator

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

Returns the iterator.

Specified by:

iterator in interface java.lang.Iterable<Enumerated<T>>

Returns:

the iterator

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