akka.stream.impl

Class SinkModule<In,Mat>

java.lang.Object

akka.stream.impl.StreamLayout.AtomicModule

akka.stream.impl.SinkModule<In,Mat>

All Implemented Interfaces:

StreamLayout.Module

Direct Known Subclasses:

ActorRefSink, ActorSubscriberSink, CancelSink, FanoutPublisherSink, FileSink, OutputStreamSink, PublisherSink, StreamTestKit.ProbeSink, SubscriberSink

public abstract class SinkModule<In,Mat>
extends StreamLayout.AtomicModule

INTERNAL API

Constructor Summary

Constructors

Constructor and Description
SinkModule(SinkShape<In> shape)

Method Summary

Modifier and Type	Method and Description
protected SinkShape<In>	amendShape(Attributes attr)
StreamLayout.AtomicModule	carbonCopy() The purpose of this method is to create a copy to be included in a larger graph such that port identity clashes are avoided.
abstract scala.Tuple2<java.lang.Object,Mat>	create(MaterializationContext context) Create the Subscriber or VirtualPublisher that consumes the incoming stream, plus the materialized value.
protected java.lang.String	label()
protected abstract SinkModule<In,Mat>	newInstance(SinkShape<In> s)
StreamLayout.AtomicModule	replaceShape(Shape s) Verify that the given Shape has the same ports and return a new module with that shape.
SinkShape<In>	shape()
java.lang.String	toString()

Methods inherited from class akka.stream.impl.StreamLayout.AtomicModule

downstreams, inPorts, outPorts, subModules, upstreams

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.stream.impl.StreamLayout.Module

attributes, compose, compose, composeNoMat, equals, fuse, fuse, hashCode, isAtomic, isBidiFlow, isCopied, isFlow, isFused, isRunnable, isSealed, isSink, isSource, materializedValueComputation, transformMaterializedValue, wire, withAttributes

Constructor Detail

SinkModule

public SinkModule(SinkShape<In> shape)

Method Detail

shape

public SinkShape<In> shape()

create

public abstract scala.Tuple2<java.lang.Object,Mat> create(MaterializationContext context)

Create the Subscriber or VirtualPublisher that consumes the incoming stream, plus the materialized value. Since Subscriber and VirtualPublisher do not share a common supertype apart from AnyRef this is what the type union devolves into; unfortunately we do not have union types at our disposal at this point.

Parameters:

context - (undocumented)

Returns:

(undocumented)

replaceShape

public StreamLayout.AtomicModule replaceShape(Shape s)

Description copied from interface: StreamLayout.Module

Verify that the given Shape has the same ports and return a new module with that shape. Concrete implementations may throw UnsupportedOperationException where applicable.

Please note that this method MUST NOT be implemented using a CopiedModule since the purpose of replaceShape can also be to rearrange the ports (as in BidiFlow.reversed) and that purpose would be defeated.

Parameters:

s - (undocumented)

Returns:

(undocumented)

newInstance

protected abstract SinkModule<In,Mat> newInstance(SinkShape<In> s)

carbonCopy

public StreamLayout.AtomicModule carbonCopy()

Description copied from interface: StreamLayout.Module

The purpose of this method is to create a copy to be included in a larger graph such that port identity clashes are avoided. Where a full copy is not possible or desirable, use a CopiedModule. The shape of the resulting module MUST NOT contain the same ports as this module&rsquo;s shape.

Returns:

(undocumented)

amendShape

protected SinkShape<In> amendShape(Attributes attr)

label

protected java.lang.String label()

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object