gololang

Interface Range<T>

All Superinterfaces:

java.util.Collection<T>, HeadTail<T>, java.lang.Iterable<T>

public interface Range<T>
extends java.util.Collection<T>, HeadTail<T>

Represents a generic value range.

A range represent a set of values between to bounds, optionally with a step (or increment) from one value to the next.

Method Summary

Modifier and Type	Method and Description
default java.lang.Object[]	__$$_destruct(int number, boolean substruct, java.lang.Object[] toSkip) New style destructuring helper.
Range<T>	decrementBy(int value) Sets the negative increment of the range.
boolean	encloses(T value) Checks if the range encloses the value.
T	from() Gets the lower bound of the range.
int	increment() Gets the increment of the range.
Range<T>	incrementBy(int value) Sets the increment of the range.
Range<T>	newStartingFrom(T newStart) Returns a copy of this range with a new starting value.
Range<T>	reversed() Creates a new reversed range from this range.
T	to() Gets the upper bound of the range.

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface gololang.HeadTail

head, isEmpty, tail, toIterable

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

from

T from()

Gets the lower bound of the range.

Returns:

the starting value of the range.

to

T to()

Gets the upper bound of the range.

Returns:

the excluded ending value of the range.

increment

int increment()

Gets the increment of the range.

Returns:

the number of value to between two elements in the range.

incrementBy

Range<T> incrementBy(int value)

Sets the increment of the range.

Parameters:

value - the new increment.

Returns:

the range itself.

decrementBy

Range<T> decrementBy(int value)

Sets the negative increment of the range.

this is equivalent to:

 range.incrementBy(-value)
 

Parameters:

value - the new increment.

Returns:

the range itself.

encloses

boolean encloses(T value)

Checks if the range encloses the value.

i.e. if from() <= value and value < to() (for positive increments, resp. for negative ones), regardless the increment value.

For instance a range between 0 and 5 with an increment of 2 encloses 1 but don't contains it.

Parameters:

value - the value to check.

reversed

Range<T> reversed()

Creates a new reversed range from this range.

i.e. swaps the from() and to() values and sets the increment to -increment().

__$$_destruct

default java.lang.Object[] __$$_destruct(int number,
                                         boolean substruct,
                                         java.lang.Object[] toSkip)

New style destructuring helper.

If a remainer if included, it will be a new range with same step and end values, starting to the next available value.

Specified by:

__$$_destruct in interface HeadTail<T>

Parameters:

number - number of variable that will be affected.

substruct - whether the destructuring is complete or should contains a sub structure.

toSkip - a boolean array indicating the elements to skip.

Returns:

an array containing the values to assign.

newStartingFrom

Range<T> newStartingFrom(T newStart)

Returns a copy of this range with a new starting value.

There is no check that the newStart value is compatible with the current start and increment. It is therefore possible that the new range yields different values than the original.