Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TestSubscriber javadoc cleanup #3043

Merged
merged 1 commit into from
Jun 23, 2015
Merged

TestSubscriber javadoc cleanup #3043

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions src/main/java/rx/observers/TestSubscriber.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ public void onCompleted() {
}

/**
* Get the {@link Notification}s representing each time this {@link Subscriber} was notified of sequence
* Returns the {@link Notification}s representing each time this {@link Subscriber} was notified of sequence
* completion via {@link #onCompleted}, as a {@link List}.
*
* @return a list of Notifications representing calls to this Subscriber's {@link #onCompleted} method
Expand Down Expand Up @@ -172,7 +172,7 @@ public void onError(Throwable e) {
}

/**
* Get the {@link Throwable}s this {@link Subscriber} was notified of via {@link #onError} as a
* Returns the {@link Throwable}s this {@link Subscriber} was notified of via {@link #onError} as a
* {@link List}.
*
* @return a list of the Throwables that were passed to this Subscriber's {@link #onError} method
Expand All @@ -199,7 +199,7 @@ public void onNext(T t) {
}

/**
* Allow calling the protected {@link #request(long)} from unit tests.
* Allows calling the protected {@link #request(long)} from unit tests.
*
* @param n the maximum number of items you want the Observable to emit to the Subscriber at this time, or
* {@code Long.MAX_VALUE} if you want the Observable to emit items at its own pace
Expand All @@ -209,7 +209,7 @@ public void requestMore(long n) {
}

/**
* Get the sequence of items observed by this {@link Subscriber}, as an ordered {@link List}.
* Returns the sequence of items observed by this {@link Subscriber}, as an ordered {@link List}.
*
* @return a list of items observed by this Subscriber, in the order in which they were observed
*/
Expand All @@ -218,7 +218,7 @@ public List<T> getOnNextEvents() {
}

/**
* Assert that a particular sequence of items was received by this {@link Subscriber} in order.
* Asserts that a particular sequence of items was received by this {@link Subscriber} in order.
*
* @param items
* the sequence of items expected to have been observed
Expand All @@ -230,7 +230,7 @@ public void assertReceivedOnNext(List<T> items) {
}

/**
* Assert that a single terminal event occurred, either {@link #onCompleted} or {@link #onError}.
* Asserts that a single terminal event occurred, either {@link #onCompleted} or {@link #onError}.
*
* @throws AssertionError
* if not exactly one terminal event notification was received
Expand All @@ -240,7 +240,7 @@ public void assertTerminalEvent() {
}

/**
* Assert that this {@code Subscriber} is unsubscribed.
* Asserts that this {@code Subscriber} is unsubscribed.
*
* @throws AssertionError
* if this {@code Subscriber} is not unsubscribed
Expand All @@ -252,7 +252,7 @@ public void assertUnsubscribed() {
}

/**
* Assert that this {@code Subscriber} has received no {@code onError} notifications.
* Asserts that this {@code Subscriber} has received no {@code onError} notifications.
*
* @throws AssertionError
* if this {@code Subscriber} has received one or more {@code onError} notifications
Expand Down Expand Up @@ -335,7 +335,7 @@ public Thread getLastSeenThread() {
}

/**
* Assert if there is exactly a single completion event.
* Asserts that there is exactly one completion event.
*
* @throws AssertionError if there were zero, or more than one, onCompleted events
* @since (if this graduates from "Experimental" replace this parenthetical with the release number)
Expand All @@ -352,7 +352,7 @@ public void assertCompleted() {
}

/**
* Assert if there is no completion event.
* Asserts that there is no completion event.
*
* @throws AssertionError if there were one or more than one onCompleted events
* @since (if this graduates from "Experimental" replace this parenthetical with the release number)
Expand All @@ -369,7 +369,7 @@ public void assertNotCompleted() {
}

/**
* Assert if there is exactly one error event which is a subclass of the given class.
* Asserts that there is exactly one error event which is a subclass of the given class.
*
* @param clazz the class to check the error against.
* @throws AssertionError if there were zero, or more than one, onError events, or if the single onError
Expand All @@ -395,7 +395,7 @@ public void assertError(Class<? extends Throwable> clazz) {
}

/**
* Assert there is a single onError event with the exact exception.
* Asserts that there is a single onError event with the exact exception.
*
* @param throwable the throwable to check
* @throws AssertionError if there were zero, or more than one, onError events, or if the single onError
Expand All @@ -421,7 +421,7 @@ public void assertError(Throwable throwable) {
}

/**
* Assert for no onError and onCompleted events.
* Asserts that there are no onError and onCompleted events.
*
* @throws AssertionError if there was either an onError or onCompleted event
* @since (if this graduates from "Experimental" replace this parenthetical with the release number)
Expand All @@ -447,7 +447,7 @@ public void assertNoTerminalEvent() {
}

/**
* Assert if there are no onNext events received.
* Asserts that there are no onNext events received.
*
* @throws AssertionError if there were any onNext events
* @since (if this graduates from "Experimental" replace this parenthetical with the release number)
Expand All @@ -461,7 +461,7 @@ public void assertNoValues() {
}

/**
* Assert if the given number of onNext events are received.
* Asserts that the given number of onNext events are received.
*
* @param count the expected number of onNext events
* @throws AssertionError if there were more or fewer onNext events than specified by {@code count}
Expand All @@ -476,7 +476,7 @@ public void assertValueCount(int count) {
}

/**
* Assert if the received onNext events, in order, are the specified items.
* Asserts that the received onNext events, in order, are the specified items.
*
* @param values the items to check
* @throws AssertionError if the items emitted do not exactly match those specified by {@code values}
Expand All @@ -488,7 +488,7 @@ public void assertValues(T... values) {
}

/**
* Assert if there is only a single received onNext event and that it marks the emission of a specific item.
* Asserts that there is only a single received onNext event and that it marks the emission of a specific item.
*
* @param value the item to check
* @throws AssertionError if the Observable does not emit only the single item specified by {@code value}
Expand Down