Package groovy.lang
Class ObjectRange
- All Implemented Interfaces:
- Range<Comparable>,- Iterable<Comparable>,- Collection<Comparable>,- List<Comparable>
- 
Field SummaryFields inherited from class java.util.AbstractListmodCount
- 
Constructor SummaryConstructorsConstructorDescriptionObjectRange(Comparable from, Comparable to) Creates a newObjectRange.ObjectRange(Comparable smaller, Comparable larger, boolean reverse) Creates a newObjectRangeassumes smaller <= larger, else behavior is undefined.
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidthrows IllegalArgumentException if to and from are incompatible, meaning they e.g.protected intcompareTo(Comparable first, Comparable second) booleanIterates 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 ObjectDecrements by onebooleanequals(ObjectRange that) Compares anObjectRangeto anotherObjectRange.booleanget(int index) getFrom()The lower value in the range.getTo()The upper value in the range.protected ObjectIncrements by oneinspect()booleanIndicates whether this is a reverse range which iterates backwards starting from the to value and ending on the from valueiterator()intsize()step(int step) Forms a list by stepping through the range by the indicated interval.voidSteps through the range, calling a closure for each item.subList(int fromIndex, int toIndex) toString()Methods inherited from class java.util.AbstractListadd, add, addAll, clear, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, removeRange, setMethods inherited from class java.util.AbstractCollectionaddAll, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArrayMethods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.CollectionparallelStream, removeIf, stream, toArrayMethods inherited from interface java.util.Listadd, add, addAll, addAll, clear, containsAll, hashCode, indexOf, isEmpty, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, toArray, toArray
- 
Constructor Details- 
ObjectRange- Parameters:
- from- the first value in the range.
- to- the last value in the range.
 
- 
ObjectRangeCreates a newObjectRangeassumes smaller <= larger, else behavior is undefined. Caution: Prefer the other constructor when in doubt.Optimized Constructor avoiding initial computation of comparison. 
 
- 
- 
Method Details- 
checkBoundaryCompatibilityprotected 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- Specified by:
- equalsin interface- Collection<Comparable>
- Specified by:
- equalsin interface- List<Comparable>
- Overrides:
- equalsin class- AbstractList<Comparable>
 
- 
equalsCompares anObjectRangeto anotherObjectRange.- Parameters:
- that- the object to check equality with
- Returns:
- trueif the ranges are equal
 
- 
getFromDescription copied from interface:RangeThe lower value in the range.- Specified by:
- getFromin interface- Range<Comparable>
- Returns:
- the lower value in the range.
 
- 
getToDescription copied from interface:RangeThe upper value in the range.- Specified by:
- getToin interface- Range<Comparable>
- Returns:
- the upper value in the range
 
- 
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
 
- 
get- Specified by:
- getin interface- List<Comparable>
- Specified by:
- getin class- AbstractList<Comparable>
 
- 
containsWithinBoundsChecks 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
 
- 
compareTo
- 
sizepublic int size()- Specified by:
- sizein interface- Collection<Comparable>
- Specified by:
- sizein interface- List<Comparable>
- Specified by:
- sizein class- AbstractCollection<Comparable>
 
- 
subList- Specified by:
- subListin interface- List<Comparable>
- Overrides:
- subListin class- AbstractList<Comparable>
 
- 
toString- Overrides:
- toStringin class- AbstractCollection<Comparable>
 
- 
inspect
- 
containsIterates over all values and returns true if one value matches.- Specified by:
- containsin interface- Collection<Comparable>
- Specified by:
- containsin interface- List<Comparable>
- Overrides:
- containsin class- AbstractCollection<Comparable>
- See Also:
 
- 
stepDescription copied from interface:RangeSteps through the range, calling a closure for each item.- Specified by:
- stepin interface- Range<Comparable>
- Parameters:
- step- the amount by which to step. If negative, steps through the range backwards.
- closure- the- Closureto call
 
- 
iterator- Specified by:
- iteratorin interface- Collection<Comparable>
- Specified by:
- iteratorin interface- Iterable<Comparable>
- Specified by:
- iteratorin interface- List<Comparable>
- Overrides:
- iteratorin class- AbstractList<Comparable>
 
- 
stepDescription copied from interface:RangeForms a list by stepping through the range by the indicated interval.- Specified by:
- stepin interface- Range<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.
 
- 
incrementIncrements by one- Parameters:
- value- the value to increment
- Returns:
- the incremented value
 
- 
decrementDecrements by one- Parameters:
- value- the value to decrement
- Returns:
- the decremented value
 
 
-