Package groovy.lang
Class NumberRange
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractList<java.lang.Comparable>
-
- groovy.lang.NumberRange
-
- All Implemented Interfaces:
Range<java.lang.Comparable>,java.lang.Iterable<java.lang.Comparable>,java.util.Collection<java.lang.Comparable>,java.util.List<java.lang.Comparable>
public class NumberRange extends java.util.AbstractList<java.lang.Comparable> implements Range<java.lang.Comparable>
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
-
-
Constructor Summary
Constructors Constructor Description NumberRange(T from, U to)Creates an inclusiveNumberRangewith step size 1.NumberRange(T from, U to, boolean inclusive)Creates a newNumberRangewith 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T extends java.lang.Number & java.lang.Comparable>
NumberRangeby(T stepSize)For a NumberRange with step size 1, creates a new NumberRange with the samefromandtoas this NumberRange but with a step size ofstepSize.booleancontains(java.lang.Object value)iterates over all values and returns true if one value matches.booleancontainsWithinBounds(java.lang.Object value)Checks whether a value is between the from and to values of a Rangebooleanequals(java.lang.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.booleanfastEquals(NumberRange that)Compares aNumberRangeto anotherNumberRangeusing only a strict comparison of the NumberRange properties.java.lang.Comparableget(int index)java.lang.ComparablegetFrom()The lower value in the range.java.lang.ComparablegetStepSize()java.lang.ComparablegetTo()The upper value in the range.inthashCode()A NumberRange's hashCode is based on hashCode values of the discrete items it represents.java.lang.Stringinspect()booleanisReverse()Indicates whether this is a reverse range which iterates backwards starting from the to value and ending on the from valuejava.util.Iterator<java.lang.Comparable>iterator()intsize()java.util.List<java.lang.Comparable>step(int numSteps)Forms a list by stepping through the range by the indicated interval.voidstep(int numSteps, Closure closure)Steps through the range, calling a closure for each item.java.util.List<java.lang.Comparable>subList(int fromIndex, int toIndex)RangeInfosubListBorders(int size)A method for determining from and to information when using this IntRange to index an aggregate object of the specified size.java.lang.StringtoString()-
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
-
-
-
-
Constructor Detail
-
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 Detail
-
subListBorders
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
-
by
public <T extends java.lang.Number & java.lang.Comparable> NumberRange by(T stepSize)
For a NumberRange with step size 1, creates a new NumberRange with the samefromandtoas this NumberRange but with a step size ofstepSize.- Parameters:
stepSize- the desired step size- Returns:
- a new NumberRange
-
equals
public boolean equals(java.lang.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.- Specified by:
equalsin interfacejava.util.Collection<java.lang.Comparable>- Specified by:
equalsin interfacejava.util.List<java.lang.Comparable>- Overrides:
equalsin classjava.util.AbstractList<java.lang.Comparable>- Parameters:
that- the object to be compared for equality with this NumberRange- Returns:
trueif 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:
hashCodein interfacejava.util.Collection<java.lang.Comparable>- Specified by:
hashCodein interfacejava.util.List<java.lang.Comparable>- Overrides:
hashCodein classjava.util.AbstractList<java.lang.Comparable>- Returns:
- the hashCode value
-
fastEquals
public boolean fastEquals(NumberRange that)
Compares aNumberRangeto anotherNumberRangeusing 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:
trueif the ranges are equal
-
getFrom
public java.lang.Comparable getFrom()
Description copied from interface:RangeThe lower value in the range.
-
getTo
public java.lang.Comparable getTo()
Description copied from interface:RangeThe upper value in the range.
-
getStepSize
public java.lang.Comparable getStepSize()
-
isReverse
public boolean isReverse()
Description copied from interface:RangeIndicates whether this is a reverse range which iterates backwards starting from the to value and ending on the from value
-
get
public java.lang.Comparable get(int index)
- Specified by:
getin interfacejava.util.List<java.lang.Comparable>- Specified by:
getin classjava.util.AbstractList<java.lang.Comparable>
-
containsWithinBounds
public boolean containsWithinBounds(java.lang.Object value)
Checks whether a value is between the from and to values of a Range- Specified by:
containsWithinBoundsin interfaceRange<java.lang.Comparable>- Parameters:
value- the value of interest- Returns:
- true if the value is within the bounds
-
size
public int size()
- Specified by:
sizein interfacejava.util.Collection<java.lang.Comparable>- Specified by:
sizein interfacejava.util.List<java.lang.Comparable>- Specified by:
sizein classjava.util.AbstractCollection<java.lang.Comparable>
-
subList
public java.util.List<java.lang.Comparable> subList(int fromIndex, int toIndex)- Specified by:
subListin interfacejava.util.List<java.lang.Comparable>- Overrides:
subListin classjava.util.AbstractList<java.lang.Comparable>
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.util.AbstractCollection<java.lang.Comparable>
-
inspect
public java.lang.String inspect()
-
contains
public boolean contains(java.lang.Object value)
iterates over all values and returns true if one value matches. Also see containsWithinBounds.- Specified by:
containsin interfacejava.util.Collection<java.lang.Comparable>- Specified by:
containsin interfacejava.util.List<java.lang.Comparable>- Overrides:
containsin classjava.util.AbstractCollection<java.lang.Comparable>
-
step
public void step(int numSteps, Closure closure)Steps through the range, calling a closure for each item.
-
iterator
public java.util.Iterator<java.lang.Comparable> iterator()
- Specified by:
iteratorin interfacejava.util.Collection<java.lang.Comparable>- Specified by:
iteratorin interfacejava.lang.Iterable<java.lang.Comparable>- Specified by:
iteratorin interfacejava.util.List<java.lang.Comparable>- Overrides:
iteratorin classjava.util.AbstractList<java.lang.Comparable>
-
step
public java.util.List<java.lang.Comparable> step(int numSteps)
Description copied from interface:RangeForms a list by stepping through the range by the indicated interval.
-
-