Package groovy.lang
Class ObjectRange
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractList
-
- groovy.lang.ObjectRange
-
-
Constructor Summary
Constructors Constructor Description ObjectRange(java.lang.Comparable from, java.lang.Comparable to)
Creates a newObjectRange
.ObjectRange(java.lang.Comparable from, java.lang.Comparable to, boolean reverse)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
contains(java.lang.Object value)
iterates over all values and returns true if one value matches.boolean
containsWithinBounds(java.lang.Object value)
Checks whether a value is between the from and to values of a Rangeprotected java.lang.Object
decrement(java.lang.Object value)
Decrements by oneboolean
equals(ObjectRange that)
Compares anObjectRange
to anotherObjectRange
.boolean
equals(java.lang.Object that)
java.lang.Object
get(int index)
java.lang.Comparable
getFrom()
The lower value in the range.java.lang.Comparable
getTo()
The upper value in the range.protected java.lang.Object
increment(java.lang.Object value)
Increments by onejava.lang.String
inspect()
boolean
isReverse()
Indicates whether this is a reverse range which iterates backwards starting from the to value and ending on the from valuejava.util.Iterator
iterator()
int
size()
java.util.List
step(int step)
Forms a list by stepping through the range by the indicated interval.void
step(int step, Closure closure)
Steps through the range, calling a closure for each number.java.util.List
subList(int fromIndex, int toIndex)
java.lang.String
toString()
-
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
-
-
-
-
Method Detail
-
equals
public boolean equals(java.lang.Object that)
- Specified by:
equals
in interfacejava.util.Collection
- Specified by:
equals
in interfacejava.util.List
- Overrides:
equals
in classjava.util.AbstractList
-
equals
public boolean equals(ObjectRange that)
Compares anObjectRange
to anotherObjectRange
.- Parameters:
that
- the object to check equality with- Returns:
true
if the ranges are equal
-
getFrom
public java.lang.Comparable getFrom()
The lower value in the range.
-
getTo
public java.lang.Comparable getTo()
The upper value in the range.
-
isReverse
public boolean isReverse()
Indicates whether this is a reverse range which iterates backwards starting from the to value and ending on the from value
-
get
public java.lang.Object get(int index)
- Specified by:
get
in interfacejava.util.List
- Specified by:
get
in classjava.util.AbstractList
-
iterator
public java.util.Iterator iterator()
- Specified by:
iterator
in interfacejava.util.Collection
- Specified by:
iterator
in interfacejava.lang.Iterable
- Specified by:
iterator
in interfacejava.util.List
- Overrides:
iterator
in classjava.util.AbstractList
-
containsWithinBounds
public boolean containsWithinBounds(java.lang.Object value)
Checks whether a value is between the from and to values of a Range- Specified by:
containsWithinBounds
in interfaceRange
- Parameters:
value
- the value of interest- Returns:
- true if the value is within the bounds
-
size
public int size()
- Specified by:
size
in interfacejava.util.Collection
- Specified by:
size
in interfacejava.util.List
- Specified by:
size
in classjava.util.AbstractCollection
-
subList
public java.util.List subList(int fromIndex, int toIndex)
- Specified by:
subList
in interfacejava.util.List
- Overrides:
subList
in classjava.util.AbstractList
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.util.AbstractCollection
-
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:
contains
in interfacejava.util.Collection
- Specified by:
contains
in interfacejava.util.List
- Overrides:
contains
in classjava.util.AbstractCollection
-
step
public void step(int step, Closure closure)
Steps through the range, calling a closure for each number.
-
step
public java.util.List step(int step)
Forms a list by stepping through the range by the indicated interval.
-
increment
protected java.lang.Object increment(java.lang.Object value)
Increments by one- Parameters:
value
- the value to increment- Returns:
- the incremented value
-
decrement
protected java.lang.Object decrement(java.lang.Object value)
Decrements by one- Parameters:
value
- the value to decrement- Returns:
- the decremented value
-
-