SinkModule

java.lang.Object
- akka.stream.impl.SinkModule<In,Mat>

All Implemented Interfaces:

Graph<SinkShape<In>,Mat>, StreamLayout.AtomicModule<SinkShape<In>,Mat>

Direct Known Subclasses:

CancelSink, FanoutPublisherSink, PublisherSink, StreamTestKit.ProbeSink, SubscriberSink
```
public abstract class SinkModule<In,Mat>
extends java.lang.Object
implements StreamLayout.AtomicModule<SinkShape<In>,Mat>
```
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.

Constructor Summary

Constructors
Constructor Description

SinkModule(SinkShape<In> shape)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected SinkShape<In>`	`amendShape(Attributes attr)`
`abstract Attributes`	`attributes()`
`abstract scala.Tuple2<java.lang.Object,Mat>`	`create(MaterializationContext context)`
`protected java.lang.String`	`label()`
`protected abstract SinkModule<In,Mat>`	`newInstance(SinkShape<In> s)`
`SinkShape<In>`	`shape()`	The shape of a graph is all that is externally visible: its inlets and outlets.
`java.lang.String`	`toString()`
`TraversalBuilder`	`traversalBuilder()`	INTERNAL API.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface akka.stream.Graph
addAttributes, async, async, async, named, withAttributes

- Constructor Detail
  - SinkModule
```
public SinkModule(SinkShape<In> shape)
```
- Method Detail
  - amendShape
```
protected SinkShape<In> amendShape(Attributes attr)
```
  - attributes
```
public abstract Attributes attributes()
```
  - create
```
public abstract scala.Tuple2<java.lang.Object,Mat> create(MaterializationContext context)
```
  - label
```
protected java.lang.String label()
```
  - newInstance
```
protected abstract SinkModule<In,Mat> newInstance(SinkShape<In> s)
```
  - shape
```
public SinkShape<In> shape()
```
    Description copied from interface: Graph
    
    The shape of a graph is all that is externally visible: its inlets and outlets.
    
    Specified by:
    
    shape in interface Graph<In,Mat>
    
    Returns:
    
    (undocumented)
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - traversalBuilder
```
public TraversalBuilder traversalBuilder()
```
    Description copied from interface: Graph
    
    INTERNAL API.
    Every materializable element must be backed by a stream layout module
    
    Specified by:
    
    traversalBuilder in interface Graph<In,Mat>
    
    Returns:
    
    (undocumented)