public class NumberRange
extends AbstractList
implements Range, Serializable

Constructor Detail

public NumberRange(T from, U to)

Creates an inclusive NumberRange with step size 1. Creates a reversed range if from < to.

Parameters:

from - the first value in the range

to - the last value in the range

public NumberRange(T from, U to, boolean inclusive)

Creates a new NumberRange with step size 1. Creates a reversed range if from < to.

Parameters:

from - start of the range

to - end of the range

inclusive - whether the range is inclusive

public NumberRange(T from, U to, V stepSize)

Creates an inclusive NumberRange. Creates a reversed range if from < to.

Parameters:

from - start of the range

to - end of the range

stepSize - the gap between discrete elements in the range

public NumberRange(T from, U to, V stepSize, boolean inclusive)

Creates a NumberRange. Creates a reversed range if from < to.

Parameters:

from - start of the range

to - end of the range

stepSize - the gap between discrete elements in the range

inclusive - whether the range is inclusive

Method Detail

<T extends Number & Comparable> public NumberRange by(T stepSize)

For a NumberRange with step size 1, creates a new NumberRange with the same from and to as this NumberRange but with a step size of stepSize.

Parameters:

stepSize - the desired step size

Returns:

a new NumberRange

@Override public boolean contains(Object value)

iterates over all values and returns true if one value matches. Also see containsWithinBounds.

@Override public boolean containsWithinBounds(Object value)

Checks whether a value is between the from and to values of a Range

Parameters:

value - the value of interest

Returns:

true if the value is within the bounds

@Override public boolean equals(Object that)

An object is deemed equal to this NumberRange if it represents a List of items and those items equal the list of discrete items represented by this NumberRange.

Parameters:

that - the object to be compared for equality with this NumberRange

Returns:

true if the specified object is equal to this NumberRange

See Also:

fastEquals(NumberRange)

public boolean fastEquals(NumberRange that)

Compares a NumberRange to another NumberRange using only a strict comparison of the NumberRange properties. This won't return true for some ranges which represent the same discrete items, use equals instead for that but will be much faster for large lists.

Parameters:

that - the NumberRange to check equality with

Returns:

true if the ranges are equal

@Override public Comparable get(int index)

@Override public Comparable getFrom()

public Comparable getStepSize()

@Override public Comparable getTo()

@Override public int hashCode()

A NumberRange's hashCode is based on hashCode values of the discrete items it represents.

Returns:

the hashCode value

@Override public String inspect()

@Override public boolean isReverse()

@Override public Iterator<Comparable> iterator()

{@inheritDoc}

@Override public int size()

@Override public void step(int numSteps, Closure closure)

{@inheritDoc}

@Override public List<Comparable> step(int numSteps)

@Override public List<Comparable> subList(int fromIndex, int toIndex)

public RangeInfo subListBorders(int size)

A method for determining from and to information when using this IntRange to index an aggregate object of the specified size. Normally only used internally within Groovy but useful if adding range indexing support for your own aggregates.

Parameters:

size - the size of the aggregate being indexed

Returns:

the calculated range information (with 1 added to the to value, ready for providing to subList

@Override public String toString()