-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Expand file tree
/
Copy pathNotification.java
More file actions
223 lines (198 loc) · 7.14 KB
/
Notification.java
File metadata and controls
223 lines (198 loc) · 7.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/**
* Copyright 2014 Netflix, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package rx;
/**
* An object representing a notification sent to an {@link Observable}.
* @param <T> the actual value type held by the Notification
*/
public final class Notification<T> {
private final Kind kind;
private final Throwable throwable;
private final T value;
private static final Notification<Void> ON_COMPLETED = new Notification<Void>(Kind.OnCompleted, null, null);
/**
* Creates and returns a {@code Notification} of variety {@code Kind.OnNext}, and assigns it a value.
*
* @param <T> the actual value type held by the Notification
* @param t
* the item to assign to the notification as its value
* @return an {@code OnNext} variety of {@code Notification}
*/
public static <T> Notification<T> createOnNext(T t) {
return new Notification<T>(Kind.OnNext, t, null);
}
/**
* Creates and returns a {@code Notification} of variety {@code Kind.OnError}, and assigns it an exception.
*
* @param <T> the actual value type held by the Notification
* @param e
* the exception to assign to the notification
* @return an {@code OnError} variety of {@code Notification}
*/
public static <T> Notification<T> createOnError(Throwable e) {
return new Notification<T>(Kind.OnError, null, e);
}
/**
* Creates and returns a {@code Notification} of variety {@code Kind.OnCompleted}.
*
* @param <T> the actual value type held by the Notification
* @return an {@code OnCompleted} variety of {@code Notification}
*/
@SuppressWarnings("unchecked")
public static <T> Notification<T> createOnCompleted() {
return (Notification<T>) ON_COMPLETED;
}
/**
* Creates and returns a {@code Notification} of variety {@code Kind.OnCompleted}.
*
* @param <T> the actual value type held by the Notification
* @param type the type token to help with type inference of {@code <T>}
* @deprecated this method does the same as {@link #createOnCompleted()} and does not use the passed in type hence it's useless.
* @return an {@code OnCompleted} variety of {@code Notification}
*/
@Deprecated
@SuppressWarnings("unchecked")
public static <T> Notification<T> createOnCompleted(Class<T> type) {
return (Notification<T>) ON_COMPLETED;
}
private Notification(Kind kind, T value, Throwable e) {
this.value = value;
this.throwable = e;
this.kind = kind;
}
/**
* Retrieves the exception associated with this (onError) notification.
*
* @return the Throwable associated with this (onError) notification
*/
public Throwable getThrowable() {
return throwable;
}
/**
* Retrieves the item associated with this (onNext) notification.
*
* @return the item associated with this (onNext) notification
*/
public T getValue() {
return value;
}
/**
* Indicates whether this notification has an item associated with it.
*
* @return a boolean indicating whether or not this notification has an item associated with it
*/
public boolean hasValue() {
return isOnNext() && value != null;
// isn't "null" a valid item?
}
/**
* Indicates whether this notification has an exception associated with it.
*
* @return a boolean indicating whether this notification has an exception associated with it
*/
public boolean hasThrowable() {
return isOnError() && throwable != null;
}
/**
* Retrieves the kind of this notification: {@code OnNext}, {@code OnError}, or {@code OnCompleted}
*
* @return the kind of the notification: {@code OnNext}, {@code OnError}, or {@code OnCompleted}
*/
public Kind getKind() {
return kind;
}
/**
* Indicates whether this notification represents an {@code onError} event.
*
* @return a boolean indicating whether this notification represents an {@code onError} event
*/
public boolean isOnError() {
return getKind() == Kind.OnError;
}
/**
* Indicates whether this notification represents an {@code onCompleted} event.
*
* @return a boolean indicating whether this notification represents an {@code onCompleted} event
*/
public boolean isOnCompleted() {
return getKind() == Kind.OnCompleted;
}
/**
* Indicates whether this notification represents an {@code onNext} event.
*
* @return a boolean indicating whether this notification represents an {@code onNext} event
*/
public boolean isOnNext() {
return getKind() == Kind.OnNext;
}
/**
* Forwards this notification on to a specified {@link Observer}.
* @param observer the target observer to call onXXX methods on based on the kind of this Notification instance
*/
public void accept(Observer<? super T> observer) {
if (kind == Kind.OnNext) {
observer.onNext(getValue());
} else if (kind == Kind.OnCompleted) {
observer.onCompleted();
} else {
observer.onError(getThrowable());
}
}
/**
* Specifies the kind of the notification: an element, an error or a completion notification.
*/
public enum Kind {
OnNext, OnError, OnCompleted
}
@Override
public String toString() {
StringBuilder str = new StringBuilder(64).append('[').append(super.toString())
.append(' ').append(getKind());
if (hasValue()) {
str.append(' ').append(getValue());
}
if (hasThrowable()) {
str.append(' ').append(getThrowable().getMessage());
}
str.append(']');
return str.toString();
}
@Override
public int hashCode() {
int hash = getKind().hashCode();
if (hasValue()) {
hash = hash * 31 + getValue().hashCode();
}
if (hasThrowable()) {
hash = hash * 31 + getThrowable().hashCode();
}
return hash;
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (this == obj) {
return true;
}
if (obj.getClass() != getClass()) {
return false;
}
Notification<?> notification = (Notification<?>) obj;
return notification.getKind() == getKind() && (value == notification.value || (value != null && value.equals(notification.value))) && (throwable == notification.throwable || (throwable != null && throwable.equals(notification.throwable)));
}
}