net.markenwerk.commons.iterators

Class CountDownIterator

java.lang.Object

net.markenwerk.commons.iterators.AbstractProtectedIterator<Payload>

net.markenwerk.commons.iterators.AbstractProtectedBidirectionalIterator<Payload>

net.markenwerk.commons.iterators.AbstractIndexedIterator<Integer>

net.markenwerk.commons.iterators.CountDownIterator

All Implemented Interfaces:

Iterator<Integer>, BidirectionalIterator<Integer>, ProtectedBidirectionalIterator<Integer>, ProtectedIterator<Integer>

public final class CountDownIterator
extends AbstractIndexedIterator<Integer>

A CountDownIterator is an AbstractIndexedIterator that yields all integer value between a given upper bound and a given lower bound.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
CountDownIterator(int fromUpper, int toLower) Creates a new CountDownIterator.

Method Summary

Modifier and Type	Method and Description
Integer	get(int index) Returns the payload value at the given index.

Methods inherited from class net.markenwerk.commons.iterators.AbstractIndexedIterator

hasNext, hasPrevious, next, previous

Methods inherited from class net.markenwerk.commons.iterators.AbstractProtectedIterator

remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.markenwerk.commons.iterators.ProtectedBidirectionalIterator

remove

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

CountDownIterator

public CountDownIterator(int fromUpper,
                         int toLower)

Creates a new CountDownIterator.

If fromUpper == toLower, only one value will be yielded. If fromUpper < toLower, no value will be yielded.

Parameters:

fromUpper - The upper bound and first value to be yielded.

toLower - The lower bound and last value to be yielded.

Method Detail

get

public Integer get(int index)

Description copied from class: AbstractIndexedIterator

Returns the payload value at the given index.

Specified by:

get in class AbstractIndexedIterator<Integer>

Parameters:

index - The index to be used, which is guaranteed to be non-negative and smaller then the maximum index.

Returns:

The payload value at the given index.