Reactor Core 3.6.0 · reactor.core.publisher.Signal

Method Summary

Modifier and Type	Method and Description
public default void	accept(Subscriber<? super T> the `Subscriber` to play the `Signal` on observer) Implements java.util.function.Consumer.accept. Propagate the signal represented by this `Signal` instance to a given `Subscriber`.
public static < the value type T> Signal<T>	Returns: an `OnCompleted` variety of `Signal` complete() Creates and returns a `Signal` of variety `Type.COMPLETE`.
public static < the value type T> Signal<T>	Returns: an `OnCompleted` variety of `Signal` complete(Context the `Context` associated with the completing source. context) Creates and returns a `Signal` of variety `Type.COMPLETE`, associated with a specific `Context`.
public static < the value type T> Signal<T>	Returns: an `OnError` variety of `Signal` error(Throwable the error associated to the signal e) Creates and returns a `Signal` of variety `Type.FAILED`, which holds the error.
public static < the value type T> Signal<T>	Returns: an `OnError` variety of `Signal` error(Throwable the error associated to the signal e, Context the `Context` associated with the erroring source context) Creates and returns a `Signal` of variety `Type.FAILED`, which holds the error and the `Context` associated with the erroring source.
public T	Returns: the item associated with this (onNext) signal, or null if not relevant get() Redeclares java.util.function.Supplier.get. Retrieves the item associated with this (onNext) signal.
public ContextView	Returns: a readonly `ContextView`, or an empty one if no context is available. getContextView() Return the readonly `ContextView` that is accessible by the time this `Signal` was emitted.
public Subscription	Returns: the Subscription associated with this (onSubscribe) signal, or null if not relevant getSubscription() Read the subscription associated with this (onSubscribe) signal.
public Throwable	Returns: the Throwable associated with this (onError) signal, or null if not relevant getThrowable() Read the error associated with this (onError) signal.
public SignalType	Returns: the type of the signal getType() Read the type of this signal: `SignalType#ON_SUBSCRIBE`, `SignalType#ON_NEXT`, `SignalType#ON_ERROR`, or `SignalType#ON_COMPLETE`
public default boolean	Returns: a boolean indicating whether this signal has an error hasError() Read whether this signal is on error and carries the cause.
public default boolean	Returns: a boolean indicating whether or not this signal has an item associated with it hasValue() Has this signal an item associated with it ?
public static boolean	Returns: true if object represents the completion signal isComplete(Object the object to check o) Check if an arbitrary Object represents a COMPLETE `Signal`.
public static boolean	Returns: true if object represents the error signal isError(Object the object to check o) Check if a arbitrary Object represents an ERROR `Signal`.
public default boolean	Returns: a boolean indicating whether this signal represents an `onComplete` event isOnComplete() Indicates whether this signal represents an `onComplete` event.
public default boolean	Returns: a boolean indicating whether this signal represents an `onError` event isOnError() Indicates whether this signal represents an `onError` event.
public default boolean	Returns: a boolean indicating whether this signal represents an `onNext` event isOnNext() Indicates whether this signal represents an `onNext` event.
public default boolean	Returns: a boolean indicating whether this signal represents an `onSubscribe` event isOnSubscribe() Indicates whether this signal represents an `onSubscribe` event.
public static < the value type T> Signal<T>	Returns: an `OnNext` variety of `Signal` next(T the value item associated to the signal t) Creates and returns a `Signal` of variety `Type.NEXT`, which holds the value.
public static < the value type T> Signal<T>	Returns: an `OnNext` variety of `Signal` next(T the value item associated to the signal t, Context the `Context` associated with the emitting source context) Creates and returns a `Signal` of variety `Type.NEXT`, which holds the value and the `Context` associated with the emitting source.
public static < the value type T> Signal<T>	Returns: an `OnSubscribe` variety of `Signal` subscribe(Subscription the subscription subscription) Creates and returns a `Signal` of variety `Type.ON_SUBSCRIBE`.
public static < the value type T> Signal<T>	Returns: an `OnSubscribe` variety of `Signal` subscribe(Subscription the subscription subscription, Context the `Context` associated with the subscribed source context) Creates and returns a `Signal` of variety `Type.ON_SUBSCRIBE`, that holds the `Context` associated with the subscribed source.

Inherited from java.util.function.Consumer:: andThen

Method Detail

accept back to summary

accept	back to summary
public default void accept(Subscriber<? super T> observer) Implements java.util.function.Consumer.accept. Propagate the signal represented by this `Signal` instance to a given `Subscriber`. Parameters observer:Subscriber<? super T> the `Subscriber` to play the `Signal` on Annotations @Override

public default void accept(Subscriber<? super T> observer)

Implements java.util.function.Consumer.accept.

Propagate the signal represented by this Signal instance to a given Subscriber.

Parameters

observer:Subscriber<? super T>: the Subscriber to play the Signal on

Annotations

@Override

complete back to summary

complete	back to summary
public static <T> Signal<T> complete() Creates and returns a `Signal` of variety `Type.COMPLETE`. Note that this variant associates an empty `Context` with the `Signal`. Parameters <T> the value type Returns:Signal<T> an `OnCompleted` variety of `Signal`

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

Creates and returns a Signal of variety Type.COMPLETE.

Note that this variant associates an empty Context with the Signal.

Parameters

<T>: the value type

Returns:Signal<T>

an OnCompleted variety of Signal

complete back to summary

complete	back to summary
public static <T> Signal<T> complete(Context context) Creates and returns a `Signal` of variety `Type.COMPLETE`, associated with a specific `Context`. Parameters <T> the value type context:Context the `Context` associated with the completing source. Returns:Signal<T> an `OnCompleted` variety of `Signal`

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

Creates and returns a Signal of variety Type.COMPLETE, associated with a specific Context.

Parameters

<T>: the value type
context:Context: the Context associated with the completing source.

Returns:Signal<T>

an OnCompleted variety of Signal

error back to summary

error	back to summary
public static <T> Signal<T> error(Throwable e) Creates and returns a `Signal` of variety `Type.FAILED`, which holds the error. Note that this variant associates an empty `Context` with the `Signal`. Parameters <T> the value type e:Throwable the error associated to the signal Returns:Signal<T> an `OnError` variety of `Signal`

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

Creates and returns a Signal of variety Type.FAILED, which holds the error.

Note that this variant associates an empty Context with the Signal.

Parameters

<T>: the value type
e:Throwable: the error associated to the signal

Returns:Signal<T>

an OnError variety of Signal

error back to summary

error	back to summary
public static <T> Signal<T> error(Throwable e, Context context) Creates and returns a `Signal` of variety `Type.FAILED`, which holds the error and the `Context` associated with the erroring source. Parameters <T> the value type e:Throwable the error associated to the signal context:Context the `Context` associated with the erroring source Returns:Signal<T> an `OnError` variety of `Signal`

public static <T> Signal<T> error(Throwable e, Context context)

Creates and returns a Signal of variety Type.FAILED, which holds the error and the Context associated with the erroring source.

Parameters

<T>: the value type
e:Throwable: the error associated to the signal
context:Context: the Context associated with the erroring source

Returns:Signal<T>

an OnError variety of Signal

get	back to summary
public T get() Redeclares java.util.function.Supplier.get. Retrieves the item associated with this (onNext) signal. Returns:T the item associated with this (onNext) signal, or null if not relevant Annotations @Override @Nullable

get

back to summary

public T get()

Redeclares java.util.function.Supplier.get.

Retrieves the item associated with this (onNext) signal.

Returns:T

the item associated with this (onNext) signal, or null if not relevant

Annotations

@Override
@Nullable

getContextView back to summary

getContextView	back to summary
public ContextView getContextView() Return the readonly `ContextView` that is accessible by the time this `Signal` was emitted. Returns:ContextView a readonly `ContextView`, or an empty one if no context is available.

public ContextView getContextView()

Return the readonly ContextView that is accessible by the time this Signal was emitted.

Returns:ContextView: a readonly ContextView, or an empty one if no context is available.

getSubscription	back to summary
public Subscription getSubscription() Read the subscription associated with this (onSubscribe) signal. Returns:Subscription the Subscription associated with this (onSubscribe) signal, or null if not relevant Annotations @Nullable

getSubscription

back to summary

public Subscription getSubscription()

Read the subscription associated with this (onSubscribe) signal.

Returns:Subscription

the Subscription associated with this (onSubscribe) signal, or null if not relevant

Annotations

@Nullable

getThrowable	back to summary
public Throwable getThrowable() Read the error associated with this (onError) signal. Returns:Throwable the Throwable associated with this (onError) signal, or null if not relevant Annotations @Nullable

getThrowable

back to summary

public Throwable getThrowable()

Read the error associated with this (onError) signal.

Returns:Throwable

the Throwable associated with this (onError) signal, or null if not relevant

Annotations

@Nullable

getType back to summary

getType	back to summary
public SignalType getType() Read the type of this signal: `SignalType#ON_SUBSCRIBE`, `SignalType#ON_NEXT`, `SignalType#ON_ERROR`, or `SignalType#ON_COMPLETE` Returns:SignalType the type of the signal

public SignalType getType()

Read the type of this signal: SignalType#ON_SUBSCRIBE, SignalType#ON_NEXT, SignalType#ON_ERROR, or SignalType#ON_COMPLETE

Returns:SignalType: the type of the signal

hasError	back to summary
public default boolean hasError() Read whether this signal is on error and carries the cause. Returns:boolean a boolean indicating whether this signal has an error

hasError

back to summary

public default boolean hasError()

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

Returns:boolean: a boolean indicating whether this signal has an error

hasValue	back to summary
public default boolean hasValue() Has this signal an item associated with it ? (which only happens if it is an (onNext) signal) Returns:boolean a boolean indicating whether or not this signal has an item associated with it

hasValue

back to summary

public default boolean hasValue()

Has this signal an item associated with it ? (which only happens if it is an (onNext) signal)

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

isComplete back to summary

isComplete	back to summary
public static boolean isComplete(Object o) Check if an arbitrary Object represents a COMPLETE `Signal`. Parameters o:Object the object to check Returns:boolean true if object represents the completion signal

public static boolean isComplete(Object o)

Check if an arbitrary Object represents a COMPLETE Signal.

Parameters

o:Object: the object to check

Returns:boolean

true if object represents the completion signal

isError back to summary

isError	back to summary
public static boolean isError(Object o) Check if a arbitrary Object represents an ERROR `Signal`. Parameters o:Object the object to check Returns:boolean true if object represents the error signal

public static boolean isError(Object o)

Check if a arbitrary Object represents an ERROR Signal.

Parameters

o:Object: the object to check

Returns:boolean

true if object represents the error signal

isOnComplete back to summary

isOnComplete	back to summary
public default boolean isOnComplete() Indicates whether this signal represents an `onComplete` event. Returns:boolean a boolean indicating whether this signal represents an `onComplete` event

public default boolean isOnComplete()

Indicates whether this signal represents an onComplete event.

Returns:boolean: a boolean indicating whether this signal represents an onComplete event

isOnError back to summary

isOnError	back to summary
public default boolean isOnError() Indicates whether this signal represents an `onError` event. Returns:boolean a boolean indicating whether this signal represents an `onError` event

public default boolean isOnError()

Indicates whether this signal represents an onError event.

Returns:boolean: a boolean indicating whether this signal represents an onError event

isOnNext back to summary

isOnNext	back to summary
public default boolean isOnNext() Indicates whether this signal represents an `onNext` event. Returns:boolean a boolean indicating whether this signal represents an `onNext` event

public default boolean isOnNext()

Indicates whether this signal represents an onNext event.

Returns:boolean: a boolean indicating whether this signal represents an onNext event

isOnSubscribe back to summary

isOnSubscribe	back to summary
public default boolean isOnSubscribe() Indicates whether this signal represents an `onSubscribe` event. Returns:boolean a boolean indicating whether this signal represents an `onSubscribe` event

public default boolean isOnSubscribe()

Indicates whether this signal represents an onSubscribe event.

Returns:boolean: a boolean indicating whether this signal represents an onSubscribe event

next back to summary

next	back to summary
public static <T> Signal<T> next(T t) Creates and returns a `Signal` of variety `Type.NEXT`, which holds the value. Note that this variant associates an empty `Context` with the `Signal`. Parameters <T> the value type t:T the value item associated to the signal Returns:Signal<T> an `OnNext` variety of `Signal`

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

Creates and returns a Signal of variety Type.NEXT, which holds the value.

Note that this variant associates an empty Context with the Signal.

Parameters

<T>: the value type
t:T: the value item associated to the signal

Returns:Signal<T>

an OnNext variety of Signal

next back to summary

next	back to summary
public static <T> Signal<T> next(T t, Context context) Creates and returns a `Signal` of variety `Type.NEXT`, which holds the value and the `Context` associated with the emitting source. Parameters <T> the value type t:T the value item associated to the signal context:Context the `Context` associated with the emitting source Returns:Signal<T> an `OnNext` variety of `Signal`

public static <T> Signal<T> next(T t, Context context)

Creates and returns a Signal of variety Type.NEXT, which holds the value and the Context associated with the emitting source.

Parameters

<T>: the value type
t:T: the value item associated to the signal
context:Context: the Context associated with the emitting source

Returns:Signal<T>

an OnNext variety of Signal

subscribe back to summary

subscribe	back to summary
public static <T> Signal<T> subscribe(Subscription subscription) Creates and returns a `Signal` of variety `Type.ON_SUBSCRIBE`. Note that this variant associates an empty `Context` with the `Signal`. Parameters <T> the value type subscription:Subscription the subscription Returns:Signal<T> an `OnSubscribe` variety of `Signal`

public static <T> Signal<T> subscribe(Subscription subscription)

Creates and returns a Signal of variety Type.ON_SUBSCRIBE.

Note that this variant associates an empty Context with the Signal.

Parameters

<T>: the value type
subscription:Subscription: the subscription

Returns:Signal<T>

an OnSubscribe variety of Signal

subscribe back to summary

subscribe	back to summary
public static <T> Signal<T> subscribe(Subscription subscription, Context context) Creates and returns a `Signal` of variety `Type.ON_SUBSCRIBE`, that holds the `Context` associated with the subscribed source. Parameters <T> the value type subscription:Subscription the subscription context:Context the `Context` associated with the subscribed source Returns:Signal<T> an `OnSubscribe` variety of `Signal`

public static <T> Signal<T> subscribe(Subscription subscription, Context context)

Creates and returns a Signal of variety Type.ON_SUBSCRIBE, that holds the Context associated with the subscribed source.

Parameters

<T>: the value type
subscription:Subscription: the subscription
context:Context: the Context associated with the subscribed source

Returns:Signal<T>

an OnSubscribe variety of Signal

public Interface Signal<T>

Method Summary

Method Detail