Top Description Fields Constructors Methods
reactor.core.publisher

pack-priv final Class ImmutableSignal<T>

extends Object
implements Signal<T>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, reactor.core.publisher.Signal, java.util.function.Consumer, java.util.function.Supplier
Imports
java.io.Serializable, java.util.Objects, org.reactivestreams.Subscription, reactor.util.annotation.Nullable, reactor.util.context.Context, .ContextView
The common implementation of a Signal (serializable and immutable). Use Signal factory methods to create an instance.

Associated Context are not serialized.

Authors
Stephane Maldini, Simon Baslé

Field Summary

Modifier and TypeField and Description
private final transient ContextView
contextView

private static final Signal<?>
ON_COMPLETE

private static final long
serialVersionUID

private final transient Subscription
subscription

private final Throwable
throwable

private final SignalType
type

private final T
value

Constructor Summary

AccessConstructor and Description
pack-priv
ImmutableSignal(ContextView contextView, SignalType type, T value, Throwable e, Subscription subscription)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public T
get()

Implements reactor.core.publisher.Signal.get.

Retrieves the item associated with this (onNext) signal.
public ContextView
getContextView()

Implements reactor.core.publisher.Signal.getContextView.

Return the readonly ContextView that is accessible by the time this Signal was emitted.
public Subscription
getSubscription()

Implements reactor.core.publisher.Signal.getSubscription.

Read the subscription associated with this (onSubscribe) signal.
public Throwable
getThrowable()

Implements reactor.core.publisher.Signal.getThrowable.

Read the error associated with this (onError) signal.
public SignalType
getType()

Implements reactor.core.publisher.Signal.getType.

Read the type of this signal: SignalType#ON_SUBSCRIBE, SignalType#ON_NEXT, SignalType#ON_ERROR, or SignalType#ON_COMPLETE
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
pack-priv static <U> Signal<U>

Returns:

a singleton signal to signify onComplete. As Signal is now associated with Context, prefer using per-subscription instances. This instance is used when context doesn't matter.
onComplete()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

contextViewback to summary
private final transient ContextView contextView
ON_COMPLETEback to summary
private static final Signal<?> ON_COMPLETE
serialVersionUIDback to summary
private static final long serialVersionUID
subscriptionback to summary
private final transient Subscription subscription
throwableback to summary
private final Throwable throwable
typeback to summary
private final SignalType type
valueback to summary
private final T value

Constructor Detail

ImmutableSignalback to summary
pack-priv ImmutableSignal(ContextView contextView, SignalType type, T value, Throwable e, Subscription subscription)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getback to summary
public T get()

Implements reactor.core.publisher.Signal.get.

Doc from reactor.core.publisher.Signal.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
getContextViewback to summary
public ContextView getContextView()

Implements reactor.core.publisher.Signal.getContextView.

Doc from reactor.core.publisher.Signal.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.

Annotations
@Override
getSubscriptionback to summary
public Subscription getSubscription()

Implements reactor.core.publisher.Signal.getSubscription.

Doc from reactor.core.publisher.Signal.getSubscription.

Read the subscription associated with this (onSubscribe) signal.

Returns:Subscription

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

Annotations
@Override
@Nullable
getThrowableback to summary
public Throwable getThrowable()

Implements reactor.core.publisher.Signal.getThrowable.

Doc from reactor.core.publisher.Signal.getThrowable.

Read the error associated with this (onError) signal.

Returns:Throwable

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

Annotations
@Override
@Nullable
getTypeback to summary
public SignalType getType()

Implements reactor.core.publisher.Signal.getType.

Doc from reactor.core.publisher.Signal.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

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
onCompleteback to summary
pack-priv static <U> Signal<U> onComplete()
Returns:Signal<U>

a singleton signal to signify onComplete. As Signal is now associated with Context, prefer using per-subscription instances. This instance is used when context doesn't matter.

Annotations
@SuppressWarnings:unchecked
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override