ObjectRange (groovy 2.4.8 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.
Note: This class is similar to IntRange. If you make any changes to this class, you might consider making parallel changes to IntRange.

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 Params	Return Type	Name and description
	`boolean`	`contains(Object value)` iterates over all values and returns true if one value matches.
	`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, iterator, lastIndexOf, subList, addAll, set, listIterator, listIterator, remove, toString, contains, isEmpty, size, toArray, toArray, addAll, containsAll, removeAll, retainAll, wait, wait, wait, getClass, notify, notifyAll, stream, removeIf, parallelStream, forEach, replaceAll, size, spliterator, sort`
`class AbstractCollection`	`add, remove, toString, clear, contains, isEmpty, iterator, size, toArray, toArray, addAll, containsAll, removeAll, retainAll, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll, spliterator, stream, removeIf, parallelStream, forEach`

- 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
  - @Override public boolean contains(Object value)
    
    iterates over all values and returns true if one value matches. Also see containsWithinBounds.
  - @Override public boolean containsWithinBounds(Object value)
    
    Checks whether a value is between the from and to values of a Range
    Returns:
    true if the value is within the bounds
    Parameters:
    value - the value of interest
  - protected Object decrement(Object value)
    
    Decrements by one
    Returns:
    the decremented value
    Parameters:
    value - the value to decrement
  - public boolean equals(Object that)
    
    {@inheritDoc}
  - public boolean equals(ObjectRange that)
    
    Compares an ObjectRange to another ObjectRange.
    Returns:
    true if the ranges are equal
    Parameters:
    that - the object to check equality with
  - @Override public Object get(int index)
    
    {@inheritDoc}
  - @Override public Comparable getFrom()
    
    {@inheritDoc}
  - @Override public Comparable getTo()
    
    {@inheritDoc}
  - protected Object increment(Object value)
    
    Increments by one
    Returns:
    the incremented value
    Parameters:
    value - the value to increment
  - @Override public String inspect()
    
    {@inheritDoc}
  - @Override public boolean isReverse()
    
    {@inheritDoc}
  - public Iterator iterator()
    
    {@inheritDoc}
  - @Override public int size()
    
    {@inheritDoc}
  - @Override public void step(int step, Closure closure)
    
    {@inheritDoc}
  - @Override public List step(int step)
    
    {@inheritDoc}
  - @Override 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

@Override public boolean contains(Object value)

@Override public boolean containsWithinBounds(Object value)

protected Object decrement(Object value)

public boolean equals(Object that)

public boolean equals(ObjectRange that)

@Override public Object get(int index)

@Override public Comparable getFrom()

@Override public Comparable getTo()

protected Object increment(Object value)

@Override public String inspect()

@Override public boolean isReverse()

public Iterator iterator()

@Override public int size()

@Override public void step(int step, Closure closure)

@Override public List step(int step)

@Override public List subList(int fromIndex, int toIndex)

public String toString()