Package groovy.lang
Class ObjectRange
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractList<Comparable>
-
- groovy.lang.ObjectRange
-
- All Implemented Interfaces:
Range<Comparable>,Iterable<Comparable>,Collection<Comparable>,List<Comparable>
public class ObjectRange extends AbstractList<Comparable> implements Range<Comparable>
-
-
Field Summary
-
Fields inherited from class java.util.AbstractList
modCount
-
-
Constructor Summary
Constructors Constructor Description ObjectRange(Comparable from, Comparable to)Creates a newObjectRange.ObjectRange(Comparable smaller, Comparable larger, boolean reverse)Creates a newObjectRangeassumes smaller <= larger, else behavior is undefined.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidcheckBoundaryCompatibility()throws IllegalArgumentException if to and from are incompatible, meaning they e.g.protected intcompareTo(Comparable first, Comparable second)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 Rangeprotected Objectdecrement(Object value)Decrements by onebooleanequals(ObjectRange that)Compares anObjectRangeto anotherObjectRange.booleanequals(Object that)Comparableget(int index)ComparablegetFrom()The lower value in the range.ComparablegetTo()The upper value in the range.protected Objectincrement(Object value)Increments by oneStringinspect()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 step)Forms a list by stepping through the range by the indicated interval.voidstep(int step, Closure closure)Steps through the range, calling a closure for each item.List<Comparable>subList(int fromIndex, int toIndex)StringtoString()-
Methods inherited from class java.util.AbstractList
add, add, addAll, clear, hashCode, 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.Collection
parallelStream, removeIf, stream, toArray
-
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, containsAll, hashCode, indexOf, isEmpty, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, toArray, toArray
-
-
-
-
Constructor Detail
-
ObjectRange
public ObjectRange(Comparable from, Comparable to)
- Parameters:
from- the first value in the range.to- the last value in the range.
-
ObjectRange
public ObjectRange(Comparable smaller, Comparable larger, boolean reverse)
Creates a newObjectRangeassumes smaller <= larger, else behavior is undefined. Caution: Prefer the other constructor when in doubt.Optimized Constructor avoiding initial computation of comparison.
-
-
Method Detail
-
checkBoundaryCompatibility
protected void checkBoundaryCompatibility()
throws IllegalArgumentException if to and from are incompatible, meaning they e.g. (likely) produce infinite sequences. Called at construction time, subclasses may override cautiously (using only members to and from).
-
equals
public boolean equals(Object that)
- Specified by:
equalsin interfaceCollection<Comparable>- Specified by:
equalsin interfaceList<Comparable>- Overrides:
equalsin classAbstractList<Comparable>
-
equals
public boolean equals(ObjectRange that)
Compares anObjectRangeto anotherObjectRange.- Parameters:
that- the object to check equality with- Returns:
trueif the ranges are equal
-
getFrom
public Comparable getFrom()
Description copied from interface:RangeThe lower value in the range.- Specified by:
getFromin interfaceRange<Comparable>- Returns:
- the lower value in the range.
-
getTo
public Comparable getTo()
Description copied from interface:RangeThe upper value in the range.- Specified by:
getToin interfaceRange<Comparable>- Returns:
- the upper value in the range
-
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- Specified by:
isReversein interfaceRange<Comparable>- Returns:
trueif this is a reverse range
-
get
public Comparable get(int index)
- Specified by:
getin interfaceList<Comparable>- Specified by:
getin classAbstractList<Comparable>
-
containsWithinBounds
public boolean containsWithinBounds(Object value)
Checks whether a value is between the from and to values of a Range- Specified by:
containsWithinBoundsin interfaceRange<Comparable>- Parameters:
value- the value of interest- Returns:
- true if the value is within the bounds
-
compareTo
protected int compareTo(Comparable first, Comparable second)
-
size
public int size()
- Specified by:
sizein interfaceCollection<Comparable>- Specified by:
sizein interfaceList<Comparable>- Specified by:
sizein classAbstractCollection<Comparable>
-
subList
public List<Comparable> subList(int fromIndex, int toIndex)
- Specified by:
subListin interfaceList<Comparable>- Overrides:
subListin classAbstractList<Comparable>
-
toString
public String toString()
- Overrides:
toStringin classAbstractCollection<Comparable>
-
inspect
public String inspect()
-
contains
public boolean contains(Object value)
Iterates over all values and returns true if one value matches.- Specified by:
containsin interfaceCollection<Comparable>- Specified by:
containsin interfaceList<Comparable>- Overrides:
containsin classAbstractCollection<Comparable>- See Also:
containsWithinBounds(Object)
-
step
public void step(int step, Closure closure)Description copied from interface:RangeSteps through the range, calling a closure for each item.- Specified by:
stepin interfaceRange<Comparable>- Parameters:
step- the amount by which to step. If negative, steps through the range backwards.closure- theClosureto call
-
iterator
public Iterator<Comparable> iterator()
- Specified by:
iteratorin interfaceCollection<Comparable>- Specified by:
iteratorin interfaceIterable<Comparable>- Specified by:
iteratorin interfaceList<Comparable>- Overrides:
iteratorin classAbstractList<Comparable>
-
step
public List<Comparable> step(int step)
Description copied from interface:RangeForms a list by stepping through the range by the indicated interval.- Specified by:
stepin interfaceRange<Comparable>- Parameters:
step- 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.
-
increment
protected Object increment(Object value)
Increments by one- Parameters:
value- the value to increment- Returns:
- the incremented value
-
-