Module coneforest.psylla

Package coneforest.psylla.core

Interface PsyFormalStream<T extends PsyObject>

All Superinterfaces:

PsyCloseable, PsyConcatenable<PsyFormalStream<T>>, PsyObject, PsySequential<T>, PsyStreamable<T>

All Known Implementing Classes:

PsyRange, PsyStream

@Type("formalstream")
public interface PsyFormalStream<T extends PsyObject>
extends PsyStreamable<T>, PsyCloseable, PsyConcatenable<PsyFormalStream<T>>

The representation of formalstream, an abstraction of the stream.

Field Summary

Fields

Modifier and Type	Field	Description
static final ContextAction	PSY_COUNT	Context action of the count operator.
static final ContextAction	PSY_DISTINCT	Context action of the distinct operator.
static final ContextAction	PSY_FILTERED	Context action of the filtered operator.
static final ContextAction	PSY_LIMITED	Context action of the limited operator.
static final ContextAction	PSY_MAPPED	Context action of the mapped operator.
static final ContextAction	PSY_PEEKED	Context action of the peeked operator.
static final ContextAction	PSY_REDUCE	Context action of the reduce operator.
static final ContextAction	PSY_SKIPPED	Context action of the skipped operator.
static final ContextAction	PSY_SORTED	Context action of the sorted operator.

Fields inherited from interface coneforest.psylla.core.PsyCloseable

PSY_CLOSE

Fields inherited from interface coneforest.psylla.core.PsyConcatenable

PSY_CONCAT

Fields inherited from interface coneforest.psylla.core.PsyObject

PSY_CLONE, PSY_EQ, PSY_HASHCODE, PSY_INSTANCEOF, PSY_NE, PSY_TOSTRING, PSY_TOSTRINGBUFFER, PSY_TYPE

Fields inherited from interface coneforest.psylla.core.PsySequential

PSY_FORALL

Fields inherited from interface coneforest.psylla.core.PsyStreamable

PSY_STREAM

Method Summary

Modifier and Type	Method	Description
static <T1 extends PsyObject> PsyFormalStream<T1>	of(Stream<T1> stream)
default void	psyClose()	Closes this formalstream.
default PsyFormalStream<T>	psyConcat(PsyFormalStream<T> oStream)	Returns the concatenable result of concatenation of this object and specified object.
default PsyInteger	psyCount()	Returns the count of elements in this formalstream.
default PsyFormalStream<T>	psyDistinct()	Returns a stream consisting of the distinct elements of this stream.
default PsyFormalStream<T>	psyFiltered(PsyExecutable oPredicate, PsyContext oContext)	Returns a stream over elements of this stream that satisfies the given predicate.
default void	psyForAll(PsyObject oProc, PsyContext oContext)
default PsyFormalStream<T>	psyLimited(PsyInteger oCount)	Returns a formalstream consisting of the elements of this formalstream, truncated to be no longer than specified count in length.
default PsyFormalStream<PsyObject>	psyMapped(PsyExecutable oMapper, PsyContext oContext)
default PsyFormalStream<T>	psyPeeked(PsyExecutable oProc, PsyContext oContext)
default T	psyReduce(T oIdentity, PsyExecutable oAccumulator, PsyContext oContext)
default PsyFormalStream<T>	psySkipped(PsyInteger oCount)	Returns a formalstream consisting of the remaining elements of this formalstream after discarding the first oCount elements of the stream.
default PsyFormalStream<T>	psySorted(PsyExecutable oComparator, PsyContext oContext)
default PsyFormalStream<T>	psyStream()
Stream<T>	stream()

Methods inherited from interface coneforest.psylla.core.PsyObject

convert, execute, invoke, psyClone, psyEq, psyHashCode, psyInstanceOf, psyNe, psySyntax, psyToString, psyToStringBuffer, psyType, toSyntaxString, typeName

Field Details

PSY_COUNT

@OperatorType("count")
static final ContextAction PSY_COUNT

Context action of the count operator.

PSY_DISTINCT

@OperatorType("distinct")
static final ContextAction PSY_DISTINCT

Context action of the distinct operator.

PSY_FILTERED

@OperatorType("filtered")
static final ContextAction PSY_FILTERED

Context action of the filtered operator.

PSY_LIMITED

@OperatorType("limited")
static final ContextAction PSY_LIMITED

Context action of the limited operator.

PSY_MAPPED

@OperatorType("mapped")
static final ContextAction PSY_MAPPED

Context action of the mapped operator.

PSY_PEEKED

@OperatorType("peeked")
static final ContextAction PSY_PEEKED

Context action of the peeked operator.

PSY_REDUCE

@OperatorType("reduce")
static final ContextAction PSY_REDUCE

Context action of the reduce operator.

PSY_SKIPPED

@OperatorType("skipped")
static final ContextAction PSY_SKIPPED

Context action of the skipped operator.

PSY_SORTED

@OperatorType("sorted")
static final ContextAction PSY_SORTED

Context action of the sorted operator.

Method Details

of

static <T1 extends PsyObject> PsyFormalStream<T1> of(Stream<T1> stream)

psyStream

default PsyFormalStream<T> psyStream()

Specified by:

psyStream in interface PsyStreamable<T extends PsyObject>

psyCount

default PsyInteger psyCount()
                     throws PsyInvalidStateException

Returns the count of elements in this formalstream.

Returns:

the count of elements in this formalstream

Throws:

PsyInvalidStateException - when this stream is closed.

psyClose

default void psyClose()

Closes this formalstream.

Specified by:

psyClose in interface PsyCloseable

psyConcat

default PsyFormalStream<T> psyConcat(PsyFormalStream<T> oStream)
                              throws PsyInvalidStateException

Description copied from interface: PsyConcatenable

Returns the concatenable result of concatenation of this object and specified object.

Specified by:

psyConcat in interface PsyConcatenable<T extends PsyObject>

Parameters:

oStream - the specified object.

Returns:

the concatenable result of concatenation of this object and specified object

Throws:

PsyInvalidStateException

psyMapped

default PsyFormalStream<PsyObject> psyMapped(PsyExecutable oMapper,
 PsyContext oContext)
                                      throws PsyErrorException

Throws:

PsyErrorException

psySorted

default PsyFormalStream<T> psySorted(PsyExecutable oComparator,
 PsyContext oContext)

psySkipped

default PsyFormalStream<T> psySkipped(PsyInteger oCount)
                               throws PsyRangeCheckException

Returns a formalstream consisting of the remaining elements of this formalstream after discarding the first oCount elements of the stream.

Parameters:

oCount - the number of leading elements to skip.

Returns:

a formalstream consisting of the remaining elements of this formalstream after discarding the first oCount elements of the stream

Throws:

PsyRangeCheckException - when oCount is negative.

psyLimited

default PsyFormalStream<T> psyLimited(PsyInteger oCount)
                               throws PsyRangeCheckException,
PsyInvalidStateException

Returns a formalstream consisting of the elements of this formalstream, truncated to be no longer than specified count in length.

Parameters:

oCount - the number of elements the stream should be limited to.

Returns:

a formalstream consisting of the elements of this formalstream, truncated to be no longer than specified count in length

Throws:

PsyRangeCheckException - when oCount is negative.

PsyInvalidStateException

psyPeeked

default PsyFormalStream<T> psyPeeked(PsyExecutable oProc,
 PsyContext oContext)
                              throws PsyRangeCheckException,
PsyInvalidStateException

Throws:

PsyRangeCheckException

PsyInvalidStateException

psyFiltered

default PsyFormalStream<T> psyFiltered(PsyExecutable oPredicate,
 PsyContext oContext)
                                throws PsyErrorException

Returns a stream over elements of this stream that satisfies the given predicate.

Parameters:

oPredicate - a predicate.

oContext - a context in which a predicate is called.

Returns:

a stream over elements of this stream that satisfies the given predicate

Throws:

PsyErrorException - TODO

psyForAll

default void psyForAll(PsyObject oProc,
 PsyContext oContext)
                throws PsyErrorException

Specified by:

psyForAll in interface PsySequential<T extends PsyObject>

Specified by:

psyForAll in interface PsyStreamable<T extends PsyObject>

Throws:

PsyErrorException

psyReduce

default T psyReduce(T oIdentity,
 PsyExecutable oAccumulator,
 PsyContext oContext)
             throws PsyInvalidStateException

Throws:

PsyInvalidStateException

psyDistinct

default PsyFormalStream<T> psyDistinct()

Returns a stream consisting of the distinct elements of this stream.

Returns:

a stream consisting of the distinct elements of this stream

stream

Stream<T> stream()