reactor.rx.action

Class Signal<T>

java.lang.Object

reactor.rx.action.Signal<T>

All Implemented Interfaces:

Serializable, Consumer<org.reactivestreams.Subscriber<? super T>>, Supplier<T>

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

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

Since:

2.0

Author:

Stephane Maldini

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Signal.Type

Method Summary

Modifier and Type	Method and Description
void	accept(org.reactivestreams.Subscriber<? super T> observer) Execute the logic of the action, accepting the given parameter.
static <T> Signal<T>	complete() Creates and returns a Signal of variety Type.COMPLETE.
boolean	equals(Object o)
static <T> Signal<T>	error(Throwable e) Creates and returns a Signal of variety Type.ERROR, and assigns it an exception.
T	get() Retrieves the item associated with this (onNext) signal.
org.reactivestreams.Subscription	getSubscription() Read the subscription associated with this (onSubscribe) signal.
Throwable	getThrowable() Read the exception associated with this (onError) signal.
Signal.Type	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 ?
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.COMPLETE.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

next

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

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

Parameters:

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

Returns:

an OnNext variety of Signal

error

public static <T> Signal<T> error(Throwable e)

Creates and returns a Signal of variety Type.ERROR, and assigns it an exception.

Parameters:

e - the exception to assign to the signal

Returns:

an OnError variety of Signal

complete

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

Creates and returns a Signal of variety Type.COMPLETE.

Returns:

an OnCompleted variety of Signal

subscribe

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

Creates and returns a Signal of variety Type.COMPLETE.

Parameters:

subscription - the subscription

Returns:

an OnCompleted variety of Signal

getThrowable

public Throwable getThrowable()

Read the exception 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 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 Signal.Type 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)

Description copied from interface: Consumer

Execute the logic of the action, accepting the given parameter.

Specified by:

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

Parameters:

observer - The parameter to pass to the consumer.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object