Sinobu

kiss

Signal<V>

  • V

The Signal class that implements the Reactive Pattern. This class provides methods for subscribing to the Signal as well as delegate methods to the various observers.

In Reactive Pattern an observer subscribes to a Signal. Then that observer reacts to whatever item or sequence of items the Signal emits. This pattern facilitates concurrent operations because it does not need to block while waiting for the Signal to emit objects, but instead it creates a sentry in the form of an observer that stands ready to react appropriately at whatever future time the Signal does so.

The subscribe method is how you connect an Observer to a Signal. Your Observer implements some subset of the following methods:

Observer#accept(Object)
A Signal calls this method whenever the Signal emits an item. This method takes as a parameter the item emitted by the Signal.
Observer#error(Throwable)
A Signal calls this method to indicate that it has failed to generate the expected data or has encountered some other error. It will not make further calls to Observer#error(Throwable) or Observer#complete(). The Observer#error(Throwable) method takes as its parameter an indication of what caused the error.
Observer#complete()
A Signal calls this method after it has called Observer#accept(Object) for the final time, if it has not encountered any errors.

By the terms of the Signal contract, it may call Observer#accept(Object) zero or more times, and then may follow those calls with a call to either Observer#complete() or Observer#error(Throwable) but not both, which will be its last call. By convention, in this document, calls to Observer#accept(Object) are usually called &ldquo;emissions&rdquo; of items, whereas calls to Observer#complete() or Observer#error(Throwable) are called &ldquo;notifications.&rdquo;

Signal(CollectionObserverVobservers)

CollectionObserverVobservers

A subscriber Function.

Create Signal preassign the specified subscriber Collection which will be invoked whenever you calls #to(Observer) related methods.

Signal(BiFunctionObserverV, Disposable, Disposablesubscriber)

BiFunctionObserverV, Disposable, Disposablesubscriber

A subscriber Function.

Create Signal preassign the specified subscriber BiFunction which will be invoked whenever you calls #to(Observer) related methods.

never()SignalR

R
SignalR

For reuse.

to(Runnablenext)Disposable

Runnablenext

A delegator method of Observer#accept(Object).

Disposable

Calling Disposable#dispose() will dispose this subscription.

An Observer must call an Signal#to() method in order to receive items and notifications from the Observable.

to(Consumer?Vnext)Disposable

Consumer?Vnext

A delegator method of Observer#accept(Object).

Disposable

Calling Disposable#dispose() will dispose this subscription.

An Observer must call an Signal#to() method in order to receive items and notifications from the Observable.

to(Consumer?Vnext, ConsumerThrowableerror)Disposable

Consumer?Vnext

A delegator method of Observer#accept(Object).

ConsumerThrowableerror

A delegator method of Observer#error(Throwable).

Disposable

Calling Disposable#dispose() will dispose this subscription.

An Observer must call an Signal#to() method in order to receive items and notifications from the Observable.

to(Runnablenext, ConsumerThrowableerror, Runnablecomplete)Disposable

Runnablenext

A delegator method of Observer#accept(Object).

ConsumerThrowableerror

A delegator method of Observer#error(Throwable).

Runnablecomplete

A delegator method of Observer#complete().

Disposable

Calling Disposable#dispose() will dispose this subscription.

Receive values from this Signal.

to(Consumer?Vnext, ConsumerThrowableerror, Runnablecomplete)Disposable

Consumer?Vnext

A delegator method of Observer#accept(Object).

ConsumerThrowableerror

A delegator method of Observer#error(Throwable).

Runnablecomplete

A delegator method of Observer#complete().

Disposable

Calling Disposable#dispose() will dispose this subscription.

Receive values from this Signal.

to(Observer?Vobserver)Disposable

Observer?Vobserver

A value observer of this Signal.

Disposable

Calling Disposable#dispose() will dispose this subscription.

Receive values from this Signal.

to(ObserverVobserver, Disposabledisposer)Disposable

ObserverVobserver

A value observer of this Signal.

Disposabledisposer
Disposable

Calling Disposable#dispose() will dispose this subscription.

Receive values from this Signal.

to()VariableV

VariableV

A Variable as value receiver.

Receive values as Variable from this Signal.

to(Collector?V, A, Rreceiver)R

A
R
Collector?V, A, Rreceiver
R

A Variable as value receiver.

Receive values as Variable from this Signal.

to(Rreceiver, WiseBiConsumerR, Vassigner)R

R
Rreceiver

A value receiver.

WiseBiConsumerR, Vassigner

A value assigner.

R

A value receiver.

Receive values from this Signal.

toCollection(Ccollection)C

CCollection?V
Ccollection
C

A Collection as value receiver.

Receive values as Collection from this Signal.

toGroup(FunctionV, KkeyGenerator)MapK, ListV

K

The type of the keys.

FunctionV, KkeyGenerator

The classifier function mapping input elements to keys.

MapK, ListV

A grouping Map by your classification.

Groups the elements according to the classification function and returns the result in a Map. The classification function maps elements to some key type K. The method produces a Map whose keys are the values resulting from applying the classification function to the input elements, and whose corresponding values are Lists containing the input elements which map to the associated key under the classification function.

There are no guarantees on the type, mutability, serializability, or thread-safety of the Map or List objects returned.

toList()ListV

ListV

A List as value receiver.

Receive values as List from this Signal.

toMap(FunctionV, KeykeyGenerator)MapKey, V

Key
FunctionV, KeykeyGenerator

A Map key generator.

MapKey, V

A Map as value receiver.

Receive values as Map from this Signal.

toMap(FunctionV, KeykeyGenerator, FunctionV, ValuevalueGenerator)MapKey, Value

Key
Value
FunctionV, KeykeyGenerator

A Map key generator.

FunctionV, ValuevalueGenerator

A Map value generator.

MapKey, Value

A Map as value receiver.

Receive values as Map from this Signal.

toSet()SetV

SetV

A Set as value receiver.

Receive values as Set from this Signal.

all(Predicate?Vcondition)SignalBoolean

Predicate?Vcondition

A condition that evaluates an item and returns a Boolean.

SignalBoolean

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns Signal that emits a Boolean that indicates whether all the items emitted by the source Signal satisfy a condition.

any(Predicate?Vcondition)SignalBoolean

Predicate?Vcondition

A condition to test items emitted by the source Signal.

SignalBoolean

A Signal that emits a Boolean that indicates whether any item emitted by the source Signal satisfies the predicate.

Returns a Signal that emits true if any item emitted by the source Signal satisfies a specified condition, otherwise false. Note: this always emits false if the source Signal is empty.

as(Class?Rtype)SignalR

R
Class?Rtype

The type of result. null throws NullPointerException.

SignalR

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Filters the values of an Signal sequence based on the specified type.

buffer()SignalListV

SignalListV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

It accumulates all the elements and flows them together as List buffer upon completion.

 ───①───⑑───⑒──╂
 ↓ ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 buffer (all)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓
 ────────────[β‘ β‘‘β‘’]β•‚
 

buffer(intsize)SignalListV

intsize

A length of each buffer.

SignalListV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

It accumulates elements, and whenever it reaches the specified size, it flows them together as List buffer. Note that if the elements have not accumulated to the specified size at the time of completion, they will all be discarded.

 ───①─⑑─⑒─④─⑀─β‘₯─⑦╂
 ↓ ↓ ↓ ↓ ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 buffer (3)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓
 ──────[β‘ β‘‘β‘’]──[β‘£β‘€β‘₯]─╂
 

buffer(intsize, intinterval)SignalListV

intsize

A length of each buffer. Zero or negative number are treated exactly the same way as 1.

intinterval

A number of values to skip between creation of consecutive buffers. Zero or negative number are treated exactly the same way as 1.

SignalListV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

It accumulates elements at the specified intervals, and whenever it reaches the specified size, it flows them together as List buffer. Note that if the elements have not accumulated to the specified size at the time of completion, they will all be discarded.

 ───①───⑑───⑒───④───⑀─╂
 ↓ ↓ ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 buffer (2, 1)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓
 ───────[β‘ β‘‘]─[β‘‘β‘’]─[β‘’β‘£]─[β‘£β‘€]─╂
 

buffer(Signaltiming)SignalListV

Signaltiming

A timing Signal.

SignalListV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

It accumulates elements and flows them together as List buffer at each specified timing. Note that all unflowed accumulated elements at the time of completion will be discarded.

 ────────▽──────────▽─╂ timing
 ↓ ↓
 ───①──⑑────⑒────④⑀───╂ signal
 ↓ ↓ ↓ ↓↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 buffer (timing)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓
 ───────[β‘ β‘‘]────────[β‘’β‘£β‘€]β•‚
 

combine(SignalOother)Signalβ…‘V, O

O
SignalOother

Another Signal to combine.

Signalβ…‘V, O

A Signal that emits items that are the result of combining the items emitted by source Signal by means of the given aggregation function.

It flows the pair of each elements coming from all signals. In order to flow a new pair, there must be at least one or more unflowed elements in every signals.

 ───①⑑──────⑒─────④⑀──╂ signal
 ↓↓ ↓ ↓↓
 ─────❢───❷──❸──❹─────╂ other
 ↓ ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 combine (other)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓
 ─────[①❢]─[⑑❷]─[⑒❸]──[④❹]──╂
 

combine(SignalOother, SignalAanother)Signalβ…’V, O, A

O
A
SignalOother

Another Signal to combine.

SignalAanother

An another Signal to combine.

Signalβ…’V, O, A

A Signal that emits items that are the result of combining the items emitted by source Signal by means of the given aggregation function.

It flows the pair of each elements coming from all signals. In order to flow a new pair, there must be at least one or more unflowed elements in every signals.

 ───①⑑──────⑒─────④⑀──╂ signal
 ↓↓ ↓ ↓↓
 ─────❢───❷──❸──❹─────╂ other
 ↓ ↓ ↓ ↓
 ──⒢───────Ⓑ────────Ⓒ─╂ another
 ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 combine (other, another)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓
 ────[①❢⒢]─[⑑❷Ⓑ]─────[⑒❸Ⓒ]─╂
 

combine(SignalOother, BiFunctionV, O, Rcombiner)SignalR

O
R
SignalOother

Another Signal to combine.

BiFunctionV, O, Rcombiner

An aggregation function used to combine the items emitted by the source Signal.

SignalR

A Signal that emits items that are the result of combining the items emitted by source Signal by means of the given aggregation function.

It flows the pair of each elements coming from all signals. In order to flow a new pair, there must be at least one or more unflowed elements in every signals.

 ───①⑑──────⑒─────④⑀─╂ signal
 ↓↓ ↓ ↓↓
 β”€β”€β”€β”€β”€β—‹β”€β”€β”€β—β”€β”€β—Žβ”€β”€β—β”€β”€β”€β”€β•‚ other
 ↓ ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 combine (other, a and b)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓
 ─────①───❷──⓷────❹──╂
 

combine(SignalVothers, BinaryOperatorVoperator)SignalV

SignalVothers

Other Signal to combine.

BinaryOperatorVoperator

A function that, when applied to an item emitted by each of the source Signal, results in an item that will be emitted by the resulting Signal.

SignalV

A Signal that emits items that are the result of combining the items emitted by source Signal by means of the given aggregation function.

It flows the pair of each elements coming from all signals. In order to flow a new pair, there must be at least one or more unflowed elements in every signals.

 ───①⑑──────⑒─────④⑀─╂ signal
 ↓↓ ↓ ↓↓
 β”€β”€β”€β”€β”€β—‹β”€β”€β”€β—β”€β”€β—Žβ”€β”€β—β”€β”€β”€β”€β•‚ other
 ↓ ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 combine (other, a and b)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓
 ─────①───❷──⓷────❹──╂
 

combineLatest(SignalOother)Signalβ…‘V, O

O
SignalOother

Another Signal to combine.

Signalβ…‘V, O

An Signal that emits items that are the result of combining the items emitted by the source Signal by means of the given aggregation function

It flows the pair of each latest elements coming from all signals. In order to flow a new pair, there must be at least one or more unflowed elements in any signal.

 ───①⑑───────⑒───④──╂ signal
 ↓↓ ↓ ↓
 ─────❢───❷─────────╂ other
 ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 combineLatest (other)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓
 ────[⑑❢]─[⑑❷]─[⑒❷]─[④❷]──╂
 

combineLatest(SignalOother, SignalAanother)Signalβ…’V, O, A

O
A
SignalOother

Another Signal to combine.

SignalAanother

An another Signal to combine.

Signalβ…’V, O, A

An Signal that emits items that are the result of combining the items emitted by the source Signal by means of the given aggregation function

It flows the pair of each latest elements coming from all signals. In order to flow a new pair, there must be at least one or more unflowed elements in any signal.

 ───①⑑─────────⑒──────╂ signal
 ↓↓ ↓
 ─────❢────❷──────────╂ other
 ↓ ↓
 ──⒢────────────────Ⓑ─╂ another
 ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 combineLatest (other, another)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓
 ────[⑑❢⒢]─[⑑❷⒢]─[⑒❷⒢]─[⑒❷Ⓑ]β•‚
 

combineLatest(SignalOother, BiFunctionV, O, Rfunction)SignalR

O
R
SignalOother

Another Signal to combine.

BiFunctionV, O, Rfunction

An aggregation function used to combine the items emitted by the source Signal.

SignalR

An Signal that emits items that are the result of combining the items emitted by the source Signal by means of the given aggregation function

It flows the pair of each latest elements coming from all signals. In order to flow a new pair, there must be at least one or more unflowed elements in any signal.

 ───①⑑───────⑒───④──╂ signal
 ↓↓ ↓ ↓
 β”€β”€β”€β”€β”€β—Žβ”€β”€β”€β—β”€β”€β”€β”€β”€β—‹β”€β”€β”€β•‚ other
 ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 combineLatest (other, A and B)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓↓
 ─────ⓢ───❷──❸──⑒④─╂
 

combineLatest(SignalVothers, BinaryOperatorVoperator)SignalV

SignalVothers

Other Signal to combine.

BinaryOperatorVoperator

An aggregation function used to combine the items emitted by the source Signal.

SignalV

An Signal that emits items that are the result of combining the items emitted by the source Signal by means of the given aggregation function

It flows the pair of each latest elements coming from all signals. In order to flow a new pair, there must be at least one or more unflowed elements in any signal.

 ───①⑑───────⑒───④──╂ signal
 ↓↓ ↓ ↓
 β”€β”€β”€β”€β”€β—Žβ”€β”€β”€β—β”€β”€β”€β”€β”€β—‹β”€β”€β”€β•‚ other
 ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 combineLatest (others, A and B)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓↓
 ─────ⓢ───❷──❸──⑒④──╂
 

concat(Signal?Vothers)SignalV

Signal?Vothers

A sequence of Signals to concat.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Start the specified signal after the current signal is completed.

 ───①⑑──⑒──╂ signal
 ↓↓ ↓ ↓
 ─④───⑀β‘₯─╂ other
 ↓ ↓↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 concat (other)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓↓ ↓ ↓ ↓↓
 ───①⑑──⑒───④───⑀β‘₯─╂
 

concat(IterableSignal?Vothers)SignalV

IterableSignal?Vothers

A sequence of Signals to concat.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Start the specified signal after the current signal is completed.

 ───①⑑──⑒──╂ signal
 ↓↓ ↓ ↓
 ─④───⑀β‘₯─╂ other
 ↓ ↓↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 concat (other)
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓↓ ↓ ↓ ↓↓
 ───①⑑──⑒───④───⑀β‘₯─╂
 

concatMap(WiseFunctionV, SignalRfunction)SignalR

R
WiseFunctionV, SignalRfunction

A function that, when applied to an item emitted by the current Signal, returns an Signal

SignalR

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns a new Signal that emits items resulting from applying a function that you supply to each item emitted by the current Signal, where that function returns an Signal, and then emitting the items that result from concatenating those returned Signal.

count()SignalLong

SignalLong Signal that emits a single item: the number of items emitted by the source Signal as a 64-bit Long item

Returns a Signal that counts the total number of items emitted by the source Signal and emits this count as a 64-bit Long.

debounce(longtime, TimeUnitunit, ScheduledExecutorServicescheduler)SignalV

longtime

A time value. Zero or negative number will ignore this instruction.

TimeUnitunit

A time unit. null will ignore this instruction.

ScheduledExecutorServicescheduler
SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Drops values that are followed by newer values before a timeout. The timer resets on each value emission.

debounce(longtime, TimeUnitunit, booleanacceptFirst, ScheduledExecutorServicescheduler)SignalV

longtime

A time value. Zero or negative number will ignore this instruction.

TimeUnitunit

A time unit. null will ignore this instruction.

booleanacceptFirst

Determines whether to pass the first element or not. It is useful to get the beginning and end of a sequence of events.

ScheduledExecutorServicescheduler
SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Drops values that are followed by newer values before a timeout. The timer resets on each value emission.

debounce(VariableLongtime, TimeUnitunit, booleanacceptFirst, ScheduledExecutorServicescheduler)SignalV

VariableLongtime

A time value. Zero or negative number will ignore this instruction.

TimeUnitunit

A time unit. null will ignore this instruction.

booleanacceptFirst

Determines whether to pass the first element or not. It is useful to get the beginning and end of a sequence of events.

ScheduledExecutorServicescheduler
SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Drops values that are followed by newer values before a timeout. The timer resets on each value emission.

debounceAll(longtime, TimeUnitunit, ScheduledExecutorServicescheduler)SignalListV

longtime

A time value. Zero or negative number will ignore this instruction.

TimeUnitunit

A time unit. null will ignore this instruction.

ScheduledExecutorServicescheduler
SignalListV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Collect values that are followed by newer values before a timeout. The timer resets on each value emission.

debounceAll(VariableLongtime, TimeUnitunit, ScheduledExecutorServicescheduler)SignalListV

VariableLongtime

A time value. Zero or negative number will ignore this instruction.

TimeUnitunit

A time unit. null will ignore this instruction.

ScheduledExecutorServicescheduler
SignalListV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Collect values that are followed by newer values before a timeout. The timer resets on each value emission.

delay(longtime, TimeUnitunit, ScheduledExecutorServicescheduler)SignalV

longtime

The delay to shift the source by.

TimeUnitunit

The TimeUnit in which period is defined.

ScheduledExecutorServicescheduler

An event scheduler.

SignalV

The source Signal shifted in time by the specified delay.

Returns Signal that emits the items emitted by the source Signal shifted forward in time by a specified delay at parallel thread. Error notifications from the source Signal are not delayed.

delay(Durationtime, ScheduledExecutorServicescheduler)SignalV

Durationtime

The delay to shift the source by.

ScheduledExecutorServicescheduler
SignalV

The source Signal shifted in time by the specified delay.

Returns Signal that emits the items emitted by the source Signal shifted forward in time by a specified delay at parallel thread. Error notifications from the source Signal are not delayed.

delay(FunctionV, Durationtime, ScheduledExecutorServicescheduler)SignalV

FunctionV, Durationtime

The delay to shift the source by.

ScheduledExecutorServicescheduler
SignalV

The source Signal shifted in time by the specified delay.

Returns Signal that emits the items emitted by the source Signal shifted forward in time by a specified delay at parallel thread. Error notifications from the source Signal are not delayed.

diff()SignalV

SignalV Signal that emits those items from the source Signal that are distinct from their immediate predecessors.

Returns an Signal that emits all items emitted by the source Signal that are distinct from their immediate predecessors based on Object#equals(Object) comparison.

It is recommended the elements' class V in the flow overrides the default Object.equals() to provide meaningful comparison between items as the default Java implementation only considers reference equivalence. Alternatively, use the #diff(BiPredicate) overload and provide a comparison function in case the class V can't be overridden preassign custom equals() or the comparison itself should happen on different terms or properties of the class V.

diff(BiPredicateV, Vcompare)SignalV

BiPredicateV, Vcompare

The function that receives the previous item and the current item and is expected to return true if the two are equal, thus skipping the current value.

SignalV Signal that emits those items from the source Signal that are distinct from their immediate predecessors.

Returns an Signal that emits all items emitted by the source Signal that are distinct from their immediate predecessors when compared preassign each other via the provided comparator function.

distinct()SignalV

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal consisting of the distinct values (according to Object#equals(Object)) of this stream.

distinct(WiseFunctionV, ?keySelector)SignalV

WiseFunctionV, ?keySelector
SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal consisting of the distinct values (according to Object#equals(Object)) of this stream.

effect(WiseRunnableeffect)SignalV

WiseRunnableeffect

The action to invoke when the source Signal calls Observer#accept(Object)

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect when it calls Observer#accept(Object).

effect(WiseConsumer?Veffect)SignalV

WiseConsumer?Veffect

The action to invoke when the source Signal calls Observer#accept(Object)

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect when it calls Observer#accept(Object).

effectAfter(WiseRunnableeffect)SignalV

WiseRunnableeffect

The action to invoke when the source Signal calls Observer#accept(Object)

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect when it calls Observer#accept(Object).

effectAfter(WiseConsumer?Veffect)SignalV

WiseConsumer?Veffect

The action to invoke when the source Signal calls Observer#accept(Object)

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect when it calls Observer#accept(Object).

effectOnce(WiseRunnableeffect)SignalV

WiseRunnableeffect

The action to invoke only once when the source Signal calls Observer#accept(Object)

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect only once when it calls Observer#accept(Object).

effectOnce(WiseConsumer?Veffect)SignalV

WiseConsumer?Veffect

The action to invoke only once when the source Signal calls Observer#accept(Object)

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect only once when it calls Observer#accept(Object).

effectOnComplete(WiseRunnableeffect)SignalV

WiseRunnableeffect

The action to invoke when the source Signal calls Observer#complete()

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect when it calls Observer#complete().

effectOnDispose(WiseRunnableeffect)SignalV

WiseRunnableeffect

The action to invoke when the source Signal calls Disposable#dispose()

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect when it calls Disposable#dispose().

effectOnError(WiseRunnableeffect)SignalV

WiseRunnableeffect

The action to invoke when the source Signal calls Observer#error(Throwable)

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect when it calls Observer#error(Throwable).

effectOnError(WiseConsumerThrowableeffect)SignalV

WiseConsumerThrowableeffect

The action to invoke when the source Signal calls Observer#error(Throwable)

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect when it calls Observer#error(Throwable).

effectOnLifecycle(WiseFunctionDisposable, WiseConsumerVeffect)SignalV

WiseFunctionDisposable, WiseConsumerVeffect

The action to invoke when the source Signal calls Observer#accept(Object)

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect when it calls Observer#accept(Object).

effectOnObserve(WiseRunnableeffect)SignalV

WiseRunnableeffect

The Runnable that gets called when an Observer subscribes to the current Signal.

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes the given effect when it is observed from its observers. Each observation will result in an invocation of the given action except when the source Signal is reference counted, in which case the source Signal will invoke the given action for the first observation.

effectOnObserve(WiseConsumer?Disposableeffect)SignalV

WiseConsumer?Disposableeffect

The Consumer that gets called when an Observer subscribes to the current Signal.

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes the given effect when it is observed from its observers. Each observation will result in an invocation of the given action except when the source Signal is reference counted, in which case the source Signal will invoke the given action for the first observation.

effectOnTerminate(WiseRunnableeffect)SignalV

WiseRunnableeffect

The action to invoke when the source Signal calls Observer#error(Throwable) or Observer#complete().

SignalV

The source Signal preassign the side-effecting behavior applied.

Modifies the source Signal so that it invokes an effect when it calls Observer#error(Throwable) or Observer#complete().

first()SignalV

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns Signal that emits only the very first item emitted by the source Signal, or completes if the source Signal is empty.

flatArray(WiseFunctionV, Rfunction)SignalR

R
WiseFunctionV, Rfunction

A function that, when applied to an item emitted by the source Signal , returns an Signal.

SignalR

An Signal that emits the result of applying the transformation function to each item emitted by the source Signal and merging the results of the Signal obtained from this transformation.

Returns an Signal that emits items based on applying a function that you supply to each item emitted by the source Signal, where that function returns an Signal , and then merging those resulting Signal and emitting the results of this merger.

flatIterable(WiseFunctionV, ?IterableRfunction)SignalR

R
WiseFunctionV, ?IterableRfunction

A function that, when applied to an item emitted by the source Signal , returns an Signal.

SignalR

An Signal that emits the result of applying the transformation function to each item emitted by the source Signal and merging the results of the Signal obtained from this transformation.

Returns an Signal that emits items based on applying a function that you supply to each item emitted by the source Signal, where that function returns an Signal , and then merging those resulting Signal and emitting the results of this merger.

flatMap(WiseFunctionV, SignalRfunction)SignalR

R
WiseFunctionV, SignalRfunction

A function that, when applied to an item emitted by the source Signal , returns an Signal.

SignalR

An Signal that emits the result of applying the transformation function to each item emitted by the source Signal and merging the results of the Signal obtained from this transformation.

Returns an Signal that emits items based on applying a function that you supply to each item emitted by the source Signal, where that function returns an Signal , and then merging those resulting Signal and emitting the results of this merger.

flatMap(SupplierCcontext, WiseBiFunctionC, V, SignalRfunction)SignalR

C
R
SupplierCcontext
WiseBiFunctionC, V, SignalRfunction

A function that, when applied to an item emitted by the source Signal , returns an Signal.

SignalR

An Signal that emits the result of applying the transformation function to each item emitted by the source Signal and merging the results of the Signal obtained from this transformation.

Returns an Signal that emits items based on applying a function that you supply to each item emitted by the source Signal, where that function returns an Signal , and then merging those resulting Signal and emitting the results of this merger.

flatVariable(WiseFunctionV, VariableRfunction)SignalR

R
WiseFunctionV, VariableRfunction

A function that, when applied to an item emitted by the source Signal , returns an Signal.

SignalR

An Signal that emits the result of applying the transformation function to each item emitted by the source Signal and merging the results of the Signal obtained from this transformation.

Returns an Signal that emits items based on applying a function that you supply to each item emitted by the source Signal, where that function returns an Signal , and then merging those resulting Signal and emitting the results of this merger.

index(longstart)Signalβ…‘V, Long

longstart

A starting index number.

Signalβ…‘V, Long

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Append index (starting from the specified value).

interval(longinterval, TimeUnitunit, ScheduledExecutorServicescheduler)SignalV

longinterval

Time to emit values. Zero or negative number will ignore this instruction.

TimeUnitunit

A unit of time for the specified interval. null will ignore this instruction.

ScheduledExecutorServicescheduler
SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Ensure the interval time for each values in Signal sequence.

is(Predicate?Vcondition)SignalBoolean

Predicate?Vcondition

A conditional function to apply to each value emitted by this Signal.

SignalBoolean

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal that applies the given Predicate function to each value emitted by an Signal and emits the result.

isNot(Predicate?Vcondition)SignalBoolean

Predicate?Vcondition

A conditional function to apply to each value emitted by this Signal.

SignalBoolean

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal that applies the given Predicate function to each value emitted by an Signal and emits the result.

isCompleted()SignalBoolean

SignalBoolean

A Signal that emits true when the source Signal is completed.

Returns Signal that emits true that indicates whether the source Signal is completed.

isEmitted()SignalBoolean

SignalBoolean

A Signal that emits true when the source Signal emits any value.

Returns Signal that emits true that indicates whether the source Signal emits any value.

isEmpty()SignalBoolean

SignalBoolean

A Signal that emits true when the source Signal is completed preassignout any value emitted.

Returns Signal that emits true that indicates whether the source Signal is completed preassignout any value emitted.

isErred()SignalBoolean

SignalBoolean

A Signal that emits true when the source Signal is erred.

Returns Signal that emits true that indicates whether the source Signal is erred.

isSignaled()SignalBoolean

SignalBoolean

A Signal that emits true when the source Signal is emitted, erred or completed.

Returns Signal that emits true that indicates whether the source Signal is emitted, erred or completed.

isTerminated()SignalBoolean

SignalBoolean

A Signal that emits true when the source Signal is erred or completed.

Returns Signal that emits true that indicates whether the source Signal is erred or completed.

joinAll(WiseFunctionV, Rfunction, ExecutorServiceexecutor)SignalR

R
WiseFunctionV, Rfunction

A mapper function.

ExecutorServiceexecutor
SignalR

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns a new Signal that invokes the mapper action in parallel thread and waits all of them until all actions are completed.

joinAllOrNone(WiseFunctionV, Rfunction, ExecutorServiceexecutor)SignalR

R
WiseFunctionV, Rfunction

The task mapper function.

ExecutorServiceexecutor
SignalR

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Executes all tasks in parallel and returns their results only if all succeed. If any task fails, all remaining tasks are cancelled and the exception is propagated.

joinAny(WiseFunctionV, Rfunction, ExecutorServiceexecutor)SignalR

R
WiseFunctionV, Rfunction

A mapper function.

ExecutorServiceexecutor
SignalR

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns a new Signal that invokes the mapper action in parallel thread and waits until any single action is completed. All other actions will be cancelled.

keyMap(WiseFunctionV, SignalRfunction)SignalMapV, R

R
WiseFunctionV, SignalRfunction

A function that, when applied to an item emitted by the source Signal , returns an Signal.

SignalMapV, R

An Signal that emits the result of applying the transformation function to each item emitted by the source Signal and merging the results of the Signal obtained from this transformation.

Returns an Signal that emits items based on applying a function that you supply to each item emitted by the source Signal, where that function returns an Signal , and then merging those resulting Signal and emitting the results of this merger.

last()SignalV

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns a Signal that emits the last item emitted by this Signal or completes if this Signal is empty.

map(WiseFunction?V, Rfunction)SignalR

R
WiseFunction?V, Rfunction

A converter function to apply to each value emitted by this Signal . null will ignore this instruction.

SignalR

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal that applies the given function to each value emitted by an Signal and emits the result.

 ───①───⑑───⑒───④───⑀──┼
 ↓ ↓ ↓ ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 map ○→●
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓ ↓ ↓
 ───❢───❷───❸───❹───❺──┼
 

map(SupplierCcontext, WiseBiFunctionC, ?V, Rfunction)SignalR

C
R
SupplierCcontext

A Supplier of Signal specific context.

WiseBiFunctionC, ?V, Rfunction

A converter function to apply to each value emitted by this Signal . null will ignore this instruction.

SignalR

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

#map(WiseFunction) preassign context.

 ───①───⑑───⑒───④───⑀──┼
 ↓ ↓ ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 map ○→●
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓ ↓ ↓
 ───❢───❷───❸───❹───❺──┼
 

mapError(WiseFunctionThrowable, Throwablefunction)SignalV

WiseFunctionThrowable, Throwablefunction
SignalV

mapTo(Rconstant)SignalR

R
Rconstant

A constant to apply to each value emitted by this Signal.

SignalR

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal that applies the given constant to each item emitted by an Signal and emits the result.

merge(Signal?Vothers)SignalV

Signal?Vothers

A target Signal to merge. null will be ignored.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Flattens a sequence of Signal emitted by an Signal into one Signal, preassignout any transformation.

 ───①───⑑───⑒───④───⑀──┼
 ↓ ↓ ↓ ↓ ↓
 ─────❢────❷────❸────┼
 ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 merge
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓↓ ↓ ↓ ↓
 ───①─❢─⑑──❷⑒───④❸──⑀──┼
 

merge(IterableSignal?Vothers)SignalV

IterableSignal?Vothers

A target Signal set to merge. null will be ignored.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Flattens a sequence of Signal emitted by an Signal into one Signal, preassignout any transformation.

on(ConsumerRunnablescheduler)SignalV

ConsumerRunnablescheduler

A new context

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Switch event stream context.

 ───①───⑑───⑒───④───⑀──┼
 ↓ ↓ ↓ ↓ ↓
 β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
 on ━
 β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
 ↓ ↓ ↓ ↓ ↓ ↓
 ━━━❢━━━❷━━━❸━━━❹━━━❺━━╋
 

or(Vvalue)SignalV

Vvalue
SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Generates an Signal sequence that guarantee one item at least.

or(SupplierVvalue)SignalV

SupplierVvalue
SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Generates an Signal sequence that guarantee one item at least.

or(SignalVvalues)SignalV

SignalVvalues
SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Generates an Signal sequence that guarantee one item at least.

plug(FunctionSignalV, SignalOplug)SignalO

O

An output type.

FunctionSignalV, SignalOplug

A chain builder to insert.

SignalO

A chained Signal.

Helps to insert Signal chain from outside.

recurse(WiseFunctionV, Vrecurse, Executorexecutor)SignalV

WiseFunctionV, Vrecurse

A mapper function to enumerate values recursively.

Executorexecutor

An execution context.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal that emits items based on applying a function that you supply to each item emitted by the source Signal, where that function returns an Signal , and then merging those resulting Signal and emitting the results of this merger.

recurseMap(WiseFunctionSignalV, SignalVrecurse, Executorexecutor)SignalV

WiseFunctionSignalV, SignalVrecurse

A mapper function to enumerate values recursively.

Executorexecutor

An execution context.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal that emits items based on applying a function that you supply to each item emitted by the source Signal, where that function returns an Signal , and then merging those resulting Signal and emitting the results of this merger.

recover(Vvalue)SignalV

Vvalue

A value to replace error.

SignalV

Chainable API

Recover the source Signal on the specified error by the specified value. Unspecified error types will pass through the source Signal.

recover(WiseFunctionSignalE, SignalVflow)SignalV

EThrowable
WiseFunctionSignalE, SignalVflow

An error notifier to define recovering flow.

SignalV

Chainable API

Recover the source Signal on the specified error by the notifier emitting values. Unspecified errors will pass through the source Signal.

When the notifier signal emits event
  • Next - Replace source error and propagate values to source signal.
  • Error - Propagate to source error and dispose them.
  • Complete - Terminate notifier signal. Source signal will never recover errors.

repeat()SignalV

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Generates an Signal sequence that repeats the given value infinitely.

repeat(WiseFunctionSignal?, Signal?flow)SignalV

WiseFunctionSignal?, Signal?flow

A receives an Signal of notifications preassign which a user can complete or error, aborting the retry.

SignalV

Chainable API

Returns an Signal that emits the same values as the source signal preassign the exception to an Observer#error(Throwable). An error notification from the source will result in the emission of a Throwable item to the Signal provided as an argument to the notificationHandler function. If that Signal calls Observer#complete() or Observer#error(Throwable) then retry will call Observer#complete() or Observer#error(Throwable) on the child subscription. Otherwise, this Signal will resubscribe to the source Signal.

retry()SignalV

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Retry the source Signal infinitely whenever any error is occurred.

retry(WiseFunctionSignalE, Signal?flow)SignalV

EThrowable
WiseFunctionSignalE, Signal?flow

An error notifier to define retrying flow.

SignalV

Chainable API

Retry the source Signal when the specified error is occurred. Unspecified errors will pass through the source Signal.

When the notifier signal emits event
  • Next - Retry source Signal.
  • Error - Propagate to source error and dispose them.
  • Complete - Terminate notifier signal. Source signal will never retry errors.

reverse()SignalV

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Buffer all values until complete, then all buffered values are emitted in descending order.

sample(Signal?sampler)SignalV

Signal?sampler

An Signal to use for sampling the source Signal.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal that, when the specified sampler Signal emits an item, emits the most recently emitted item (if any) emitted by the source Signal since the previous emission from the sampler Signal.

scan(Collector?V, A, Rcollector)SignalR

A
R
Collector?V, A, Rcollector

An accumulator function to be invoked on each item emitted by the source Signal, whose result will be emitted to Signal via Observer#accept(Object) and used in the next accumulator call.

SignalR

An Signal that emits initial value followed by the results of each call to the accumulator function.

Returns an Signal that applies a function of your choosing to the first item emitted by a source Signal and a seed value, then feeds the result of that function along preassign the second item emitted by the source Signal into the same function, and so on until all items have been emitted by the source Signal, emitting the result of each of these iterations.

scan(SupplierRinit, WiseBiFunctionR, V, Rfunction)SignalR

R
SupplierRinit

An initial (seed) accumulator item.

WiseBiFunctionR, V, Rfunction

An accumulator function to be invoked on each item emitted by the source Signal, whose result will be emitted to Signal via Observer#accept(Object) and used in the next accumulator call.

SignalR

An Signal that emits initial value followed by the results of each call to the accumulator function.

Returns an Signal that applies a function of your choosing to the first item emitted by a source Signal and a seed value, then feeds the result of that function along preassign the second item emitted by the source Signal into the same function, and so on until all items have been emitted by the source Signal, emitting the result of each of these iterations.

scan(WiseFunctionV, Rfirst, WiseBiFunctionR, V, Rothers)SignalR

R
WiseFunctionV, Rfirst

An accumulator which process only first value.

WiseBiFunctionR, V, Rothers

An accumulator function to be invoked on each item emitted by the source Signal, whose result will be emitted to Signal via Observer#accept(Object) and used in the next accumulator call.

SignalR

An Signal that emits initial value followed by the results of each call to the accumulator function.

Returns an Signal that applies a function of your choosing to the first item emitted by a source Signal and a seed value, then feeds the result of that function along preassign the second item emitted by the source Signal into the same function, and so on until all items have been emitted by the source Signal, emitting the result of each of these iterations.

sequenceMap(WiseFunctionV, SignalRfunction)SignalR

R
WiseFunctionV, SignalRfunction

A function that maps a sequence of values into a sequence of Signal that will be eagerly concatenated.

SignalR

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Maps a sequence of values into Signal and concatenates these Signal eagerly into a single Signal. Eager concatenation means that once a subscriber subscribes, this operator subscribes to all the source Signal. The operator buffers the values emitted by these Signal and then drains them in order, each one after the previous one completes.

share()SignalV

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns a new Signal that multicasts (shares) the original Signal. As long as there is at least one Observer this Signal will be subscribed and emitting data. When all observers have disposed it will disposes from the source Signal.

skip(longcount)SignalV

longcount

A number of values to skip. Zero or negative number will ignore this instruction.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Bypasses a specified number of values in an Signal sequence and then returns the remaining values.

skip(Vexcludes)SignalV

Vexcludes

A collection of skip items.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Alias for skip(I.set(excludes)).

skip(Predicate?Vcondition)SignalV

Predicate?Vcondition

A skip condition.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Alias for take(condition.negate()).

skip(Vinit, BiPredicate?V, ?Vcondition)SignalV

Vinit
BiPredicate?V, ?Vcondition

A skip condition.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Alias for take(init, condition.negate()).

skip(SupplierCcontextSupplier, BiPredicateC, ?Vcondition)SignalV

C
SupplierCcontextSupplier

A Supplier of Signal specific context.

BiPredicateC, ?Vcondition

A condition function to apply to each value emitted by this Signal . null will ignore this instruction.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

#skip(Predicate) preassign context.

skip(SignalBooleancondition)SignalV

SignalBooleancondition

An external boolean Signal. null will ignore this instruction.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal consisting of the values of this Signal that match the given predicate.

skipAt(LongPredicatecondition)SignalV

LongPredicatecondition

An index condition of values to emit.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns a specified index values from the start of an Signal sequence.

skipIf(FunctionV, Signal?condition)SignalV

FunctionV, Signal?condition

A function that evaluates an item emitted by the source Signal and returns a value.

SignalV

An Signal that first emits items emitted by the source Signal, checks the specified condition after each item, and then completes if the condition is not signaled.

Returns an Signal that emits items emitted by the source Signal, checks the specified predicate for each item, and then completes if the condition is not signaled.

skipError(Class?Throwabletypes)SignalV

Class?Throwabletypes

A list of error types to ignore.

SignalV Signal which ignores the specified error.

Return the Signal which ignores the specified error.

skipComplete()SignalV

SignalV Signal which ignores complete event.

Return the Signal which ignores complete event.

skipNull()SignalV

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Alias for skip(Objects::isNull).

skipUntil(Predicate?Vpredicate)SignalV

Predicate?Vpredicate

A function to test each item emitted from the source Signal.

SignalV

An Signal that begins emitting items emitted by the source Signal when the specified predicate becomes false.

Returns an Signal that skips all items emitted by the source Signal as long as a specified condition holds true, but emits all further source items as soon as the condition becomes false.

skipUntil(Signaltiming)SignalV

Signaltiming

The second Signal that has to emit an item before the source Signal elements begin to be mirrored by the resulting Signal.

SignalV

An Signal that skips items from the source Signal until the second Signal emits an item, then emits the remaining items.

Returns the values from the source Signal sequence only after the other Signal sequence produces a value.

skipWhile(Predicate?Vpredicate)SignalV

Predicate?Vpredicate

A function to test each item emitted from the source Signal.

SignalV

An Signal that begins emitting items emitted by the source Signal when the specified predicate becomes false.

Returns an Signal that skips all items emitted by the source Signal as long as a specified condition holds true, but emits all further source items as soon as the condition becomes false.

sort(Comparator?Vcomparator)SignalV

Comparator?Vcomparator
SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Buffer all items until complete event and then sorted items will be emitted sequentially.

startWith(Vvalues)SignalV

Vvalues

The values that contains the items you want to emit first.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Emit a specified sequence of items before beginning to emit the items from the source Signal.

If you want an Signal to emit a specific sequence of items before it begins emitting the items normally expected from it, apply the StartWith operator to it.

If, on the other hand, you want to append a sequence of items to the end of those normally emitted by an Signal, you want the #sequenceMap(WiseFunction) operator.

startWith(SupplierVvalue)SignalV

SupplierVvalue

The values that contains the items you want to emit first.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Emit a specified sequence of items before beginning to emit the items from the source Signal.

If you want an Signal to emit a specific sequence of items before it begins emitting the items normally expected from it, apply the StartWith operator to it.

If, on the other hand, you want to append a sequence of items to the end of those normally emitted by an Signal, you want the #sequenceMap(WiseFunction) operator.

startWith(IterableVvalues)SignalV

IterableVvalues

The values that contains the items you want to emit first.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Emit a specified sequence of items before beginning to emit the items from the source Signal.

If you want an Signal to emit a specific sequence of items before it begins emitting the items normally expected from it, apply the StartWith operator to it.

If, on the other hand, you want to append a sequence of items to the end of those normally emitted by an Signal, you want the #sequenceMap(WiseFunction) operator.

startWith(SignalVvalues)SignalV

SignalVvalues

The initial values.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Emit a specified sequence of items before beginning to emit the items from the source Signal.

startWithNull()SignalV

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Emit null item before beginning to emit the items from the source Signal.

stopError(Class?Throwabletypes)SignalV

Class?Throwabletypes

A list of error types to replace.

SignalV Signal which replaces the specified error by complete event.

Return the Signal which replaces the specified error by complete event.

subscribeOn(ConsumerRunnablescheduler)SignalV

ConsumerRunnablescheduler

You specify which scheduler this operator will use.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Asynchronously subscribes Observer to this Signal on the specified scheduler.

switchMap(WiseFunctionV, SignalRfunction)SignalR

R
WiseFunctionV, SignalRfunction

A function that, when applied to an item emitted by the source Signal , returns an Signal.

SignalR

An Signal that emits the result of applying the transformation function to each item emitted by the source Signal and merging the results of the Signal obtained from this transformation.

Returns an Signal that emits items based on applying a function that you supply to each item emitted by the source Signal, where that function returns an Signal , and then merging the latest resulting Signal and emitting the results of this merger.

switchVariable(WiseFunctionV, VariableRfunction)SignalR

R
WiseFunctionV, VariableRfunction

A function that, when applied to an item emitted by the source Signal , returns an Signal.

SignalR

An Signal that emits the result of applying the transformation function to each item emitted by the source Signal and merging the results of the Signal obtained from this transformation.

Returns an Signal that emits items based on applying a function that you supply to each item emitted by the source Signal, where that function returns an Signal , and then merging the latest resulting Signal and emitting the results of this merger.

switchOff(SignalBooleantiming)SignalV

SignalBooleantiming

A timing whether the Signal is observed or not.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Return an Signal that is observed as long as the specified timing Signal indicates false. When the timing Signal returns true, the currently subscribed Signal is immediately disposed.

switchOn(SignalBooleantiming)SignalV

SignalBooleantiming

A timing whether the Signal is observed or not.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Return an Signal that is observed as long as the specified timing Signal indicates true. When the timing Signal returns false, the currently subscribed Signal is immediately disposed.

take(longcount)SignalV

longcount

A number of values to emit. Zero or negative number will ignore this instruction.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns a specified number of contiguous values from the start of an Signal sequence.

take(Vincludes)SignalV

Vincludes

A collection of take items.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Alias for take(I.set(includes)).

take(Predicate?Vcondition)SignalV

Predicate?Vcondition

A function that evaluates the values emitted by the source Signal, returning true if they pass the filter. null will ignore this instruction.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal consisting of the values of this Signal that match the given predicate.

take(Vinit, BiPredicate?V, ?Vcondition)SignalV

Vinit
BiPredicate?V, ?Vcondition

A function that evaluates the values emitted by the source Signal, returning true if they pass the filter. null will ignore this instruction.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal consisting of the values of this Signal that match the given predicate.

take(SupplierCcontextSupplier, BiPredicateC, ?Vcondition)SignalV

C
SupplierCcontextSupplier

A Supplier of Signal specific context.

BiPredicateC, ?Vcondition

A condition function to apply to each value emitted by this Signal . null will ignore this instruction.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

#take(Predicate) preassign context.

take(SignalBooleancondition)SignalV

SignalBooleancondition

An external boolean Signal. null will ignore this instruction.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal consisting of the values of this Signal that match the given predicate.

takeAt(LongPredicatecondition)SignalV

LongPredicatecondition

An index condition of values to emit.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns a specified index values from the start of an Signal sequence.

takeIf(FunctionV, Signal?condition)SignalV

FunctionV, Signal?condition

A function that evaluates an item emitted by the source Signal and returns a value.

SignalV

An Signal that first emits items emitted by the source Signal, checks the specified condition after each item, and then completes if the condition is signaled.

Returns an Signal that emits items emitted by the source Signal, checks the specified predicate for each item, and then completes if the condition is signaled.

takeUntil(Predicate?Vcondition)SignalV

Predicate?Vcondition

A function that evaluates an item emitted by the source Signal and returns a Boolean.

SignalV

An Signal that first emits items emitted by the source Signal, checks the specified condition after each item, and then completes if the condition is satisfied.

Returns an Signal that emits items emitted by the source Signal, checks the specified predicate for each item, and then completes if the condition is satisfied.

takeUntil(Signaltiming)SignalV

Signaltiming

A Signal whose first emitted item will cause takeUntil to stop emitting items from the source Signal. null will ignore this. instruction.

SignalV

A Signal that emits the items emitted by the source Signal until such time as other emits its first item.

Returns Signal that emits the items emitted by the source Signal until a second Signal emits an item.

takeWhile(Predicate?Vcondition)SignalV

Predicate?Vcondition

A function that evaluates an item emitted by the source Signal and returns a Boolean.

SignalV

An Signal that first emits items emitted by the source Signal, checks the specified condition after each item, and then completes if the condition is satisfied.

Returns an Signal that emits items emitted by the source Signal, checks the specified predicate for each item, and then completes if the condition is satisfied.

timeout(longtime, TimeUnitunit, ScheduledExecutorServicescheduler)SignalV

longtime

Time to take values. Zero or negative number will ignore this instruction.

TimeUnitunit

A unit of time for the specified timeout. null will ignore this instruction.

ScheduledExecutorServicescheduler

An event scheduler.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns a Signal that mirrors the source Signal but applies a timeout policy for each emitted item. If the next item isn't emitted preassignin the specified timeout duration starting from its predecessor, the resulting Signal terminates and notifies observers of a TimeoutException.

throttle(longtime, TimeUnitunit)SignalV

longtime

Time to wait before sending another item after emitting the last item. Zero or negative number will ignore this instruction.

TimeUnitunit

A unit of time for the specified timeout. null will ignore this instruction.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Throttles by skipping values until "skipDuration" passes and then emits the next received value.

Ignores the values from an Signal sequence which are followed by another value before due time preassign the specified source and time.

throttle(VariableLongtime, TimeUnitunit)SignalV

VariableLongtime

Time to wait before sending another item after emitting the last item. Zero or negative number will ignore this instruction.

TimeUnitunit

A unit of time for the specified timeout. null will ignore this instruction.

SignalV

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Throttles by skipping values until "skipDuration" passes and then emits the next received value.

Ignores the values from an Signal sequence which are followed by another value before due time preassign the specified source and time.

toggle(Evalues)SignalE

E
Evalues

A list of constants to apply to each value emitted by this Signal.

SignalE

A new Signal instance. Signal is the definition (blueprint) of the process, and does not perform any processing by itself. In order to perform the actual processing, you need to execute the termination operation (toXXX method, i.e. Signal#to() or Signal#to(Consumer)).

Returns an Signal that applies the given two constants alternately to each item emitted by an Signal and emits the result.

waitForTerminate()SignalV

SignalV

Synchronization Support Tool : Wait in the current thread until this Signal to be terminated. Termination is one of the states of completed, error or disposed.

$(WiseFunctionV, SignalRfunction)SignalR

R
WiseFunctionV, SignalRfunction

A function that, when applied to an item emitted by the source Signal , returns an Signal.

SignalR

An Signal that emits the result of applying the transformation function to each item emitted by the source Signal and merging the results of the Signal obtained from this transformation.

This is another name for #flatMap(WiseFunction), primarily for use in DSL.