io.github.privacystreams.core.transformations.limit

Class Limiters

java.lang.Object

io.github.privacystreams.core.transformations.limit.Limiters

@PSOperatorWrapper
public class Limiters
extends java.lang.Object

A helper class to access stream-limiting functions

Constructor Summary

Constructors

Constructor and Description
Limiters()

Method Summary

Modifier and Type	Method and Description
static PStreamTransformation	limit(Function<Item,java.lang.Boolean> predicate) Limit the stream with a predicate.
static PStreamTransformation	limitCount(int countLimit) Limit the stream to at most n items.
static PStreamTransformation	timeout(long timeoutMillis) Limit the stream with a timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

Limiters

public Limiters()

Method Detail

timeout

public static PStreamTransformation timeout(long timeoutMillis)

Limit the stream with a timeout. The stream will stop after the timeout.

Parameters:

timeoutMillis - the timeout milliseconds.

Returns:

the limiter function.

limitCount

public static PStreamTransformation limitCount(int countLimit)

Limit the stream to at most n items. The stream will stop after n items.

Parameters:

countLimit - the maximum number of items.

Returns:

the limiter function.

limit

public static PStreamTransformation limit(Function<Item,java.lang.Boolean> predicate)

Limit the stream with a predicate. The stream will stop if the predicate is dissatisfied.

Parameters:

predicate - the predicate to check for each item.

Returns:

the limiter function.