Signal (Reactor Core 3.1.0.M3)

java.lang.Object
- reactor.core.publisher.Signal<T>

Type Parameters:

T - the value type

All Implemented Interfaces:

Consumer<Subscriber<? super T>>, Supplier<T>

Direct Known Subclasses:

MutableNextSignal
```
public abstract class Signal<T>
extends Object
implements Supplier<T>, Consumer<Subscriber<? super T>>
```
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)?)

Author:

Stephane Maldini

Constructor Summary

Constructors
Constructor and Description

Signal()

Constructors
Constructor and Description
`Signal()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(Subscriber<? super T> observer)` Propagate the signal represented by this `Signal` instance to a given `Subscriber`.
`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.FAILED`, which holds the error.
`abstract T`	`get()` Retrieves the item associated with this (onNext) signal.
`abstract Subscription`	`getSubscription()` Read the subscription associated with this (onSubscribe) signal.
`abstract Throwable`	`getThrowable()` Read the error associated with this (onError) signal.
`abstract SignalType`	`getType()` Read the type of this signal: `SignalType.ON_SUBSCRIBE`, `SignalType.ON_NEXT`, `SignalType.ON_ERROR`, or `SignalType.ON_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 ? (which only happens if it is an (onNext) signal)
`static boolean`	`isComplete(Object o)` Check if an arbitrary Object represents a COMPLETE `Signal`.
`static boolean`	`isError(Object o)` Check if a arbitrary Object represents an ERROR `Signal`.
`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`, which holds the value.
`static <T> Signal<T>`	`subscribe(Subscription subscription)` Creates and returns a `Signal` of variety `Type.ON_SUBSCRIBE`.
`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

- Constructor Detail
  - Signal
```
public Signal()
```
- 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(Throwable e)
```
    Creates and returns a Signal of variety Type.FAILED, which holds the error.
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    e - the error associated 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, which holds the value.
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    t - the value item associated to the signal
    
    Returns:
    
    an OnNext variety of Signal
  - isComplete
```
public static boolean isComplete(Object o)
```
    Check if an arbitrary Object represents a COMPLETE Signal.
    
    Parameters:
    
    o - the object to check
    
    Returns:
    
    true if object represents the completion signal
  - isError
```
public static boolean isError(Object o)
```
    Check if a arbitrary Object represents an ERROR Signal.
    
    Parameters:
    
    o - the object to check
    
    Returns:
    
    true if object represents the error signal
  - subscribe
```
public static <T> Signal<T> subscribe(Subscription subscription)
```
    Creates and returns a Signal of variety Type.ON_SUBSCRIBE.
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    subscription - the subscription
    
    Returns:
    
    an OnSubscribe variety of Signal
  - getThrowable
```
@Nullable
public abstract Throwable getThrowable()
```
    Read the error associated with this (onError) signal.
    
    Returns:
    
    the Throwable associated with this (onError) signal, or null if not relevant
  - getSubscription
```
@Nullable
public abstract Subscription getSubscription()
```
    Read the subscription associated with this (onSubscribe) signal.
    
    Returns:
    
    the Subscription associated with this (onSubscribe) signal, or null if not relevant
  - get
```
@Nullable
public abstract 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, or null if not relevant
  - hasValue
```
public boolean hasValue()
```
    Has this signal an item associated with it ? (which only happens if it is an (onNext) signal)
    
    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 abstract SignalType getType()
```
    Read the type of this signal: SignalType.ON_SUBSCRIBE, SignalType.ON_NEXT, SignalType.ON_ERROR, or SignalType.ON_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(Subscriber<? super T> observer)
```
    Propagate the signal represented by this Signal instance to a given Subscriber.
    
    Specified by:
    
    accept in interface Consumer<Subscriber<? super T>>
    
    Parameters:
    
    observer - the Subscriber to play the Signal on
  - equals
```
public final boolean equals(@Nullable
                            Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Signal<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.Consumer

Constructor Detail

Signal

Method Detail

complete

error

next

isComplete

isError

subscribe

getThrowable

getSubscription

get

hasValue

hasError

getType

isOnError

isOnComplete

isOnSubscribe

isOnNext

accept

equals

hashCode

toString