de.fhg.fokus.xtensions.range

Class RangeExtensions

java.lang.Object

de.fhg.fokus.xtensions.range.RangeExtensions

public final class RangeExtensions
extends Object

This class provides static extension methods to IntegerRange. To use these methods in Xtend, import this class via
import static extension de.fhg.fokus.xtensions.range.RangeExtensions.*
This class is not intended to be instantiated.

Method Summary

Modifier and Type	Method and Description
static IntIterable	asIntIterable(IntegerRange r) Provides an IntIterable view on the given IntegerRange r.
static void	forEachInt(IntegerRange r, IntConsumer consumer) This method iterates over all integers in range r and applies the given consumer for every element. This method is more efficient than the generic iteration extension method IterableExtensions#forEach because it uses IntConsumer as the receiver of elements in the range, which prevents boxing of the integer values.
static void	forEachInt(IntegerRange r, IntIntConsumer consumer) This method iterates over all integers in range r and applies the given consumer for every element, additionally with the index in the range (starting with index 0).
static PrimitiveIterator.OfInt	intIterator(IntegerRange r)
static IntStream	parallelStream(IntegerRange r) Returns a parallel IntStream providing all int values provided by the given IntegerRange r.
static IntStream	stream(IntegerRange r) Returns an IntStream providing all int values provided by the given IntegerRange r.

Methods inherited from class java.lang.Object

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

Method Detail

forEachInt

public static void forEachInt(IntegerRange r,
                              IntConsumer consumer)

This method iterates over all integers in range r and applies the given consumer for every element.
This method is more efficient than the generic iteration extension method IterableExtensions#forEach because it uses IntConsumer as the receiver of elements in the range, which prevents boxing of the integer values.

Parameters:

r - the range to iterate over. Must not be null

consumer - the function that is called for each element in the range r.

Throws:

NullPointerException - if r or consumer is null

forEachInt

public static void forEachInt(IntegerRange r,
                              IntIntConsumer consumer)

This method iterates over all integers in range r and applies the given consumer for every element, additionally with the index in the range (starting with index 0). The first element passed to the consumer is an element from the range, the second one the index.
This method is more efficient than the generic iteration extension method IterableExtensions#forEach because it uses IntIntConsumer as the receiver of elements in the range, which prevents boxing of the integer values.

Parameters:

r - the range to iterate over. Must not be null

consumer - the function that is called for each element in the range r and the index in the range (starting with 0).

Throws:

NullPointerException - if r or consumer is null

stream

public static IntStream stream(IntegerRange r)

Returns an IntStream providing all int values provided by the given IntegerRange r.

Parameters:

r - the range for which the returning stream will be created.

Returns:

stream of integer values provided by the given range r.

parallelStream

public static IntStream parallelStream(IntegerRange r)

Returns a parallel IntStream providing all int values provided by the given IntegerRange r.

Parameters:

r - the range for which a parallel stream will be created

Returns:

parallel stream of integer values provided by the given range r.

intIterator

public static PrimitiveIterator.OfInt intIterator(IntegerRange r)

asIntIterable

public static IntIterable asIntIterable(IntegerRange r)

Provides an IntIterable view on the given IntegerRange r.

Parameters:

r - range to create the view for

Returns:

IntIterable view on the given IntegerRange r.