reactor.core.publisher

Class Signal<T>

java.lang.Object

reactor.core.publisher.Signal<T>

Type Parameters:

T - the value type

All Implemented Interfaces:

java.io.Serializable, java.util.function.Consumer<org.reactivestreams.Subscriber<? super T>>, java.util.function.Supplier<T>

public final class Signal<T>
extends java.lang.Object
implements java.util.function.Supplier<T>, java.util.function.Consumer<org.reactivestreams.Subscriber<? super T>>, java.io.Serializable

A domain representation of a Reactive Stream signal. There are 4 distinct signals and their possible sequence is defined as such: onError | (onSubscribe onNext* (onError | onComplete)?)

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	accept(org.reactivestreams.Subscriber<? super T> observer)
static <T> Signal<T>	complete() Creates and returns a Signal of variety Type.COMPLETE.
boolean	equals(java.lang.Object o)
static <T> Signal<T>	error(java.lang.Throwable e) Creates and returns a Signal of variety Type.FAILED, and assigns it an error.
T	get() Retrieves the item associated with this (onNext) signal.
org.reactivestreams.Subscription	getSubscription() Read the subscription associated with this (onSubscribe) signal.
java.lang.Throwable	getThrowable() Read the error associated with this (onError) signal.
SignalType	getType() Read the type of this signal: Subscribe, Next, Error, or Complete
boolean	hasError() Read whether this signal is on error and carries the cause.
int	hashCode()
boolean	hasValue() Has this signal an item associated with it ?
static boolean	isComplete(java.lang.Object o)
static boolean	isError(java.lang.Object o)
boolean	isOnComplete() Indicates whether this signal represents an onComplete event.
boolean	isOnError() Indicates whether this signal represents an onError event.
boolean	isOnNext() Indicates whether this signal represents an onNext event.
boolean	isOnSubscribe() Indicates whether this signal represents an onSubscribe event.
static <T> Signal<T>	next(T t) Creates and returns a Signal of variety Type.NEXT, and assigns it a value.
static <T> Signal<T>	subscribe(org.reactivestreams.Subscription subscription) Creates and returns a Signal of variety Type.ON_SUBSCRIBE.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Method Detail

complete

public static <T> Signal<T> complete()

Creates and returns a Signal of variety Type.COMPLETE.

Type Parameters:

T - the value type

Returns:

an OnCompleted variety of Signal

error

public static <T> Signal<T> error(java.lang.Throwable e)

Creates and returns a Signal of variety Type.FAILED, and assigns it an error.

Type Parameters:

T - the value type

Parameters:

e - the error to assign to the signal

Returns:

an OnError variety of Signal

next

public static <T> Signal<T> next(T t)

Creates and returns a Signal of variety Type.NEXT, and assigns it a value.

Type Parameters:

T - the value type

Parameters:

t - the item to assign to the signal as its value

Returns:

an OnNext variety of Signal

isComplete

public static boolean isComplete(java.lang.Object o)

Parameters:

o - is the given object a complete Signal

Returns:

true if completition signal

isError

public static boolean isError(java.lang.Object o)

Parameters:

o - is the given object a complete Signal

Returns:

true if completition signal

subscribe

public static <T> Signal<T> subscribe(org.reactivestreams.Subscription subscription)

Creates and returns a Signal of variety Type.ON_SUBSCRIBE.

Type Parameters:

T - the value type

Parameters:

subscription - the subscription

Returns:

an OnCompleted variety of Signal

getThrowable

public java.lang.Throwable getThrowable()

Read the error associated with this (onError) signal.

Returns:

the Throwable associated with this (onError) signal

getSubscription

public org.reactivestreams.Subscription getSubscription()

Read the subscription associated with this (onSubscribe) signal.

Returns:

the Subscription associated with this (onSubscribe) signal

get

public T get()

Retrieves the item associated with this (onNext) signal.

Specified by:

get in interface java.util.function.Supplier<T>

Returns:

the item associated with this (onNext) signal

hasValue

public boolean hasValue()

Has this signal an item associated with it ?

Returns:

a boolean indicating whether or not this signal has an item associated with it

hasError

public boolean hasError()

Read whether this signal is on error and carries the cause.

Returns:

a boolean indicating whether this signal has an error

getType

public SignalType getType()

Read the type of this signal: Subscribe, Next, Error, or Complete

Returns:

the type of the signal

isOnError

public boolean isOnError()

Indicates whether this signal represents an onError event.

Returns:

a boolean indicating whether this signal represents an onError event

isOnComplete

public boolean isOnComplete()

Indicates whether this signal represents an onComplete event.

Returns:

a boolean indicating whether this signal represents an onSubscribe event

isOnSubscribe

public boolean isOnSubscribe()

Indicates whether this signal represents an onSubscribe event.

Returns:

a boolean indicating whether this signal represents an onSubscribe event

isOnNext

public boolean isOnNext()

Indicates whether this signal represents an onNext event.

Returns:

a boolean indicating whether this signal represents an onNext event

accept

public void accept(org.reactivestreams.Subscriber<? super T> observer)

Specified by:

accept in interface java.util.function.Consumer<org.reactivestreams.Subscriber<? super T>>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object