ar.com.kfgodel.nary.impl

Class StreamBasedNary<T>

java.lang.Object

ar.com.kfgodel.nary.impl.NarySupport<T>

ar.com.kfgodel.nary.impl.StreamBasedNary<T>

All Implemented Interfaces:

MultiElement<T>, NaryStream<T>, Nary<T>, AutoCloseable, Iterable<T>, BaseStream<T,Stream<T>>, Stream<T>

public class StreamBasedNary<T>
extends NarySupport<T>

This type represents a Nary with a stream as a source of elements.
This implies the greatest level of uncertainty as we don't know if the stream is empty, contains one, or more than one elements until it's consumed. So the nary offers an interface that may be bigger that what the stream actually supports.

That is why in Runtime, this type may throw exceptions depending on how it's used, but it's assumed that the user may have a better judgement to avoid unsafe methods at runtime. This brings much more flexibility on the type, than narrowing the interface on compile time

Created by kfgodel on 07/03/16.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.stream.Stream

Stream.Builder<T>

Constructor Summary

Constructors

Constructor and Description
StreamBasedNary()

Method Summary

Modifier and Type	Method and Description
protected Stream<T>	asStream() Gets a stream with the elements of this instance.
List<T>	collectToList() Returns the content of this nary in a list. This method is a shorthand of calling collect(Collectors.toList()). This nary, as stream, will be consumed in the operation.
Set<T>	collectToSet() Returns the content of this nary in a set. This method is a shorthand of calling collect(Collectors.toSet()) This nary, as stream, will be consumed in the operation.
static <T> StreamBasedNary<T>	create(Stream<? extends T> source)
String	toString() This method is redefined so whenever possible, the contained elements are printed
Unary<T>	unique() Treats this instance as having a single element.

Methods inherited from class ar.com.kfgodel.nary.impl.NarySupport

add, allMatch, anyMatch, close, collect, collect, collect, concat, concat, count, distinct, equals, filter, findAny, findAnyNary, findFirst, findFirstNary, findLast, flatMap, flatMapOptional, flatMapToDouble, flatMapToInt, flatMapToLong, forEach, forEachOrdered, hashCode, isParallel, iterator, limit, map, mapFilteringNullResult, mapToDouble, mapToInt, mapToLong, max, maxNary, min, minNary, noneMatch, onClose, parallel, peek, reduce, reduce, reduce, reduceNary, returningNaryDo, returningNaryDo, sequential, skip, sorted, sorted, spliterator, toArray, toArray, unordered

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ar.com.kfgodel.nary.api.Nary

empty, from, from, from, from, from, from, from, from, from, from, of, ofNonNullable, ofNonNullable

Methods inherited from interface java.util.stream.Stream

builder, concat, generate, iterate

Constructor Detail

StreamBasedNary

public StreamBasedNary()

Method Detail

create

public static <T> StreamBasedNary<T> create(Stream<? extends T> source)

unique

public Unary<T> unique()
                throws MoreThanOneElementException

Description copied from interface: MultiElement

Treats this instance as having a single element. Returns an object that can be used to extend the operations available once we know there are not more elements than 1.
If this instance has more than 1 element then this method will fail when trying to return a Unary because expectations between runtime and compile time won't match

Returns:

The extended api for mono element

Throws:

MoreThanOneElementException - If this instance has more than one element

collectToList

public List<T> collectToList()

Description copied from interface: MultiElement

Returns the content of this nary in a list.
This method is a shorthand of calling collect(Collectors.toList()).

This nary, as stream, will be consumed in the operation.

Returns:

The list with the elements of this nary

collectToSet

public Set<T> collectToSet()

Description copied from interface: MultiElement

Returns the content of this nary in a set.
This method is a shorthand of calling collect(Collectors.toSet())
This nary, as stream, will be consumed in the operation.

Returns:

The set with the elements of this nary

asStream

protected Stream<T> asStream()

Description copied from class: NarySupport

Gets a stream with the elements of this instance. If the stream is already consumed, any operation added to it may fail

Specified by:

asStream in class NarySupport<T>

Returns:

The stream representation of this instance to delegate native operations

toString

public String toString()

Description copied from interface: Nary

This method is redefined so whenever possible, the contained elements are printed

Specified by:

toString in interface Nary<T>

Overrides:

toString in class Object

See Also:

Object.toString()