Package akka.stream.javadsl

Class Sink$

  • public class Sink$
extends java.lang.Object
    Java API

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Sink$ MODULE$
      Static reference to the singleton instance of this Scala object.

    • Constructor Summary

      Constructors 
      Constructor Description
      Sink$()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      <In> Sink<In,​NotUsed> actorRef​(ActorRef ref, java.lang.Object onCompleteMessage)
      Sends the elements of the stream to the given ActorRef.
      <In> Sink<In,​NotUsed> actorRefWithAck​(ActorRef ref, java.lang.Object onInitMessage, java.lang.Object ackMessage, java.lang.Object onCompleteMessage, Function<java.lang.Throwable,​java.lang.Object> onFailureMessage)
      Deprecated.
      Use actorRefWithBackpressure instead
      <In> Sink<In,​NotUsed> actorRefWithBackpressure​(ActorRef ref, java.lang.Object onInitMessage, java.lang.Object onCompleteMessage, Function<java.lang.Throwable,​java.lang.Object> onFailureMessage)
      Sends the elements of the stream to the given ActorRef that sends back back-pressure signal.
      <In> Sink<In,​NotUsed> actorRefWithBackpressure​(ActorRef ref, java.lang.Object onInitMessage, java.lang.Object ackMessage, java.lang.Object onCompleteMessage, Function<java.lang.Throwable,​java.lang.Object> onFailureMessage)
      Sends the elements of the stream to the given ActorRef that sends back back-pressure signal.
      <T> Sink<T,​org.reactivestreams.Publisher<T>> asPublisher​(AsPublisher fanout)
      A Sink that materializes into a Publisher.
      <T> Sink<T,​NotUsed> cancelled()
      A Sink that immediately cancels its upstream after materialization.
      <U,​In>
      Sink<In,​java.util.concurrent.CompletionStage<U>>      		 collect​(java.util.stream.Collector<In,​?,​U> collector)
      Creates a sink which materializes into a CompletionStage which will be completed with a result of the Java Collector transformation and reduction operations.
      <T,​U>
      Sink<T,​NotUsed>      		 combine​(Sink<U,​?> output1, Sink<U,​?> output2, java.util.List<Sink<U,​?>> rest, Function<java.lang.Integer,​Graph<UniformFanOutShape<T,​U>,​NotUsed>> strategy)
      Combine several sinks with fan-out strategy like Broadcast or Balance and returns Sink.
      <T,​M>
      Sink<T,​java.util.concurrent.CompletionStage<M>>      		 completionStageSink​(java.util.concurrent.CompletionStage<Sink<T,​M>> future)
      Turn a Future[Sink] into a Sink that will consume the values of the source when the future completes successfully.
      <U,​In>
      Sink<In,​java.util.concurrent.CompletionStage<U>>      		 fold​(U zero, Function2<U,​In,​U> f)
      A Sink that will invoke the given function for every received element, giving it its previous output (or the given zero value) and the element as input.
      <U,​In>
      Sink<In,​java.util.concurrent.CompletionStage<U>>      		 foldAsync​(U zero, Function2<U,​In,​java.util.concurrent.CompletionStage<U>> f)
      A Sink that will invoke the given asynchronous function for every received element, giving it its previous output (or the given zero value) and the element as input.
      <T> Sink<T,​java.util.concurrent.CompletionStage<Done>> foreach​(Procedure<T> f)
      A Sink that will invoke the given procedure for each received element.
      <T> Sink<T,​java.util.concurrent.CompletionStage<Done>> foreachAsync​(int parallelism, Function<T,​java.util.concurrent.CompletionStage<java.lang.Void>> f)
      A Sink that will invoke the given procedure asynchronously for each received element.
      <T> Sink<T,​java.util.concurrent.CompletionStage<Done>> foreachParallel​(int parallel, Procedure<T> f, scala.concurrent.ExecutionContext ec)
      Deprecated.
      Use `foreachAsync` instead, it allows you to choose how to run the procedure, by calling some other API returning a CompletionStage or using CompletableFuture.supplyAsync.
      <T,​M>
      Sink<T,​M>      		 fromGraph​(Graph<SinkShape<T>,​M> g)
      A graph with the shape of a sink logically is a sink, this method makes it so also in type.
      <T,​M>
      Sink<T,​java.util.concurrent.CompletionStage<M>>      		 fromMaterializer​(java.util.function.BiFunction<Materializer,​Attributes,​Sink<T,​M>> factory)
      Defers the creation of a Sink until materialization.
      <In> Sink<In,​NotUsed> fromSubscriber​(org.reactivestreams.Subscriber<In> subs)
      Helper to create Sink from Subscriber.
      <In> Sink<In,​java.util.concurrent.CompletionStage<In>> head()
      A Sink that materializes into a CompletionStage of the first value received.
      <In> Sink<In,​java.util.concurrent.CompletionStage<java.util.Optional<In>>> headOption()
      A Sink that materializes into a CompletionStage of the optional first value received.
      <T> Sink<T,​java.util.concurrent.CompletionStage<Done>> ignore()
      A Sink that will consume the stream and discard the elements.
      <In> Sink<In,​java.util.concurrent.CompletionStage<In>> last()
      A Sink that materializes into a CompletionStage of the last value received.
      <In> Sink<In,​java.util.concurrent.CompletionStage<java.util.Optional<In>>> lastOption()
      A Sink that materializes into a CompletionStage of the optional last value received.
      <T,​M>
      Sink<T,​java.util.concurrent.CompletionStage<M>>      		 lazyCompletionStageSink​(Creator<java.util.concurrent.CompletionStage<Sink<T,​M>>> create)
      Defers invoking the create function to create a future sink until there is a first element passed from upstream.
      <T,​M>
      Sink<T,​java.util.concurrent.CompletionStage<M>>      		 lazyInit​(Function<T,​java.util.concurrent.CompletionStage<Sink<T,​M>>> sinkFactory, Creator<M> fallback)
      Deprecated.
      Use 'Sink.lazyCompletionStageSink' in combination with 'Flow.prefixAndTail(1)' instead.
      <T,​M>
      Sink<T,​java.util.concurrent.CompletionStage<java.util.Optional<M>>>      		 lazyInitAsync​(Creator<java.util.concurrent.CompletionStage<Sink<T,​M>>> sinkFactory)
      Deprecated.
      Use 'Sink.lazyCompletionStageSink' instead.
      <T,​M>
      Sink<T,​java.util.concurrent.CompletionStage<M>>      		 lazySink​(Creator<Sink<T,​M>> create)
      Defers invoking the create function to create a sink until there is a first element passed from upstream.
      <T> Sink<T,​java.util.concurrent.CompletionStage<Done>> never()
      A Sink that will always backpressure never cancel and never consume any elements from the stream.
      <In> Sink<In,​NotUsed> onComplete​(Procedure<scala.util.Try<Done>> callback)
      A Sink that when the flow is completed, either through a failure or normal completion, apply the provided function with Success or Failure.
      <T> Sink<T,​SinkQueueWithCancel<T>> queue()
      Creates a Sink that is materialized as an SinkQueueWithCancel.
      <T> Sink<T,​SinkQueueWithCancel<T>> queue​(int maxConcurrentPulls)
      Creates a Sink that is materialized as an SinkQueueWithCancel.
      <In> Sink<In,​java.util.concurrent.CompletionStage<In>> reduce​(Function2<In,​In,​In> f)
      A Sink that will invoke the given function for every received element, giving it its previous output (from the second element) and the element as input.
      <In> Sink<In,​java.util.concurrent.CompletionStage<java.util.List<In>>> seq()
      A Sink that keeps on collecting incoming elements until upstream terminates.
      <T,​M>
      Sink<T,​java.util.concurrent.CompletionStage<M>>      		 setup​(java.util.function.BiFunction<ActorMaterializer,​Attributes,​Sink<T,​M>> factory)
      Deprecated.
      Use 'fromMaterializer' instead.
      <In> Sink<In,​java.util.concurrent.CompletionStage<java.util.List<In>>> takeLast​(int n)
      A Sink that materializes into a a CompletionStage of List containing the last n collected elements.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • MODULE$

        public static final Sink$ MODULE$
        Static reference to the singleton instance of this Scala object.

    • Constructor Detail

      • Sink$

        public Sink$()

    • Method Detail

      • fold

        public <U,​In> Sink<In,​java.util.concurrent.CompletionStage<U>> fold​(U zero,
                                                                                Function2<U,​In,​U> f)
        A Sink that will invoke the given function for every received element, giving it its previous output (or the given zero value) and the element as input. The returned CompletionStage will be completed with value of the final function evaluation when the input stream ends, or completed with Failure if there is a failure is signaled in the stream.

      • foldAsync

        public <U,​In> Sink<In,​java.util.concurrent.CompletionStage<U>> foldAsync​(U zero,
                                                                                     Function2<U,​In,​java.util.concurrent.CompletionStage<U>> f)
        A Sink that will invoke the given asynchronous function for every received element, giving it its previous output (or the given zero value) and the element as input. The returned CompletionStage will be completed with value of the final function evaluation when the input stream ends, or completed with Failure if there is a failure is signaled in the stream.

      • collect

        public <U,​In> Sink<In,​java.util.concurrent.CompletionStage<U>> collect​(java.util.stream.Collector<In,​?,​U> collector)
        Creates a sink which materializes into a CompletionStage which will be completed with a result of the Java Collector transformation and reduction operations. This allows usage of Java streams transformations for reactive streams. The Collector will trigger demand downstream. Elements emitted through the stream will be accumulated into a mutable result container, optionally transformed into a final representation after all input elements have been processed. The Collector can also do reduction at the end. Reduction processing is performed sequentially.

      • reduce

        public <In> Sink<In,​java.util.concurrent.CompletionStage<In>> reduce​(Function2<In,​In,​In> f)
        A Sink that will invoke the given function for every received element, giving it its previous output (from the second element) and the element as input. The returned CompletionStage will be completed with value of the final function evaluation when the input stream ends, or completed with Failure if there is a failure signaled in the stream.

        If the stream is empty (i.e. completes before signalling any elements), the reduce operator will fail its downstream with a NoSuchElementException, which is semantically in-line with that Scala's standard library collections do in such situations.

      • fromSubscriber

        public <In> Sink<In,​NotUsed> fromSubscriber​(org.reactivestreams.Subscriber<In> subs)
        Helper to create Sink from Subscriber.

      • cancelled

        public <T> Sink<T,​NotUsed> cancelled()
        A Sink that immediately cancels its upstream after materialization.

      • ignore

        public <T> Sink<T,​java.util.concurrent.CompletionStage<Done>> ignore()
        A Sink that will consume the stream and discard the elements.

      • never

        public <T> Sink<T,​java.util.concurrent.CompletionStage<Done>> never()
        A Sink that will always backpressure never cancel and never consume any elements from the stream.

      • asPublisher

        public <T> Sink<T,​org.reactivestreams.Publisher<T>> asPublisher​(AsPublisher fanout)
        A Sink that materializes into a Publisher.

        If fanout is true, the materialized Publisher will support multiple Subscribers and the size of the inputBuffer configured for this operator becomes the maximum number of elements that the fastest Subscriber can be ahead of the slowest one before slowing the processing down due to back pressure.

        If fanout is false then the materialized Publisher will only support a single Subscriber and reject any additional Subscribers.

      • foreach

        public <T> Sink<T,​java.util.concurrent.CompletionStage<Done>> foreach​(Procedure<T> f)
        A Sink that will invoke the given procedure for each received element. The sink is materialized into a CompletionStage which will be completed with Success when reaching the normal end of the stream, or completed with Failure if there is a failure signaled in the stream.

      • foreachAsync

        public <T> Sink<T,​java.util.concurrent.CompletionStage<Done>> foreachAsync​(int parallelism,
                                                                                 Function<T,​java.util.concurrent.CompletionStage<java.lang.Void>> f)
        A Sink that will invoke the given procedure asynchronously for each received element. The sink is materialized into a CompletionStage which will be completed with Success when reaching the normal end of the stream, or completed with Failure if there is a failure signaled in the stream.

      • foreachParallel

        public <T> Sink<T,​java.util.concurrent.CompletionStage<Done>> foreachParallel​(int parallel,
                                                                                    Procedure<T> f,
                                                                                    scala.concurrent.ExecutionContext ec)
        Deprecated.
        Use `foreachAsync` instead, it allows you to choose how to run the procedure, by calling some other API returning a CompletionStage or using CompletableFuture.supplyAsync. Since 2.5.17.
        A Sink that will invoke the given procedure for each received element in parallel. The sink is materialized into a CompletionStage.

        If f throws an exception and the supervision decision is akka.stream.Supervision.Stop the CompletionStage will be completed with failure.

        If f throws an exception and the supervision decision is akka.stream.Supervision.Resume or akka.stream.Supervision.Restart the element is dropped and the stream continues.

      • onComplete

        public <In> Sink<In,​NotUsed> onComplete​(Procedure<scala.util.Try<Done>> callback)
        A Sink that when the flow is completed, either through a failure or normal completion, apply the provided function with Success or Failure.

      • head

        public <In> Sink<In,​java.util.concurrent.CompletionStage<In>> head()
        A Sink that materializes into a CompletionStage of the first value received. If the stream completes before signaling at least a single element, the CompletionStage will be failed with a NoSuchElementException. If the stream signals an error before signaling at least a single element, the CompletionStage will be failed with the streams exception.

        See also <In>headOption().

      • headOption

        public <In> Sink<In,​java.util.concurrent.CompletionStage<java.util.Optional<In>>> headOption()
        A Sink that materializes into a CompletionStage of the optional first value received. If the stream completes before signaling at least a single element, the value of the CompletionStage will be an empty Optional. If the stream signals an error errors before signaling at least a single element, the CompletionStage will be failed with the streams exception.

        See also <In>head().

      • last

        public <In> Sink<In,​java.util.concurrent.CompletionStage<In>> last()
        A Sink that materializes into a CompletionStage of the last value received. If the stream completes before signaling at least a single element, the CompletionStage will be failed with a NoSuchElementException. If the stream signals an error errors before signaling at least a single element, the CompletionStage will be failed with the streams exception.

        See also <In>lastOption(), <In>takeLast(int).

      • lastOption

        public <In> Sink<In,​java.util.concurrent.CompletionStage<java.util.Optional<In>>> lastOption()
        A Sink that materializes into a CompletionStage of the optional last value received. If the stream completes before signaling at least a single element, the value of the CompletionStage will be an empty Optional. If the stream signals an error errors before signaling at least a single element, the CompletionStage will be failed with the streams exception.

        See also <In>head(), <In>takeLast(int).

      • takeLast

        public <In> Sink<In,​java.util.concurrent.CompletionStage<java.util.List<In>>> takeLast​(int n)
        A Sink that materializes into a a CompletionStage of List containing the last n collected elements.

        If the stream completes before signaling at least n elements, the CompletionStage will complete with all elements seen so far. If the stream never completes the CompletionStage will never complete. If there is a failure signaled in the stream the CompletionStage will be completed with failure.

      • seq

        public <In> Sink<In,​java.util.concurrent.CompletionStage<java.util.List<In>>> seq()
        A Sink that keeps on collecting incoming elements until upstream terminates. As upstream may be unbounded, Flow[T].take or the stricter Flow[T].limit (and their variants) may be used to ensure boundedness. Materializes into a CompletionStage of Seq[T] containing all the collected elements. List is limited to Integer.MAX_VALUE elements, this Sink will cancel the stream after having received that many elements.

        See also Flow.limit, Flow.limitWeighted, Flow.take, Flow.takeWithin, Flow.takeWhile

      • actorRef

        public <In> Sink<In,​NotUsed> actorRef​(ActorRef ref,
                                            java.lang.Object onCompleteMessage)
        Sends the elements of the stream to the given ActorRef. If the target actor terminates the stream will be canceled. When the stream is completed successfully the given onCompleteMessage will be sent to the destination actor. When the stream is completed with failure a Status.Failure message will be sent to the destination actor.

        It will request at most maxInputBufferSize number of elements from upstream, but there is no back-pressure signal from the destination actor, i.e. if the actor is not consuming the messages fast enough the mailbox of the actor will grow. For potentially slow consumer actors it is recommended to use a bounded mailbox with zero mailbox-push-timeout-time or use a rate limiting operator in front of this Sink.

      • actorRefWithBackpressure

        public <In> Sink<In,​NotUsed> actorRefWithBackpressure​(ActorRef ref,
                                                            java.lang.Object onInitMessage,
                                                            java.lang.Object ackMessage,
                                                            java.lang.Object onCompleteMessage,
                                                            Function<java.lang.Throwable,​java.lang.Object> onFailureMessage)
        Sends the elements of the stream to the given ActorRef that sends back back-pressure signal. First element is always onInitMessage, then stream is waiting for acknowledgement message ackMessage from the given actor which means that it is ready to process elements. It also requires ackMessage message after each stream element to make backpressure work.

        If the target actor terminates the stream will be canceled. When the stream is completed successfully the given onCompleteMessage will be sent to the destination actor. When the stream is completed with failure - result of onFailureMessage(throwable) message will be sent to the destination actor.

      • actorRefWithBackpressure

        public <In> Sink<In,​NotUsed> actorRefWithBackpressure​(ActorRef ref,
                                                            java.lang.Object onInitMessage,
                                                            java.lang.Object onCompleteMessage,
                                                            Function<java.lang.Throwable,​java.lang.Object> onFailureMessage)
        Sends the elements of the stream to the given ActorRef that sends back back-pressure signal. First element is always onInitMessage, then stream is waiting for acknowledgement message from the given actor which means that it is ready to process elements. It also requires an ack message after each stream element to make backpressure work. This variant will consider any message as ack message.

        If the target actor terminates the stream will be canceled. When the stream is completed successfully the given onCompleteMessage will be sent to the destination actor. When the stream is completed with failure - result of onFailureMessage(throwable) message will be sent to the destination actor.

      • actorRefWithAck

        public <In> Sink<In,​NotUsed> actorRefWithAck​(ActorRef ref,
                                                   java.lang.Object onInitMessage,
                                                   java.lang.Object ackMessage,
                                                   java.lang.Object onCompleteMessage,
                                                   Function<java.lang.Throwable,​java.lang.Object> onFailureMessage)
        Deprecated.
        Use actorRefWithBackpressure instead
        Sends the elements of the stream to the given ActorRef that sends back back-pressure signal. First element is always onInitMessage, then stream is waiting for acknowledgement message ackMessage from the given actor which means that it is ready to process elements. It also requires ackMessage message after each stream element to make backpressure work.

        If the target actor terminates the stream will be canceled. When the stream is completed successfully the given onCompleteMessage will be sent to the destination actor. When the stream is completed with failure - result of onFailureMessage(throwable) message will be sent to the destination actor.

      • fromGraph

        public <T,​M> Sink<T,​M> fromGraph​(Graph<SinkShape<T>,​M> g)
        A graph with the shape of a sink logically is a sink, this method makes it so also in type.

      • fromMaterializer

        public <T,​M> Sink<T,​java.util.concurrent.CompletionStage<M>> fromMaterializer​(java.util.function.BiFunction<Materializer,​Attributes,​Sink<T,​M>> factory)
        Defers the creation of a Sink until materialization. The factory function exposes Materializer which is going to be used during materialization and Attributes of the Sink returned by this method.

      • setup

        public <T,​M> Sink<T,​java.util.concurrent.CompletionStage<M>> setup​(java.util.function.BiFunction<ActorMaterializer,​Attributes,​Sink<T,​M>> factory)
        Deprecated.
        Use 'fromMaterializer' instead. Since 2.6.0.
        Defers the creation of a Sink until materialization. The factory function exposes ActorMaterializer which is going to be used during materialization and Attributes of the Sink returned by this method.

      • combine

        public <T,​U> Sink<T,​NotUsed> combine​(Sink<U,​?> output1,
                                                 Sink<U,​?> output2,
                                                 java.util.List<Sink<U,​?>> rest,
                                                 Function<java.lang.Integer,​Graph<UniformFanOutShape<T,​U>,​NotUsed>> strategy)
        Combine several sinks with fan-out strategy like Broadcast or Balance and returns Sink.

      • queue

        public <T> Sink<T,​SinkQueueWithCancel<T>> queue​(int maxConcurrentPulls)
        Creates a Sink that is materialized as an SinkQueueWithCancel. akka.stream.javadsl.SinkQueueWithCancel.pull method is pulling element from the stream and returns CompletionStage[Option[T}. CompletionStage completes when element is available.

        Before calling pull method second time you need to ensure that number of pending pulls is less then maxConcurrentPulls or wait until some of the previous Futures completes. Pull returns Failed future with ''IllegalStateException'' if there will be more then maxConcurrentPulls number of pending pulls.

        Sink will request at most number of elements equal to size of inputBuffer from upstream and then stop back pressure. You can configure size of input buffer by using Sink.withAttributes method.

        For stream completion you need to pull all elements from SinkQueueWithCancel including last None as completion marker

        See Also:
        SinkQueueWithCancel

      • queue

        public <T> Sink<T,​SinkQueueWithCancel<T>> queue()
        Creates a Sink that is materialized as an SinkQueueWithCancel. akka.stream.javadsl.SinkQueueWithCancel.pull method is pulling element from the stream and returns CompletionStage[Option[T}. CompletionStage completes when element is available.

        Before calling pull method second time you need to wait until previous CompletionStage completes. Pull returns Failed future with ''IllegalStateException'' if previous future has not yet completed.

        Sink will request at most number of elements equal to size of inputBuffer from upstream and then stop back pressure. You can configure size of input buffer by using Sink.withAttributes method.

        For stream completion you need to pull all elements from SinkQueueWithCancel including last None as completion marker

        See Also:
        SinkQueueWithCancel

      • lazyInit

        public <T,​M> Sink<T,​java.util.concurrent.CompletionStage<M>> lazyInit​(Function<T,​java.util.concurrent.CompletionStage<Sink<T,​M>>> sinkFactory,
                                                                                  Creator<M> fallback)
        Deprecated.
        Use 'Sink.lazyCompletionStageSink' in combination with 'Flow.prefixAndTail(1)' instead. Since 2.6.0.
        Creates a real Sink upon receiving the first element. Internal Sink will not be created if there are no elements, because of completion or error.

        If upstream completes before an element was received then the Future is completed with the value created by fallback. If upstream fails before an element was received, sinkFactory throws an exception, or materialization of the internal sink fails then the Future is completed with the exception. Otherwise the Future is completed with the materialized value of the internal sink.

      • lazyInitAsync

        public <T,​M> Sink<T,​java.util.concurrent.CompletionStage<java.util.Optional<M>>> lazyInitAsync​(Creator<java.util.concurrent.CompletionStage<Sink<T,​M>>> sinkFactory)
        Deprecated.
        Use 'Sink.lazyCompletionStageSink' instead. Since 2.6.0.
        Creates a real Sink upon receiving the first element. Internal Sink will not be created if there are no elements, because of completion or error.

        If upstream completes before an element was received then the Future is completed with None. If upstream fails before an element was received, sinkFactory throws an exception, or materialization of the internal sink fails then the Future is completed with the exception. Otherwise the Future is completed with the materialized value of the internal sink.

      • completionStageSink

        public <T,​M> Sink<T,​java.util.concurrent.CompletionStage<M>> completionStageSink​(java.util.concurrent.CompletionStage<Sink<T,​M>> future)
        Turn a Future[Sink] into a Sink that will consume the values of the source when the future completes successfully. If the Future is completed with a failure the stream is failed.

        The materialized future value is completed with the materialized value of the future sink or failed with a NeverMaterializedException if upstream fails or downstream cancels before the future has completed.

      • lazySink

        public <T,​M> Sink<T,​java.util.concurrent.CompletionStage<M>> lazySink​(Creator<Sink<T,​M>> create)
        Defers invoking the create function to create a sink until there is a first element passed from upstream.

        The materialized future value is completed with the materialized value of the created sink when that has successfully been materialized.

        If the create function throws or returns or the stream fails to materialize, in this case the materialized future value is failed with a NeverMaterializedException.

      • lazyCompletionStageSink

        public <T,​M> Sink<T,​java.util.concurrent.CompletionStage<M>> lazyCompletionStageSink​(Creator<java.util.concurrent.CompletionStage<Sink<T,​M>>> create)
        Defers invoking the create function to create a future sink until there is a first element passed from upstream.

        The materialized future value is completed with the materialized value of the created sink when that has successfully been materialized.

        If the create function throws or returns a future that is failed, or the stream fails to materialize, in this case the materialized future value is failed with a NeverMaterializedException.