Package groovy.lang
Class NumberRange
- All Implemented Interfaces:
Range<Comparable>
,Serializable
,Iterable<Comparable>
,Collection<Comparable>
,List<Comparable>
public class NumberRange extends AbstractList<Comparable> implements Range<Comparable>, Serializable
Represents an immutable list of Numbers from a value to a value with a particular step size.
In general, it isn't recommended using a NumberRange as a key to a map. The range
0..3 is deemed to be equal to 0.0..3.0 but they have different hashCode values,
so storing a value using one of these ranges couldn't be retrieved using the other.
- Since:
- 2.5.0
- See Also:
- Serialized Form
-
Field Summary
-
Constructor Summary
Constructors Constructor Description NumberRange(T from, U to)
Creates an inclusiveNumberRange
with step size 1.NumberRange(T from, U to, boolean inclusive)
Creates a newNumberRange
with step size 1.NumberRange(T from, U to, V stepSize)
Creates an inclusiveNumberRange
.NumberRange(T from, U to, V stepSize, boolean inclusive)
Creates aNumberRange
. -
Method Summary
Modifier and Type Method Description <T extends Number & Comparable>
NumberRangeby(T stepSize)
For a NumberRange with step size 1, creates a new NumberRange with the samefrom
andto
as this NumberRange but with a step size ofstepSize
.boolean
contains(Object value)
iterates over all values and returns true if one value matches.boolean
containsWithinBounds(Object value)
Checks whether a value is between the from and to values of a Rangeboolean
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.boolean
fastEquals(NumberRange that)
Compares aNumberRange
to anotherNumberRange
using only a strict comparison of the NumberRange properties.Comparable
get(int index)
Comparable
getFrom()
The lower value in the range.Comparable
getStepSize()
Comparable
getTo()
The upper value in the range.int
hashCode()
A NumberRange's hashCode is based on hashCode values of the discrete items it represents.String
inspect()
boolean
isReverse()
Indicates whether this is a reverse range which iterates backwards starting from the to value and ending on the from valueIterator<Comparable>
iterator()
int
size()
List<Comparable>
step(int numSteps)
Forms a list by stepping through the range by the indicated interval.void
step(int numSteps, Closure closure)
Steps through the range, calling a closure for each item.List<Comparable>
subList(int fromIndex, int toIndex)
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.String
toString()
Methods inherited from class java.util.AbstractList
add, add, addAll, clear, indexOf, lastIndexOf, listIterator, listIterator, remove, removeRange, set
Methods inherited from class java.util.AbstractCollection
addAll, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, containsAll, indexOf, isEmpty, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, toArray, toArray
-
Constructor Details
-
NumberRange
public NumberRange(T from, U to)- Parameters:
from
- the first value in the rangeto
- the last value in the range
-
NumberRange
public NumberRange(T from, U to, boolean inclusive)- Parameters:
from
- start of the rangeto
- end of the rangeinclusive
- whether the range is inclusive
-
NumberRange
public NumberRange(T from, U to, V stepSize)- Parameters:
from
- start of the rangeto
- end of the rangestepSize
- the gap between discrete elements in the range
-
NumberRange
public NumberRange(T from, U to, V stepSize, boolean inclusive)- Parameters:
from
- start of the rangeto
- end of the rangestepSize
- the gap between discrete elements in the rangeinclusive
- whether the range is inclusive
-
-
Method Details
-
subListBorders
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
-
by
For a NumberRange with step size 1, creates a new NumberRange with the samefrom
andto
as this NumberRange but with a step size ofstepSize
.- Parameters:
stepSize
- the desired step size- Returns:
- a new NumberRange
-
equals
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.- Specified by:
equals
in interfaceCollection<Comparable>
- Specified by:
equals
in interfaceList<Comparable>
- Overrides:
equals
in classAbstractList<Comparable>
- 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)
-
hashCode
public int hashCode()A NumberRange's hashCode is based on hashCode values of the discrete items it represents.- Specified by:
hashCode
in interfaceCollection<Comparable>
- Specified by:
hashCode
in interfaceList<Comparable>
- Overrides:
hashCode
in classAbstractList<Comparable>
- Returns:
- the hashCode value
-
fastEquals
Compares aNumberRange
to anotherNumberRange
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
-
getFrom
Description copied from interface:Range
The lower value in the range.- Specified by:
getFrom
in interfaceRange<Comparable>
- Returns:
- the lower value in the range.
-
getTo
Description copied from interface:Range
The upper value in the range.- Specified by:
getTo
in interfaceRange<Comparable>
- Returns:
- the upper value in the range
-
getStepSize
-
isReverse
public boolean isReverse()Description copied from interface:Range
Indicates whether this is a reverse range which iterates backwards starting from the to value and ending on the from value- Specified by:
isReverse
in interfaceRange<Comparable>
- Returns:
true
if this is a reverse range
-
get
- Specified by:
get
in interfaceList<Comparable>
- Specified by:
get
in classAbstractList<Comparable>
-
containsWithinBounds
Checks whether a value is between the from and to values of a Range- Specified by:
containsWithinBounds
in interfaceRange<Comparable>
- Parameters:
value
- the value of interest- Returns:
- true if the value is within the bounds
-
size
public int size()- Specified by:
size
in interfaceCollection<Comparable>
- Specified by:
size
in interfaceList<Comparable>
- Specified by:
size
in classAbstractCollection<Comparable>
-
subList
- Specified by:
subList
in interfaceList<Comparable>
- Overrides:
subList
in classAbstractList<Comparable>
-
toString
- Overrides:
toString
in classAbstractCollection<Comparable>
-
inspect
-
contains
iterates over all values and returns true if one value matches. Also see containsWithinBounds.- Specified by:
contains
in interfaceCollection<Comparable>
- Specified by:
contains
in interfaceList<Comparable>
- Overrides:
contains
in classAbstractCollection<Comparable>
-
step
Steps through the range, calling a closure for each item.- Specified by:
step
in interfaceRange<Comparable>
- Parameters:
numSteps
- the amount by which to step. If negative, steps through the range backwards.closure
- theClosure
to call
-
iterator
- Specified by:
iterator
in interfaceCollection<Comparable>
- Specified by:
iterator
in interfaceIterable<Comparable>
- Specified by:
iterator
in interfaceList<Comparable>
- Overrides:
iterator
in classAbstractList<Comparable>
-
step
Description copied from interface:Range
Forms a list by stepping through the range by the indicated interval.- Specified by:
step
in interfaceRange<Comparable>
- Parameters:
numSteps
- the amount by which to step. If negative, steps through the range backwards.- Returns:
- the list formed by stepping through the range by the indicated interval.
-