Skip to content

Enhance java doc #97

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.

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

Merged
merged 1 commit into from
Oct 28, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CopyrightWaivers.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,5 @@ viktorklang | Viktor Klang, [email protected], Typesafe Inc.
smaldini | Stephane Maldini, [email protected], Pivotal Software Inc.
savulchik | Stanislav Savulchik, [email protected]
ktoso | Konrad Malawski, [email protected], Typesafe Inc.
ouertani | Slim Ouertani, [email protected]

3 changes: 3 additions & 0 deletions api/src/main/java/org/reactivestreams/Processor.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
/**
* A Processor represents a processing stage—which is both a {@link Subscriber}
* and a {@link Publisher} and obeys the contracts of both.
*
* @param <T> the type of element signaled to the {@link Subscriber}
* @param <R> the type of element signaled by the {@link Publisher}
*/
public interface Processor<T, R> extends Subscriber<T>, Publisher<R> {
}
13 changes: 11 additions & 2 deletions api/src/main/java/org/reactivestreams/Publisher.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
package org.reactivestreams;

/**
* A {@link Publisher} is a provider of a potentially unbounded number of sequenced elements, publishing them according to
* the demand received from its {@link Subscriber}(s).
* <p>
* A {@link Publisher} can serve multiple {@link Subscriber}s subscribed {@link #subscribe(Subscriber)}dynamically
* at various points in time.
*
* @param <T> the type of element signaled.
*/
public interface Publisher<T> {

/**
Expand All @@ -11,9 +20,9 @@ public interface Publisher<T> {
* <p>
* A {@link Subscriber} should only subscribe once to a single {@link Publisher}.
* <p>
* If the {@link Publisher} rejects the subscription attempt or otherwise fails it will
* If the {@link Publisher} rejects the subscription attempt or otherwise fails it will
* signal the error via {@link Subscriber#onError}.
*
*
* @param s the {@link Subscriber} that will consume signals from this {@link Publisher}
*/
public void subscribe(Subscriber<? super T> s);
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/org/reactivestreams/Subscriber.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* <p>
* Demand can be signaled via {@link Subscription#request(long)} whenever the {@link Subscriber} instance is capable of handling more.
*
* @param <T> the Type of element signaled.
* @param <T> the type of element signaled.
*/
public interface Subscriber<T> {
/**
Expand Down