com.worksap.fig.lang

Class Range<C extends java.lang.Comparable<C>>

java.lang.Object

com.worksap.fig.lang.Range<C>

All Implemented Interfaces:

java.lang.Iterable<C>

public class Range<C extends java.lang.Comparable<C>>
extends java.lang.Object
implements java.lang.Iterable<C>

Range is an element generator on the basis of start point, end point and next element function.

Constructor Summary

Constructors

Constructor and Description
Range(C from)
Range(C from, C to, java.util.function.Function<C,C> next)

Method Summary

Modifier and Type	Method and Description
void	forEach(java.util.function.BiConsumer<? super C,java.lang.Integer> action) Similar to forEach(Consumer), with additional parameter "index" as the second parameter of the lambda expression.
void	forEach(java.util.function.Consumer<? super C> action) Iterate each element of the range.
Range<C>	from(C from) Set start point
C	getFrom()
C	getTo()
boolean	isToIncluded()
java.util.Iterator<C>	iterator()
Range<C>	next(java.util.function.BiFunction<C,java.lang.Integer,C> next) Set next element generator.
Range<C>	next(java.util.function.Function<C,C> next) Set next element generator.
java.util.Spliterator<C>	spliterator()
Seq<C>	take(int n) Get the first n elements of this range.
Seq<C>	takeWhile(java.util.function.BiPredicate<C,java.lang.Integer> condition) Get elements at the front of this range which satisfy the condition.
Seq<C>	takeWhile(java.util.function.Predicate<C> condition) Get elements at the front of this range which satisfy the condition.
Range<C>	to(C to) Set end point.
MutableSeq<C>	toMutableSeq()
Seq<C>	toSeq()
Range<C>	until(C to) Set end point.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Range

public Range(C from)

Parameters:

from - The start point.

Throws:

java.lang.NullPointerException - if from is null.

Range

public Range(C from,
             C to,
             java.util.function.Function<C,C> next)

Parameters:

from - The start point.

to - The end point. It is included in the range.

next - The next element generator.

Throws:

java.lang.NullPointerException - if from, to or next is null.

Method Detail

from

public Range<C> from(C from)

Set start point

Parameters:

from - The start point.

Returns:

Current range object.

Throws:

java.lang.NullPointerException - if from is null.

to

public Range<C> to(C to)

Set end point. The end point is included in this range.

Parameters:

to - The end point.

Returns:

Current range object.

Throws:

java.lang.NullPointerException - if to is null.

until

public Range<C> until(C to)

Set end point. The end point is excluded in this range.

Parameters:

to - The end point.

Returns:

Current range object.

Throws:

java.lang.NullPointerException - if to is null.

next

public Range<C> next(java.util.function.Function<C,C> next)

Set next element generator.

Parameters:

next - The next element generator

Returns:

Current range object.

Throws:

java.lang.NullPointerException - if next is null.

next

public Range<C> next(java.util.function.BiFunction<C,java.lang.Integer,C> next)

Set next element generator.

Parameters:

next - The next element generator

Returns:

Current range object.

Throws:

java.lang.NullPointerException - if next is null.

getFrom

public C getFrom()

Returns:

The start point

getTo

public C getTo()

Returns:

The end point

isToIncluded

public boolean isToIncluded()

Returns:

Whether the end point is included in this range.

forEach

public void forEach(java.util.function.Consumer<? super C> action)

Iterate each element of the range.

Specified by:

forEach in interface java.lang.Iterable<C extends java.lang.Comparable<C>>

Throws:

java.lang.NullPointerException - if action, this.from, this.to or this.next is null.

forEach

public void forEach(java.util.function.BiConsumer<? super C,java.lang.Integer> action)

Similar to forEach(Consumer), with additional parameter "index" as the second parameter of the lambda expression.

Throws:

java.lang.NullPointerException - if action, this.from, this.to or this.next is null.

toSeq

public Seq<C> toSeq()

toMutableSeq

public MutableSeq<C> toMutableSeq()

iterator

public java.util.Iterator<C> iterator()

Specified by:

iterator in interface java.lang.Iterable<C extends java.lang.Comparable<C>>

Throws:

java.lang.NullPointerException - if this.from or this.next is null.

spliterator

public java.util.Spliterator<C> spliterator()

Specified by:

spliterator in interface java.lang.Iterable<C extends java.lang.Comparable<C>>

take

public Seq<C> take(int n)

Get the first n elements of this range.

Returns:

The Seq containing the first n elements.

Throws:

java.lang.IllegalArgumentException - if n < 0

takeWhile

public Seq<C> takeWhile(java.util.function.Predicate<C> condition)

Get elements at the front of this range which satisfy the condition.

Parameters:

condition - the condition used to filter elements by passing the element, returns true if the element satisfies the condition, otherwise returns false.

Returns:

The seq containing all the elements satisfying the condition

Throws:

java.lang.NullPointerException - if condition is null

takeWhile

public Seq<C> takeWhile(java.util.function.BiPredicate<C,java.lang.Integer> condition)

Get elements at the front of this range which satisfy the condition.

Similar to takeWhile(Predicate), with additional parameter "index" as the second parameter of the lambda expression.

Parameters:

condition - the condition used to filter elements by passing the element and its index, returns true if the element satisfies the condition, otherwise returns false.

Returns:

The seq containing all the elements satisfying the condition

Throws:

java.lang.NullPointerException - if condition is null