diff --git a/CopyrightWaivers.txt b/CopyrightWaivers.txt index 3dbee6ea..b48a9b75 100644 --- a/CopyrightWaivers.txt +++ b/CopyrightWaivers.txt @@ -24,3 +24,5 @@ viktorklang | Viktor Klang, viktor.klang@gmail.com, Typesafe Inc. smaldini | Stephane Maldini, stephane.maldini@gmail.com, Pivotal Software Inc. savulchik | Stanislav Savulchik, s.savulchik@gmail.com ktoso | Konrad Malawski, konrad.malawski@project13.pl, Typesafe Inc. +ouertani | Slim Ouertani, ouertani@gmail.com + diff --git a/api/src/main/java/org/reactivestreams/Processor.java b/api/src/main/java/org/reactivestreams/Processor.java index 1e231b98..b22e25f7 100644 --- a/api/src/main/java/org/reactivestreams/Processor.java +++ b/api/src/main/java/org/reactivestreams/Processor.java @@ -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 the type of element signaled to the {@link Subscriber} + * @param the type of element signaled by the {@link Publisher} */ public interface Processor extends Subscriber, Publisher { } diff --git a/api/src/main/java/org/reactivestreams/Publisher.java b/api/src/main/java/org/reactivestreams/Publisher.java index d370ca52..b97a9fc1 100644 --- a/api/src/main/java/org/reactivestreams/Publisher.java +++ b/api/src/main/java/org/reactivestreams/Publisher.java @@ -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). + *

+ * A {@link Publisher} can serve multiple {@link Subscriber}s subscribed {@link #subscribe(Subscriber)}dynamically + * at various points in time. + * + * @param the type of element signaled. + */ public interface Publisher { /** @@ -11,9 +20,9 @@ public interface Publisher { *

* A {@link Subscriber} should only subscribe once to a single {@link Publisher}. *

- * 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 s); diff --git a/api/src/main/java/org/reactivestreams/Subscriber.java b/api/src/main/java/org/reactivestreams/Subscriber.java index f5cb9978..6165352e 100644 --- a/api/src/main/java/org/reactivestreams/Subscriber.java +++ b/api/src/main/java/org/reactivestreams/Subscriber.java @@ -13,7 +13,7 @@ *

* Demand can be signaled via {@link Subscription#request(long)} whenever the {@link Subscriber} instance is capable of handling more. * - * @param the Type of element signaled. + * @param the type of element signaled. */ public interface Subscriber { /**