io.reactivex.common

Class Notification<T>

java.lang.Object

io.reactivex.common.Notification<T>

Type Parameters:

T - the value type

public final class Notification<T>
extends java.lang.Object

Represents the reactive signal types: onNext, onError and onComplete and holds their parameter values (a value, a Throwable, nothing).

Method Summary

Modifier and Type	Method and Description
static <T> Notification<T>	createOnComplete() Returns the empty and stateless shared instance of a notification representing an onComplete signal.
static <T> Notification<T>	createOnError(java.lang.Throwable error) Constructs an onError notification containing the error.
static <T> Notification<T>	createOnNext(T value) Constructs an onNext notification containing the given value.
boolean	equals(java.lang.Object obj)
java.lang.Throwable	getError() Returns the container Throwable error if this notification is an onError signal, null otherwise.
T	getValue() Returns the contained value if this notification is an onNext signal, null otherwise.
int	hashCode()
boolean	isOnComplete() Returns true if this notification is an onComplete signal.
boolean	isOnError() Returns true if this notification is an onError signal and getError() returns the contained Throwable.
boolean	isOnNext() Returns true if this notification is an onNext signal and getValue() returns the contained value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

isOnComplete

public boolean isOnComplete()

Returns true if this notification is an onComplete signal.

Returns:

true if this notification is an onComplete signal

isOnError

public boolean isOnError()

Returns true if this notification is an onError signal and getError() returns the contained Throwable.

Returns:

true if this notification is an onError signal

See Also:

getError()

isOnNext

public boolean isOnNext()

Returns true if this notification is an onNext signal and getValue() returns the contained value.

Returns:

true if this notification is an onNext signal

See Also:

getValue()

getValue

@Nullable
public T getValue()

Returns the contained value if this notification is an onNext signal, null otherwise.

Returns:

the value contained or null

See Also:

isOnNext()

getError

@Nullable
public java.lang.Throwable getError()

Returns the container Throwable error if this notification is an onError signal, null otherwise.

Returns:

the Throwable error contained or null

See Also:

isOnError()

equals

public boolean equals(java.lang.Object obj)

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

createOnNext

@NonNull
public static <T> Notification<T> createOnNext(@NonNull
                                                         T value)

Constructs an onNext notification containing the given value.

Type Parameters:

T - the value type

Parameters:

value - the value to carry around in the notification, not null

Returns:

the new Notification instance

Throws:

java.lang.NullPointerException - if value is null

createOnError

@NonNull
public static <T> Notification<T> createOnError(@NonNull
                                                          java.lang.Throwable error)

Constructs an onError notification containing the error.

Type Parameters:

T - the value type

Parameters:

error - the error Throwable to carry around in the notification, not null

Returns:

the new Notification instance

Throws:

java.lang.NullPointerException - if error is null

createOnComplete

@NonNull
public static <T> Notification<T> createOnComplete()

Returns the empty and stateless shared instance of a notification representing an onComplete signal.

Type Parameters:

T - the target value type

Returns:

the shared Notification instance representing an onComplete signal