Class IntegerRange

java.lang.Object

org.apache.commons.functor.generator.BaseGenerator<Integer>

org.apache.commons.functor.generator.util.IntegerRange

All Implemented Interfaces:

Generator<Integer>

public final class IntegerRange
extends BaseGenerator<Integer>

A generator for the range from (inclusive) to to (exclusive).

Since:

1.0

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field	Description
private final int	from	The start index.
private final int	step	The increment counter.
private final int	to	The end index.

Constructor Summary

Constructors

Constructor	Description
IntegerRange(int from, int to)	Create a new IntegerRange.
IntegerRange(int from, int to, int step)	Create a new IntegerRange.
IntegerRange(Number from, Number to)	Create a new IntegerRange.
IntegerRange(Number from, Number to, Number step)	Create a new IntegerRange.

Method Summary

Modifier and Type	Method	Description
private static int	defaultStep(int from, int to)	Calculate default step to get from from to to.
boolean	equals(Object obj)
int	hashCode()
void	run(UnaryProcedure<? super Integer> proc)	Generators must implement this method.
private static int	signOf(int value)	Get value/|value| (0 when value == 0).
String	toString()

Methods inherited from class BaseGenerator

getWrappedGenerator, isStopped, stop, to, to, toCollection

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

from

private final int from

The start index.

to

private final int to

The end index.

step

private final int step

The increment counter.

Constructor Details

IntegerRange

public IntegerRange(Number from,
 Number to)

Create a new IntegerRange.

Parameters:

from - start

to - end

IntegerRange

public IntegerRange(Number from,
 Number to,
 Number step)

Create a new IntegerRange.

Parameters:

from - start

to - end

step - increment

IntegerRange

public IntegerRange(int from,
 int to)

Create a new IntegerRange.

Parameters:

from - start

to - end

IntegerRange

public IntegerRange(int from,
 int to,
 int step)

Create a new IntegerRange.

Parameters:

from - start

to - end

step - increment

Method Details

run

public void run(UnaryProcedure<? super Integer> proc)

Generators must implement this method.

Parameters:

proc - UnaryProcedure to run

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

signOf

private static int signOf(int value)

Get value/|value| (0 when value == 0).

Parameters:

value - to test

Returns:

int

defaultStep

private static int defaultStep(int from,
 int to)

Calculate default step to get from from to to.

Parameters:

from - start

to - end

Returns:

int