Top Description Inners Fields Constructors Methods
rx

public final Class Notification<T>

extends Object
Class Inheritance
Type Parameters
<T>
the actual value type held by the Notification
An object representing a notification sent to an Observable.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Notification.Kind

Specifies the kind of the notification: an element, an error or a completion notification.

Field Summary

Modifier and TypeField and Description
private final Notification.Kind
kind

private static final Notification<Void>
ON_COMPLETED

private final Throwable
throwable

private final T
value

Constructor Summary

AccessConstructor and Description
private
Notification(Notification.Kind kind, T value, Throwable e)

Method Summary

Modifier and TypeMethod and Description
public void
accept(Observer<? super T>
the target observer to call onXXX methods on based on the kind of this Notification instance
observer)

Forwards this notification on to a specified Observer.

public static <
the actual value type held by the Notification
T> Notification<T>

Returns:

an OnCompleted variety of Notification
createOnCompleted()

Creates and returns a Notification of variety Kind.OnCompleted.

public static <
the actual value type held by the Notification
T> Notification<T>

Returns:

an OnCompleted variety of Notification
createOnCompleted(Class<T>
the type token to help with type inference of <T>
type)

Deprecated this method does the same as createOnCompleted() and does not use the passed in type hence it's useless.
Creates and returns a Notification of variety Kind.OnCompleted.
public static <
the actual value type held by the Notification
T> Notification<T>

Returns:

an OnError variety of Notification
createOnError(Throwable
the exception to assign to the notification
e)

Creates and returns a Notification of variety Kind.OnError, and assigns it an exception.

public static <
the actual value type held by the Notification
T> Notification<T>

Returns:

an OnNext variety of Notification
createOnNext(T
the item to assign to the notification as its value
t)

Creates and returns a Notification of variety Kind.OnNext, and assigns it a 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 Notification.Kind

Returns:

the kind of the notification: OnNext, OnError, or OnCompleted
getKind()

Retrieves the kind of this notification: OnNext, OnError, or OnCompleted

public Throwable

Returns:

the Throwable associated with this (onError) notification
getThrowable()

Retrieves the exception associated with this (onError) notification.

public T

Returns:

the item associated with this (onNext) notification
getValue()

Retrieves the item associated with this (onNext) notification.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean

Returns:

a boolean indicating whether this notification has an exception associated with it
hasThrowable()

Indicates whether this notification has an exception associated with it.

public boolean

Returns:

a boolean indicating whether or not this notification has an item associated with it
hasValue()

Indicates whether this notification has an item associated with it.

public boolean

Returns:

a boolean indicating whether this notification represents an onCompleted event
isOnCompleted()

Indicates whether this notification represents an onCompleted event.

public boolean

Returns:

a boolean indicating whether this notification represents an onError event
isOnError()

Indicates whether this notification represents an onError event.

public boolean

Returns:

a boolean indicating whether this notification represents an onNext event
isOnNext()

Indicates whether this notification represents an onNext event.

public String
toString()

Overrides java.lang.Object.toString.

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

Field Detail

kindback to summary
private final Notification.Kind kind
ON_COMPLETEDback to summary
private static final Notification<Void> ON_COMPLETED
throwableback to summary
private final Throwable throwable
valueback to summary
private final T value

Constructor Detail

Notificationback to summary
private Notification(Notification.Kind kind, T value, Throwable e)

Method Detail

acceptback to summary
public void accept(Observer<? super T> observer)

Forwards this notification on to a specified Observer.

Parameters
observer:Observer<? super T>

the target observer to call onXXX methods on based on the kind of this Notification instance

createOnCompletedback to summary
public static <T> Notification<T> createOnCompleted()

Creates and returns a Notification of variety Kind.OnCompleted.

Parameters
<T>
the actual value type held by the Notification
Returns:Notification<T>

an OnCompleted variety of Notification

Annotations
@SuppressWarnings:unchecked
createOnCompletedback to summary
public static <T> Notification<T> createOnCompleted(Class<T> type)

Deprecated

this method does the same as createOnCompleted() and does not use the passed in type hence it's useless.

Creates and returns a Notification of variety Kind.OnCompleted.

Parameters
<T>
the actual value type held by the Notification
type:Class<T>

the type token to help with type inference of <T>

Returns:Notification<T>

an OnCompleted variety of Notification

Annotations
@Deprecated
@SuppressWarnings:unchecked
createOnErrorback to summary
public static <T> Notification<T> createOnError(Throwable e)

Creates and returns a Notification of variety Kind.OnError, and assigns it an exception.

Parameters
<T>
the actual value type held by the Notification
e:Throwable

the exception to assign to the notification

Returns:Notification<T>

an OnError variety of Notification

createOnNextback to summary
public static <T> Notification<T> createOnNext(T t)

Creates and returns a Notification of variety Kind.OnNext, and assigns it a value.

Parameters
<T>
the actual value type held by the Notification
t:T

the item to assign to the notification as its value

Returns:Notification<T>

an OnNext variety of Notification

equalsback 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
getKindback to summary
public Notification.Kind getKind()

Retrieves the kind of this notification: OnNext, OnError, or OnCompleted

Returns:Notification.Kind

the kind of the notification: OnNext, OnError, or OnCompleted

getThrowableback to summary
public Throwable getThrowable()

Retrieves the exception associated with this (onError) notification.

Returns:Throwable

the Throwable associated with this (onError) notification

getValueback to summary
public T getValue()

Retrieves the item associated with this (onNext) notification.

Returns:T

the item associated with this (onNext) notification

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
hasThrowableback to summary
public boolean hasThrowable()

Indicates whether this notification has an exception associated with it.

Returns:boolean

a boolean indicating whether this notification has an exception associated with it

hasValueback to summary
public boolean hasValue()

Indicates whether this notification has an item associated with it.

Returns:boolean

a boolean indicating whether or not this notification has an item associated with it

isOnCompletedback to summary
public boolean isOnCompleted()

Indicates whether this notification represents an onCompleted event.

Returns:boolean

a boolean indicating whether this notification represents an onCompleted event

isOnErrorback to summary
public boolean isOnError()

Indicates whether this notification represents an onError event.

Returns:boolean

a boolean indicating whether this notification represents an onError event

isOnNextback to summary
public boolean isOnNext()

Indicates whether this notification represents an onNext event.

Returns:boolean

a boolean indicating whether this notification represents an onNext event

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
rx back to summary

public final Enum Notification.Kind

extends Enum<Notification.Kind>
Class Inheritance
Specifies the kind of the notification: an element, an error or a completion notification.

Field Summary

Modifier and TypeField and Description
public static final Notification.Kind
OnCompleted

public static final Notification.Kind
OnError

public static final Notification.Kind
OnNext

Constructor Summary

AccessConstructor and Description
private
Kind()

Method Summary

Modifier and TypeMethod and Description
public static Notification.Kind
valueOf(String name)

public static Notification.Kind[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

OnCompletedback to summary
public static final Notification.Kind OnCompleted
OnErrorback to summary
public static final Notification.Kind OnError
OnNextback to summary
public static final Notification.Kind OnNext

Constructor Detail

Kindback to summary
private Kind()

Method Detail

valueOfback to summary
public static Notification.Kind valueOf(String name)
valuesback to summary
public static Notification.Kind[] values()