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

2x: Fix wording in Async and Publish processors javadoc. #5444

Merged
merged 1 commit into from
Jun 26, 2017
Merged

2x: Fix wording in Async and Publish processors javadoc. #5444

Show file tree
Hide file tree
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
3 changes: 2 additions & 1 deletion src/main/java/io/reactivex/processors/AsyncProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
import org.reactivestreams.*;

/**
* A Subject that emits the very last value followed by a completion event or the received error to Subscribers.
* Processor that emits the very last value followed by a completion event or the received error
* to {@link Subscriber}s.
*
* <p>The implementation of onXXX methods are technically thread-safe but non-serialized calls
* to them may lead to undefined state in the currently subscribed Subscribers.
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/io/reactivex/processors/PublishProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@
import io.reactivex.plugins.RxJavaPlugins;

/**
* A Subject that multicasts events to Subscribers that are currently subscribed to it.
* Processor that multicasts all subsequently observed items to its current {@link Subscriber}s.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"A Processor" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Replay and Behaviour processors it's "Processor" _(ツ)_/¯. Both seam syntactically correct.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then the AsyncProcessor could be adjusted as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

*
* <p>
* <img width="640" height="405" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/S.PublishSubject.png" alt="">
*
* <p>The subject does not coordinate backpressure for its subscribers and implements a weaker onSubscribe which
* calls requests Long.MAX_VALUE from the incoming Subscriptions. This makes it possible to subscribe the PublishSubject
* to multiple sources (note on serialization though) unlike the standard contract on Subscriber. Child subscribers, however, are not overflown but receive an
* <p>The processor does not coordinate backpressure for its subscribers and implements a weaker onSubscribe which
* calls requests Long.MAX_VALUE from the incoming Subscriptions. This makes it possible to subscribe the PublishProcessor
* to multiple sources (note on serialization though) unlike the standard Subscriber contract. Child subscribers, however, are not overflown but receive an
* IllegalStateException in case their requested amount is zero.
*
* <p>The implementation of onXXX methods are technically thread-safe but non-serialized calls
Expand All @@ -54,7 +54,7 @@
processor.onComplete();

} </pre>
* @param <T> the value type multicast to Subscribers.
* @param <T> the value type multicasted to Subscribers.
*/
public final class PublishProcessor<T> extends FlowableProcessor<T> {
/** The terminated indicator for the subscribers array. */
Expand Down