=str Fix scaladoc warnings
This commit is contained in:
Patrik Nordwall
parent
fc941b891c
commit
d6ad67150a
8 changed files with 34 additions and 37 deletions
|
|
@ -153,8 +153,8 @@ object MaterializerSettings {
|
|||
/**
|
||||
* Create [[MaterializerSettings]].
|
||||
*
|
||||
* You can refine the configuration based settings using [[MaterializerSettings#withBuffer]],
|
||||
* [[MaterializerSettings#withFanOut]], [[MaterializerSettings#withSubscriptionTimeout]]
|
||||
* You can refine the configuration based settings using [[MaterializerSettings#withInputBuffer]],
|
||||
* [[MaterializerSettings#withFanOutBuffer]], [[MaterializerSettings#withDispatcher]]
|
||||
*/
|
||||
def apply(system: ActorSystem): MaterializerSettings =
|
||||
apply(system.settings.config.getConfig("akka.stream.materializer"))
|
||||
|
|
@ -162,8 +162,8 @@ object MaterializerSettings {
|
|||
/**
|
||||
* Create [[MaterializerSettings]].
|
||||
*
|
||||
* You can refine the configuration based settings using [[MaterializerSettings#withBuffer]],
|
||||
* [[MaterializerSettings#withFanOut]], [[MaterializerSettings#withSubscriptionTimeout]]
|
||||
* You can refine the configuration based settings using [[MaterializerSettings#withInputBuffer]],
|
||||
* [[MaterializerSettings#withFanOutBuffer]], [[MaterializerSettings#withDispatcher]]
|
||||
*/
|
||||
def apply(config: Config): MaterializerSettings =
|
||||
MaterializerSettings(
|
||||
|
|
@ -176,8 +176,8 @@ object MaterializerSettings {
|
|||
/**
|
||||
* Java API
|
||||
*
|
||||
* You can refine the configuration based settings using [[MaterializerSettings#withBuffer]],
|
||||
* [[MaterializerSettings#withFanOut]], [[MaterializerSettings#withSubscriptionTimeout]]
|
||||
* You can refine the configuration based settings using [[MaterializerSettings#withInputBuffer]],
|
||||
* [[MaterializerSettings#withFanOutBuffer]], [[MaterializerSettings#withDispatcher]]
|
||||
*/
|
||||
def create(system: ActorSystem): MaterializerSettings =
|
||||
apply(system)
|
||||
|
|
@ -185,8 +185,8 @@ object MaterializerSettings {
|
|||
/**
|
||||
* Java API
|
||||
*
|
||||
* You can refine the configuration based settings using [[MaterializerSettings#withBuffer]],
|
||||
* [[MaterializerSettings#withFanOut]], [[MaterializerSettings#withSubscriptionTimeout]]
|
||||
* You can refine the configuration based settings using [[MaterializerSettings#withInputBuffer]],
|
||||
* [[MaterializerSettings#withFanOutBuffer]], [[MaterializerSettings#withDispatcher]]
|
||||
*/
|
||||
def create(config: Config): MaterializerSettings =
|
||||
apply(config)
|
||||
|
|
|
|||
|
|
@ -109,12 +109,12 @@ object FlexiMerge {
|
|||
* How to handle completion or error from upstream input.
|
||||
*
|
||||
* The `onComplete` method is called when an upstream input was completed sucessfully.
|
||||
* It returns next behavior or [[#SameState]] to keep current behavior.
|
||||
* It returns next behavior or [[MergeLogic#sameState]] to keep current behavior.
|
||||
* A completion can be propagated downstream with [[MergeLogicContext#complete]],
|
||||
* or it can be swallowed to continue with remaining inputs.
|
||||
*
|
||||
* The `onError` method is called when an upstream input was completed sucessfully.
|
||||
* It returns next behavior or [[#SameState]] to keep current behavior.
|
||||
* It returns next behavior or [[MergeLogic#sameState]] to keep current behavior.
|
||||
* An error can be propagated downstream with [[MergeLogicContext#error]],
|
||||
* or it can be swallowed to continue with remaining inputs.
|
||||
*/
|
||||
|
|
@ -130,7 +130,7 @@ object FlexiMerge {
|
|||
* emit at least one element downstream with [[MergeLogicContext#emit]].
|
||||
*
|
||||
* The `onInput` method is called when an `element` was read from the `input`.
|
||||
* The method returns next behavior or [[#SameState]] to keep current behavior.
|
||||
* The method returns next behavior or [[MergeLogic#sameState]] to keep current behavior.
|
||||
*/
|
||||
abstract class State[In, Out](val condition: ReadCondition) {
|
||||
def onInput(ctx: MergeLogicContext[Out], input: InputHandle, element: In): State[_, Out]
|
||||
|
|
|
|||
|
|
@ -263,8 +263,8 @@ class Flow[-In, +Out](delegate: scaladsl.Flow[In, Out]) {
|
|||
|
||||
/**
|
||||
* Adds a fixed size buffer in the flow that allows to store elements from a faster upstream until it becomes full.
|
||||
* Depending on the defined [[OverflowStrategy]] it might drop elements or backpressure the upstream if there is no
|
||||
* space available
|
||||
* Depending on the defined [[akka.stream.OverflowStrategy]] it might drop elements or backpressure the upstream if
|
||||
* there is no space available
|
||||
*
|
||||
* @param size The size of the buffer in element count
|
||||
* @param overflowStrategy Strategy that is used when incoming elements cannot fit inside the buffer
|
||||
|
|
@ -280,7 +280,7 @@ class Flow[-In, +Out](delegate: scaladsl.Flow[In, Out]) {
|
|||
* subscribers, the [[akka.stream.Transformer#isComplete]] predicate determines whether to end
|
||||
* stream processing at this point; in that case the upstream subscription is
|
||||
* canceled. Before signaling normal completion to the downstream subscribers,
|
||||
* the [[akka.stream.Transformer#onComplete]] function is invoked to produce a (possibly empty)
|
||||
* the [[akka.stream.Transformer#onTermination]] function is invoked to produce a (possibly empty)
|
||||
* sequence of elements in response to the end-of-stream event.
|
||||
*
|
||||
* [[akka.stream.Transformer#onError]] is called when failure is signaled from upstream.
|
||||
|
|
@ -307,7 +307,7 @@ class Flow[-In, +Out](delegate: scaladsl.Flow[In, Out]) {
|
|||
* subscribers, the [[akka.stream.Transformer#isComplete]] predicate determines whether to end
|
||||
* stream processing at this point; in that case the upstream subscription is
|
||||
* canceled. Before signaling normal completion to the downstream subscribers,
|
||||
* the [[akka.stream.Transformer#onComplete]] function is invoked to produce a (possibly empty)
|
||||
* the [[akka.stream.Transformer#onTermination]] function is invoked to produce a (possibly empty)
|
||||
* sequence of elements in response to the end-of-stream event.
|
||||
*
|
||||
* [[akka.stream.Transformer#onError]] is called when failure is signaled from upstream.
|
||||
|
|
|
|||
|
|
@ -11,17 +11,17 @@ import akka.stream.scaladsl
|
|||
*
|
||||
* Returned by [[RunnableFlow#run]] and can be used as parameter to the
|
||||
* accessor method to retrieve the materialized `Source` or `Sink`, e.g.
|
||||
* [[akka.stream.scaladsl.SubscriberSource#subscriber]] or [[akka.stream.scaladsl.PublisherSink#publisher]].
|
||||
* [[akka.stream.javadsl.Source#subscriber]] or [[akka.stream.javadsl.Sink#publisher]].
|
||||
*/
|
||||
class MaterializedMap(delegate: scaladsl.MaterializedMap) {
|
||||
/**
|
||||
* Retrieve a materialized `Source`, e.g. the `Subscriber` of a [[akka.stream.scaladsl.SubscriberSource]].
|
||||
* Retrieve a materialized `Source`, e.g. the `Subscriber` of a [[akka.stream.javadsl.Source#subscriber]].
|
||||
*/
|
||||
def get[T](key: javadsl.KeyedSource[_, T]): T =
|
||||
delegate.get(key.asScala).asInstanceOf[T]
|
||||
|
||||
/**
|
||||
* Retrieve a materialized `Sink`, e.g. the `Publisher` of a [[akka.stream.scaladsl.PublisherSink]].
|
||||
* Retrieve a materialized `Sink`, e.g. the `Publisher` of a [[akka.stream.javadsl.Sink#publisher]].
|
||||
*/
|
||||
def get[D](key: javadsl.KeyedSink[_, D]): D =
|
||||
delegate.get(key.asScala).asInstanceOf[D]
|
||||
|
|
|
|||
|
|
@ -29,10 +29,6 @@ object Source {
|
|||
def adapt[O](source: scaladsl.Source[O]): Source[O] =
|
||||
new Source(source)
|
||||
|
||||
/** Adapt [[scaladsl.SourcePipe]] for use within JavaDSL */
|
||||
def adapt[O](source: scaladsl.SourcePipe[O]): Source[O] =
|
||||
new Source(source)
|
||||
|
||||
/**
|
||||
* Create a `Source` with no elements, i.e. an empty stream that is completed immediately
|
||||
* for every connected `Sink`.
|
||||
|
|
@ -380,8 +376,8 @@ class Source[+Out](delegate: scaladsl.Source[Out]) {
|
|||
|
||||
/**
|
||||
* Adds a fixed size buffer in the flow that allows to store elements from a faster upstream until it becomes full.
|
||||
* Depending on the defined [[OverflowStrategy]] it might drop elements or backpressure the upstream if there is no
|
||||
* space available
|
||||
* Depending on the defined [[akka.stream.OverflowStrategy]] it might drop elements or backpressure the upstream if
|
||||
* there is no space available
|
||||
*
|
||||
* @param size The size of the buffer in element count
|
||||
* @param overflowStrategy Strategy that is used when incoming elements cannot fit inside the buffer
|
||||
|
|
@ -397,7 +393,7 @@ class Source[+Out](delegate: scaladsl.Source[Out]) {
|
|||
* subscribers, the [[akka.stream.Transformer#isComplete]] predicate determines whether to end
|
||||
* stream processing at this point; in that case the upstream subscription is
|
||||
* canceled. Before signaling normal completion to the downstream subscribers,
|
||||
* the [[akka.stream.Transformer#onComplete]] function is invoked to produce a (possibly empty)
|
||||
* the [[akka.stream.Transformer#onTermination]] function is invoked to produce a (possibly empty)
|
||||
* sequence of elements in response to the end-of-stream event.
|
||||
*
|
||||
* [[akka.stream.Transformer#onError]] is called when failure is signaled from upstream.
|
||||
|
|
@ -424,7 +420,7 @@ class Source[+Out](delegate: scaladsl.Source[Out]) {
|
|||
* subscribers, the [[akka.stream.Transformer#isComplete]] predicate determines whether to end
|
||||
* stream processing at this point; in that case the upstream subscription is
|
||||
* canceled. Before signaling normal completion to the downstream subscribers,
|
||||
* the [[akka.stream.Transformer#onComplete]] function is invoked to produce a (possibly empty)
|
||||
* the [[akka.stream.Transformer#onTermination]] function is invoked to produce a (possibly empty)
|
||||
* sequence of elements in response to the end-of-stream event.
|
||||
*
|
||||
* [[akka.stream.Transformer#onError]] is called when failure is signaled from upstream.
|
||||
|
|
|
|||
|
|
@ -298,8 +298,8 @@ trait FlowOps[+Out] {
|
|||
|
||||
/**
|
||||
* Adds a fixed size buffer in the flow that allows to store elements from a faster upstream until it becomes full.
|
||||
* Depending on the defined [[OverflowStrategy]] it might drop elements or backpressure the upstream if there is no
|
||||
* space available
|
||||
* Depending on the defined [[akka.stream.OverflowStrategy]] it might drop elements or backpressure the upstream if
|
||||
* there is no space available
|
||||
*
|
||||
* @param size The size of the buffer in element count
|
||||
* @param overflowStrategy Strategy that is used when incoming elements cannot fit inside the buffer
|
||||
|
|
@ -317,7 +317,7 @@ trait FlowOps[+Out] {
|
|||
* subscribers, the [[akka.stream.Transformer#isComplete]] predicate determines whether to end
|
||||
* stream processing at this point; in that case the upstream subscription is
|
||||
* canceled. Before signaling normal completion to the downstream subscribers,
|
||||
* the [[akka.stream.Transformer#onComplete]] function is invoked to produce a (possibly empty)
|
||||
* the [[akka.stream.Transformer#onTermination]] function is invoked to produce a (possibly empty)
|
||||
* sequence of elements in response to the end-of-stream event.
|
||||
*
|
||||
* [[akka.stream.Transformer#onError]] is called when failure is signaled from upstream.
|
||||
|
|
@ -375,7 +375,7 @@ trait FlowOps[+Out] {
|
|||
|
||||
/**
|
||||
* Transforms a stream of streams into a contiguous stream of elements using the provided flattening strategy.
|
||||
* This operation can be used on a stream of element type [[Source]].
|
||||
* This operation can be used on a stream of element type [[akka.stream.scaladsl.Source]].
|
||||
*/
|
||||
def flatten[U](strategy: akka.stream.FlattenStrategy[Out, U]): Repr[U] = strategy match {
|
||||
case _: FlattenStrategy.Concat[Out] ⇒ andThen(ConcatAll)
|
||||
|
|
@ -394,7 +394,7 @@ trait FlowOps[+Out] {
|
|||
* subscribers, the [[akka.stream.Transformer#isComplete]] predicate determines whether to end
|
||||
* stream processing at this point; in that case the upstream subscription is
|
||||
* canceled. Before signaling normal completion to the downstream subscribers,
|
||||
* the [[akka.stream.Transformer#onComplete]] function is invoked to produce a (possibly empty)
|
||||
* the [[akka.stream.Transformer#onTermination]] function is invoked to produce a (possibly empty)
|
||||
* sequence of elements in response to the end-of-stream event.
|
||||
*
|
||||
* [[akka.stream.Transformer#onError]] is called when failure is signaled from upstream.
|
||||
|
|
|
|||
|
|
@ -21,18 +21,19 @@ trait Source[+Out] extends FlowOps[Out] {
|
|||
override type Repr[+O] <: Source[O]
|
||||
|
||||
/**
|
||||
* Transform this [[Source]] by appending the given processing stages.
|
||||
* Transform this [[akka.stream.scaladsl.Source]] by appending the given processing stages.
|
||||
*/
|
||||
def via[T](flow: Flow[Out, T]): Source[T]
|
||||
|
||||
/**
|
||||
* Connect this [[Source]] to a [[Sink]], concatenating the processing steps of both.
|
||||
* Connect this [[akka.stream.scaladsl.Source]] to a [[akka.stream.scaladsl.Sink]],
|
||||
* concatenating the processing steps of both.
|
||||
*/
|
||||
def to(sink: Sink[Out]): RunnableFlow
|
||||
|
||||
/**
|
||||
* Connect this `Source` to a `Sink` and run it. The returned value is the materialized value
|
||||
* of the `Sink`, e.g. the `Publisher` of a [[Sink.fanoutPublisher]].
|
||||
* of the `Sink`, e.g. the `Publisher` of a [[akka.stream.scaladsl.Sink#publisher]].
|
||||
*/
|
||||
def runWith(sink: Sink[Out])(implicit materializer: FlowMaterializer): sink.MaterializedType =
|
||||
to(sink).run().get(sink)
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@ package akka.stream
|
|||
* Scala API: The flow DSL allows the formulation of stream transformations based on some
|
||||
* input. The starting point is called [[Source]] and can be a collection, an iterator,
|
||||
* a block of code which is evaluated repeatedly or a [[org.reactivestreams.Publisher]].
|
||||
* A flow with an attached input and open output, is also a [[Source]].
|
||||
* A flow with an attached input and open output is also a [[Source]].
|
||||
*
|
||||
* A flow may also be defined without an attached input or output and that is then
|
||||
* a [[Flow]]. The `Flow` can be connected to the `Source` later by using [[Source#connect]] with
|
||||
* a [[Flow]]. The `Flow` can be connected to the `Source` later by using [[Source#via]] with
|
||||
* the flow as argument, and it remains a [[Source]].
|
||||
*
|
||||
* Transformations can be appended to `Source` and `Flow` with the operations
|
||||
|
|
@ -25,7 +25,7 @@ package akka.stream
|
|||
* In order to execute this pipeline the flow must be materialized by calling [[RunnableFlow#run]] on it.
|
||||
*
|
||||
* You can create your `Source`, `Flow` and `Sink` in any order and then wire them together before
|
||||
* they are materialized by connecting them using [[Flow#connect]], or connecting them into a
|
||||
* they are materialized by connecting them using [[Flow#via]] and [[Flow#to]], or connecting them into a
|
||||
* [[FlowGraph]] with fan-in and fan-out elements.
|
||||
*
|
||||
* See <a href="https://github.com/reactive-streams/reactive-streams/">Reactive Streams</a> for
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue