[Java] Class ObjectRange

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

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

@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

Parameters:: value - the value to increment

Returns:: the incremented value

@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}

© 2003-2020 The Apache Software Foundation
Licensed under the Apache license.
https://docs.groovy-lang.org/2.4.21/html/gapi/groovy/lang/ObjectRange.html