|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractList
groovy.lang.ObjectRange
public class ObjectRange
Represents an inclusive list of objects from a value to a value using comparators.
This class is similar toIntRange
. If you make any changes to this
class, you might consider making parallel changes to IntRange
.
Field Summary | |
---|---|
private java.lang.Comparable |
from
The first value in the range. |
private boolean |
reverse
true if the range counts backwards from to to from . |
private int |
size
The cached size, or -1 if not yet computed |
private java.lang.Comparable |
to
The last value in the range. |
Fields inherited from class java.util.AbstractList |
---|
modCount |
Constructor Summary | |
---|---|
ObjectRange(java.lang.Comparable from,
java.lang.Comparable to)
Creates a new ObjectRange . |
|
ObjectRange(java.lang.Comparable from,
java.lang.Comparable to,
boolean reverse)
|
Method Summary | |
---|---|
private int |
compareTo(java.lang.Comparable first,
java.lang.Comparable second)
|
private void |
constructorHelper(java.lang.Comparable from,
java.lang.Comparable to)
|
boolean |
contains(java.lang.Object value)
|
boolean |
containsWithinBounds(java.lang.Object value)
Checks whether a value is between the from and to values of a Range |
protected java.lang.Object |
decrement(java.lang.Object value)
Decrements by one |
boolean |
equals(java.lang.Object that)
|
boolean |
equals(ObjectRange that)
Compares an ObjectRange to another ObjectRange . |
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 one |
java.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 value |
java.util.Iterator |
iterator()
|
private static java.lang.Comparable |
normaliseStringType(java.lang.Comparable operand)
|
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 |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.List |
---|
add, add, addAll, addAll, clear, containsAll, hashCode, indexOf, isEmpty, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, toArray, toArray |
Field Detail |
---|
private java.lang.Comparable from
private java.lang.Comparable to
private int size
private final boolean reverse
true
if the range counts backwards from to
to from
.
Constructor Detail |
---|
public ObjectRange(java.lang.Comparable from, java.lang.Comparable to)
ObjectRange
. Creates a reversed range if
from
< to
.
from
- the first value in the range.to
- the last value in the range.public ObjectRange(java.lang.Comparable from, java.lang.Comparable to, boolean reverse)
Method Detail |
---|
private void constructorHelper(java.lang.Comparable from, java.lang.Comparable to)
public boolean equals(java.lang.Object that)
equals
in interface java.util.Collection
equals
in interface java.util.List
equals
in class java.util.AbstractList
public boolean equals(ObjectRange that)
ObjectRange
to another ObjectRange
.
that
- the object to check equality with
true
if the ranges are equalpublic java.lang.Comparable getFrom()
getFrom
in interface Range
public java.lang.Comparable getTo()
getTo
in interface Range
public boolean isReverse()
isReverse
in interface Range
true
if this is a reverse rangepublic java.lang.Object get(int index)
get
in interface java.util.List
get
in class java.util.AbstractList
public java.util.Iterator iterator()
iterator
in interface java.lang.Iterable
iterator
in interface java.util.Collection
iterator
in interface java.util.List
iterator
in class java.util.AbstractList
public boolean containsWithinBounds(java.lang.Object value)
containsWithinBounds
in interface Range
value
- the value of interest
private int compareTo(java.lang.Comparable first, java.lang.Comparable second)
public int size()
size
in interface java.util.Collection
size
in interface java.util.List
size
in class java.util.AbstractCollection
public java.util.List subList(int fromIndex, int toIndex)
subList
in interface java.util.List
subList
in class java.util.AbstractList
public java.lang.String toString()
toString
in class java.util.AbstractCollection
public java.lang.String inspect()
inspect
in interface Range
String
representation of this Range
as would be typed into a console
to create the Range
instancepublic boolean contains(java.lang.Object value)
contains
in interface java.util.Collection
contains
in interface java.util.List
contains
in class java.util.AbstractCollection
public void step(int step, Closure closure)
step
in interface Range
step
- the amount by which to step. If negative, steps through the
range backwards.closure
- the Closure
to callpublic java.util.List step(int step)
step
in interface Range
step
- the amount by which to step. If negative, steps through the
range backwards.
protected java.lang.Object increment(java.lang.Object value)
value
- the value to increment
protected java.lang.Object decrement(java.lang.Object value)
value
- the value to decrement
private static java.lang.Comparable normaliseStringType(java.lang.Comparable operand)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |