org.stekikun.dolmen.common

Interface Generator<T>

Type Parameters:

T - the type of values generated by the generator

All Superinterfaces:

Supplier<T>

All Known Implementing Classes:

CSet.Gen, Regular.Gen

public interface Generator<T>
extends Supplier<T>

Interface of (lazy) generators

Author:

Stéphane Lescuyer

Method Summary

Modifier and Type	Method and Description
T	generate()
default T	get()
String	name()
static <T> Generator<T>	ofIterable(String name, Iterable<? extends T> it)
default void	present() Presents the values generated by this generator on standard output
default void	present(Consumer<T> consumer) Presents the values generated by this generator on standard output, running the provided consumer on each generated value
default Stream<T>	toStream()

Method Detail

name

String name()

Returns:

a user-friendly description of the generator

generate

T generate()

Returns:

the next generated value

Throws:

NoSuchElementException - if no more values can be generated

get

default T get()

Specified by:

get in interface Supplier<T>

toStream

default Stream<T> toStream()

Returns:

a Java 8 Stream based on this generator

present

default void present(Consumer<T> consumer)

Presents the values generated by this generator on standard output, running the provided consumer on each generated value

Parameters:

consumer -

present

default void present()

Presents the values generated by this generator on standard output

ofIterable

static <T> Generator<T> ofIterable(String name,
                                   Iterable<? extends T> it)

Parameters:

name -

it -

Returns:

a generator with the given name which generates the elements of it, in order, and stops generating once it is exhausted