Package groovy.lang
Class NumberRange
- java.lang.Object
- 
- java.util.AbstractCollection<E>
- 
- java.util.AbstractList<Comparable>
- 
- groovy.lang.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- 
Fields inherited from class java.util.AbstractListmodCount
 
- 
 - 
Constructor SummaryConstructors 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 SummaryAll Methods Instance Methods Concrete Methods 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 samefromandtoas this NumberRange but with a step size ofstepSize.booleancontains(Object value)iterates over all values and returns true if one value matches.booleancontainsWithinBounds(Object value)Checks whether a value is between the from and to values of a Rangebooleanequals(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.Comparableget(int index)ComparablegetFrom()The lower value in the range.ComparablegetStepSize()ComparablegetTo()The upper value in the range.inthashCode()A NumberRange's hashCode is based on hashCode values of the discrete items it represents.Stringinspect()booleanisReverse()Indicates whether this is a reverse range which iterates backwards starting from the to value and ending on the from valueIterator<Comparable>iterator()intsize()List<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.List<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.StringtoString()- 
Methods inherited from class java.util.AbstractListadd, add, addAll, clear, indexOf, lastIndexOf, listIterator, listIterator, remove, removeRange, set
 - 
Methods inherited from class java.util.AbstractCollectionaddAll, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray
 - 
Methods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface java.util.CollectionparallelStream, removeIf, stream, toArray
 - 
Methods inherited from interface java.util.Listadd, add, addAll, addAll, clear, containsAll, indexOf, isEmpty, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, toArray, toArray
 
- 
 
- 
- 
- 
Constructor Detail- 
NumberRangepublic NumberRange(T from, U to)- Parameters:
- from- the first value in the range
- to- the last value in the range
 
 - 
NumberRangepublic NumberRange(T from, U to, boolean inclusive)- Parameters:
- from- start of the range
- to- end of the range
- inclusive- whether the range is inclusive
 
 - 
NumberRangepublic NumberRange(T from, U to, V stepSize)- Parameters:
- from- start of the range
- to- end of the range
- stepSize- the gap between discrete elements in the range
 
 - 
NumberRangepublic NumberRange(T from, U to, V stepSize, boolean inclusive)- 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- 
subListBorderspublic 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
 
 - 
bypublic <T extends Number & 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
 
 - 
equalspublic 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.- Specified by:
- equalsin interface- Collection<Comparable>
- Specified by:
- equalsin interface- List<Comparable>
- Overrides:
- equalsin class- AbstractList<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)
 
 - 
hashCodepublic int hashCode() A NumberRange's hashCode is based on hashCode values of the discrete items it represents.- Specified by:
- hashCodein interface- Collection<Comparable>
- Specified by:
- hashCodein interface- List<Comparable>
- Overrides:
- hashCodein class- AbstractList<Comparable>
- Returns:
- the hashCode value
 
 - 
fastEqualspublic 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
 
 - 
getFrompublic Comparable getFrom() Description copied from interface:RangeThe lower value in the range.- Specified by:
- getFromin interface- Range<Comparable>
- Returns:
- the lower value in the range.
 
 - 
getTopublic Comparable getTo() Description copied from interface:RangeThe upper value in the range.- Specified by:
- getToin interface- Range<Comparable>
- Returns:
- the upper value in the range
 
 - 
getStepSizepublic Comparable getStepSize() 
 - 
isReversepublic 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- Specified by:
- isReversein interface- Range<Comparable>
- Returns:
- trueif this is a reverse range
 
 - 
getpublic Comparable get(int index) - Specified by:
- getin interface- List<Comparable>
- Specified by:
- getin class- AbstractList<Comparable>
 
 - 
containsWithinBoundspublic boolean containsWithinBounds(Object value) Checks whether a value is between the from and to values of a Range- Specified by:
- containsWithinBoundsin interface- Range<Comparable>
- Parameters:
- value- the value of interest
- Returns:
- true if the value is within the bounds
 
 - 
sizepublic int size() - Specified by:
- sizein interface- Collection<Comparable>
- Specified by:
- sizein interface- List<Comparable>
- Specified by:
- sizein class- AbstractCollection<Comparable>
 
 - 
subListpublic List<Comparable> subList(int fromIndex, int toIndex) - Specified by:
- subListin interface- List<Comparable>
- Overrides:
- subListin class- AbstractList<Comparable>
 
 - 
toStringpublic String toString() - Overrides:
- toStringin class- AbstractCollection<Comparable>
 
 - 
inspectpublic String inspect() 
 - 
containspublic boolean contains(Object value) iterates over all values and returns true if one value matches. Also see containsWithinBounds.- Specified by:
- containsin interface- Collection<Comparable>
- Specified by:
- containsin interface- List<Comparable>
- Overrides:
- containsin class- AbstractCollection<Comparable>
 
 - 
steppublic void step(int numSteps, Closure closure)Steps through the range, calling a closure for each item.- Specified by:
- stepin interface- Range<Comparable>
- Parameters:
- numSteps- the amount by which to step. If negative, steps through the range backwards.
- closure- the- Closureto call
 
 - 
iteratorpublic Iterator<Comparable> iterator() - Specified by:
- iteratorin interface- Collection<Comparable>
- Specified by:
- iteratorin interface- Iterable<Comparable>
- Specified by:
- iteratorin interface- List<Comparable>
- Overrides:
- iteratorin class- AbstractList<Comparable>
 
 - 
steppublic List<Comparable> step(int numSteps) Description copied from interface:RangeForms a list by stepping through the range by the indicated interval.- Specified by:
- stepin interface- Range<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.
 
 
- 
 
-