ObjectRange (groovy 2.4.0 API)

groovy.lang.ObjectRange

All Implemented Interfaces and Traits:

Range
```
public class ObjectRange
extends AbstractList
```
Represents an inclusive list of objects from a value to a value using comparators.
This class is similar to IntRange. If you make any changes to this class, you might consider making parallel changes to IntRange.
Authors:
James Strachan
Version:
\$Revision\$

Constructor Summary

Constructors
Constructor and description
`ObjectRange (Comparable from, Comparable to)` Creates a new ObjectRange.
`ObjectRange (Comparable from, Comparable to, boolean reverse)`

Methods Summary

Methods
Type	Name and description
`boolean`	`contains(Object value)`
`boolean`	`containsWithinBounds(Object value)` Checks whether a value is between the from and to values of a Range
`protected Object`	`decrement(Object value)` Decrements by one
`boolean`	`equals(Object that)` {@inheritDoc}
`boolean`	`equals(ObjectRange that)` Compares an ObjectRange to another ObjectRange.
`Object`	`get(int index)` {@inheritDoc}
`Comparable`	`getFrom()` {@inheritDoc}
`Comparable`	`getTo()` {@inheritDoc}
`protected Object`	`increment(Object value)` Increments by one
`String`	`inspect()` {@inheritDoc}
`boolean`	`isReverse()` {@inheritDoc}
`Iterator`	`iterator()` {@inheritDoc}
`int`	`size()` {@inheritDoc}
`void`	`step(int step, Closure closure)` {@inheritDoc}
`List`	`step(int step)` {@inheritDoc}
`List`	`subList(int fromIndex, int toIndex)` {@inheritDoc}
`String`	`toString()` {@inheritDoc}

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractList`	`add, add, remove, get, equals, hashCode, indexOf, clear, lastIndexOf, subList, addAll, iterator, set, listIterator, listIterator, remove, toString, contains, isEmpty, size, toArray, toArray, addAll, containsAll, removeAll, retainAll, wait, wait, wait, getClass, notify, notifyAll, size`
`class AbstractCollection`	`add, remove, toString, clear, contains, isEmpty, size, toArray, toArray, addAll, iterator, containsAll, removeAll, retainAll, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - public ObjectRange(Comparable from, Comparable to)
    
    Creates a new ObjectRange. Creates a reversed range if from < to.
    Parameters:
    from - the first value in the range.
    to - the last value in the range.
  - public ObjectRange(Comparable from, Comparable to, boolean reverse)
- Method Detail
  - public boolean contains(Object value)
  - public boolean containsWithinBounds(Object value)
    
    Checks whether a value is between the from and to values of a Range
    Parameters:
    value - the value of interest
    Returns:
    true if the value is within the bounds
  - protected Object decrement(Object value)
    
    Decrements by one
    Parameters:
    value - the value to decrement
    Returns:
    the decremented value
  - public boolean equals(Object that)
    
    {@inheritDoc}
  - public boolean equals(ObjectRange that)
    
    Compares an ObjectRange to another ObjectRange.
    Parameters:
    that - the object to check equality with
    Returns:
    true if the ranges are equal
  - public Object get(int index)
    
    {@inheritDoc}
  - public Comparable getFrom()
    
    {@inheritDoc}
  - public Comparable getTo()
    
    {@inheritDoc}
  - protected Object increment(Object value)
    
    Increments by one
    Parameters:
    value - the value to increment
    Returns:
    the incremented value
  - public String inspect()
    
    {@inheritDoc}
  - public boolean isReverse()
    
    {@inheritDoc}
  - public Iterator iterator()
    
    {@inheritDoc}
  - public int size()
    
    {@inheritDoc}
  - public void step(int step, Closure closure)
    
    {@inheritDoc}
  - public List step(int step)
    
    {@inheritDoc}
  - public List subList(int fromIndex, int toIndex)
    
    {@inheritDoc}
  - public String toString()
    
    {@inheritDoc}

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class ObjectRange

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public ObjectRange(Comparable from, Comparable to)

public ObjectRange(Comparable from, Comparable to, boolean reverse)

Method Detail

public boolean contains(Object value)

public boolean containsWithinBounds(Object value)

protected Object decrement(Object value)

public boolean equals(Object that)

public boolean equals(ObjectRange that)

public Object get(int index)

public Comparable getFrom()

public Comparable getTo()

protected Object increment(Object value)

public String inspect()

public boolean isReverse()

public Iterator iterator()

public int size()

public void step(int step, Closure closure)

public List step(int step)

public List subList(int fromIndex, int toIndex)

public String toString()