RxJava 2 2.2.21 · io.reactivex.Notification

Modifier and Type	Field and Description
pack-priv static final Notification<Object>	COMPLETE The singleton instance for createOnComplete.
pack-priv final Object	value

Access	Constructor and Description
private	Notification(Object value) Not meant to be implemented externally.

Method Summary

Modifier and Type	Method and Description
public static < the target value type T> Notification<T>	Returns: the shared Notification instance representing an onComplete signal createOnComplete() Returns the empty and stateless shared instance of a notification representing an onComplete signal.
public static < the value type T> Notification<T>	Returns: the new Notification instance createOnError(Throwable the error Throwable to carry around in the notification, not null error) Constructs an onError notification containing the error.
public static < the value type T> Notification<T>	Returns: the new Notification instance createOnNext(T the value to carry around in the notification, not null value) Constructs an onNext notification containing the given value.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Throwable	Returns: the Throwable error contained or null getError() Returns the container Throwable error if this notification is an onError signal, null otherwise.
public T	Returns: the value contained or null getValue() Returns the contained value if this notification is an onNext signal, null otherwise.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	Returns: true if this notification is an onComplete signal isOnComplete() Returns true if this notification is an onComplete signal.
public boolean	Returns: true if this notification is an onError signal isOnError() Returns true if this notification is an onError signal and `getError()` returns the contained Throwable.
public boolean	Returns: true if this notification is an onNext signal isOnNext() Returns true if this notification is an onNext signal and `getValue()` returns the contained value.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

COMPLETE	back to summary
pack-priv static final Notification<Object> COMPLETE The singleton instance for createOnComplete.

value	back to summary
pack-priv final Object value

Notification	back to summary
private Notification(Object value) Not meant to be implemented externally.

Method Detail

createOnComplete	back to summary
public static <T> Notification<T> createOnComplete() Returns the empty and stateless shared instance of a notification representing an onComplete signal. Parameters <T> the target value type Returns:Notification<T> the shared Notification instance representing an onComplete signal Annotations @SuppressWarnings:unchecked @NonNull

createOnComplete

back to summary

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

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

Parameters

<T>: the target value type

Returns:Notification<T>

the shared Notification instance representing an onComplete signal

Annotations

@SuppressWarnings:unchecked
@NonNull

createOnError	back to summary
public static <T> Notification<T> createOnError(Throwable error) Constructs an onError notification containing the error. Parameters <T> the value type error:Throwable the error Throwable to carry around in the notification, not null Returns:Notification<T> the new Notification instance Annotations @NonNull Exceptions NullPointerException: if error is null

createOnError

back to summary

public static <T> Notification<T> createOnError(Throwable error)

Constructs an onError notification containing the error.

Parameters

<T>: the value type
error:Throwable: the error Throwable to carry around in the notification, not null

Returns:Notification<T>

the new Notification instance

Annotations

@NonNull

Exceptions

NullPointerException:: if error is null

createOnNext	back to summary
public static <T> Notification<T> createOnNext(T value) Constructs an onNext notification containing the given value. Parameters <T> the value type value:T the value to carry around in the notification, not null Returns:Notification<T> the new Notification instance Annotations @NonNull Exceptions NullPointerException: if value is null

createOnNext

back to summary

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

Constructs an onNext notification containing the given value.

Parameters

<T>: the value type
value:T: the value to carry around in the notification, not null

Returns:Notification<T>

the new Notification instance

Annotations

@NonNull

Exceptions

NullPointerException:: if value is null

equals back to summary

equals	back to summary
public boolean equals(Object obj) 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 obj: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

public boolean equals(Object obj)

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

obj: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

getError back to summary

getError	back to summary
public Throwable getError() Returns the container Throwable error if this notification is an onError signal, null otherwise. Returns:Throwable the Throwable error contained or null Annotations @Nullable See Also `isOnError()`

public Throwable getError()

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

Returns:Throwable

the Throwable error contained or null

Annotations

@Nullable

See Also

isOnError()

getValue back to summary

getValue	back to summary
public T getValue() Returns the contained value if this notification is an onNext signal, null otherwise. Returns:T the value contained or null Annotations @SuppressWarnings:unchecked @Nullable See Also `isOnNext()`

public T getValue()

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

Returns:T

the value contained or null

Annotations

@SuppressWarnings:unchecked
@Nullable

See Also

isOnNext()

hashCode back to summary

hashCode	back 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

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

isOnComplete	back to summary
public boolean isOnComplete() Returns true if this notification is an onComplete signal. Returns:boolean true if this notification is an onComplete signal

isOnComplete

back to summary

public boolean isOnComplete()

Returns true if this notification is an onComplete signal.

Returns:boolean: true if this notification is an onComplete signal

isOnError back to summary

isOnError	back to summary
public boolean isOnError() Returns true if this notification is an onError signal and `getError()` returns the contained Throwable. Returns:boolean true if this notification is an onError signal See Also `getError()`

public boolean isOnError()

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

Returns:boolean: true if this notification is an onError signal
See Also: getError()

isOnNext back to summary

isOnNext	back to summary
public boolean isOnNext() Returns true if this notification is an onNext signal and `getValue()` returns the contained value. Returns:boolean true if this notification is an onNext signal See Also `getValue()`

public boolean isOnNext()

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

Returns:boolean: true if this notification is an onNext signal
See Also: getValue()

toString	back 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

toString

back 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

public final Class Notification<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail