cz.auderis.tools.collection.iterator

Class IntegerIterator

java.lang.Object

cz.auderis.tools.collection.iterator.IntegerIterator

All Implemented Interfaces:

Iterable<Integer>, Iterator<Integer>

public class IntegerIterator
extends Object
implements Iterator<Integer>, Iterable<Integer>

Simple iterator of arithmetic integer sequence. Removal of iterated elements is not supported.

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	idx Current index within the iterated sequence.
protected int	value Current value of iterated sequence.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IntegerIterator(int start, int count, int step) Instantiates a new arithmetic iterator with the given start, number of iteration steps and value increment.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
Iterator<Integer>	iterator()
Integer	next()
void	remove() Throws UnsupportedOperationException.
static IntegerIterator	withCount(int count) Constructs a simple count-step arithmetic sequence that starts at 0 and increments by 1 in each iteration.
static IntegerIterator	withCountAndStep(int count, int step) Constructs a count-step arithmetic sequence that starts at 0 and increments by step in each iteration.
static IntegerIterator	withStartCountStep(int start, int count, int step) Constructs a count-step arithmetic sequence that starts at start and increments by step in each iteration.

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

idx

protected int idx

Current index within the iterated sequence. Before the iteration starts its value is -1.

value

protected int value

Current value of iterated sequence. Before the start of iteration its value is start - step.

Constructor Detail

IntegerIterator

protected IntegerIterator(int start,
                          int count,
                          int step)

Instantiates a new arithmetic iterator with the given start, number of iteration steps and value increment.

Parameters:

start - initial sequence value

count - number of steps

step - increment of the sequence value during one step

Method Detail

withCount

public static IntegerIterator withCount(int count)

Constructs a simple count-step arithmetic sequence that starts at 0 and increments by 1 in each iteration.

Parameters:

count - number of steps

Returns:

new instance of IntegerIterator

withCountAndStep

public static IntegerIterator withCountAndStep(int count,
                                               int step)

Constructs a count-step arithmetic sequence that starts at 0 and increments by step in each iteration.

Parameters:

count - number of steps

step - increment of the value in each step

Returns:

new instance of IntegerIterator

withStartCountStep

public static IntegerIterator withStartCountStep(int start,
                                                 int count,
                                                 int step)

Constructs a count-step arithmetic sequence that starts at start and increments by step in each iteration.

Parameters:

start - initial sequence value

count - number of steps

step - increment of the value in each step

Returns:

new instance of IntegerIterator

iterator

public Iterator<Integer> iterator()

Specified by:

iterator in interface Iterable<Integer>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Integer>

next

public Integer next()

Specified by:

next in interface Iterator<Integer>

remove

public void remove()

Throws UnsupportedOperationException.

Specified by:

remove in interface Iterator<Integer>