akka.stream.impl.fusing

Class GraphStageModule

java.lang.Object

akka.stream.impl.StreamLayout.AtomicModule

akka.stream.impl.fusing.GraphStageModule

All Implemented Interfaces:

StreamLayout.Module, java.io.Serializable, scala.Equals, scala.Product

public final class GraphStageModule
extends StreamLayout.AtomicModule
implements scala.Product, scala.Serializable

INTERNAL API

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GraphStageModule(Shape shape, Attributes attributes, GraphStageWithMaterializedValue<Shape,java.lang.Object> stage)

Method Summary

Modifier and Type	Method and Description
Attributes	attributes()
abstract static boolean	canEqual(java.lang.Object that)
StreamLayout.Module	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.
static StreamLayout.Module	compose(StreamLayout.Module that)
static <A,B,C> StreamLayout.Module	compose(StreamLayout.Module that, scala.Function2<A,B,C> f)
static StreamLayout.Module	composeNoMat(StreamLayout.Module that)
static scala.collection.immutable.Map<OutPort,InPort>	downstreams()
static boolean	equals(java.lang.Object obj)
static StreamLayout.Module	fuse(StreamLayout.Module that, OutPort from, InPort to)
static <A,B,C> StreamLayout.Module	fuse(StreamLayout.Module that, OutPort from, InPort to, scala.Function2<A,B,C> f)
static int	hashCode()
static scala.collection.immutable.Set<InPort>	inPorts()
static boolean	isAtomic()
static boolean	isBidiFlow()
static boolean	isCopied()
static boolean	isFlow()
static boolean	isFused()
static boolean	isRunnable()
static boolean	isSealed()
static boolean	isSink()
static boolean	isSource()
static StreamLayout.MaterializedValueNode	materializedValueComputation()
static scala.collection.immutable.Set<OutPort>	outPorts()
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
StreamLayout.Module	replaceShape(Shape s) Verify that the given Shape has the same ports and return a new module with that shape.
Shape	shape()
GraphStageWithMaterializedValue<Shape,java.lang.Object>	stage()
static scala.collection.immutable.Set<StreamLayout.Module>	subModules()
java.lang.String	toString()
static StreamLayout.Module	transformMaterializedValue(scala.Function1<java.lang.Object,java.lang.Object> f)
static scala.collection.immutable.Map<InPort,OutPort>	upstreams()
static StreamLayout.Module	wire(OutPort from, InPort to)
StreamLayout.Module	withAttributes(Attributes attributes)

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 scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

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

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

Constructor Detail

GraphStageModule

public GraphStageModule(Shape shape,
                        Attributes attributes,
                        GraphStageWithMaterializedValue<Shape,java.lang.Object> stage)

Method Detail

isRunnable

public static boolean isRunnable()

isSink

public static final boolean isSink()

isSource

public static final boolean isSource()

isFlow

public static final boolean isFlow()

isBidiFlow

public static final boolean isBidiFlow()

isAtomic

public static boolean isAtomic()

isCopied

public static boolean isCopied()

isFused

public static boolean isFused()

fuse

public static final StreamLayout.Module fuse(StreamLayout.Module that,
                                             OutPort from,
                                             InPort to)

fuse

public static final <A,B,C> StreamLayout.Module fuse(StreamLayout.Module that,
                                                     OutPort from,
                                                     InPort to,
                                                     scala.Function2<A,B,C> f)

wire

public static final StreamLayout.Module wire(OutPort from,
                                             InPort to)

transformMaterializedValue

public static final StreamLayout.Module transformMaterializedValue(scala.Function1<java.lang.Object,java.lang.Object> f)

compose

public static StreamLayout.Module compose(StreamLayout.Module that)

compose

public static <A,B,C> StreamLayout.Module compose(StreamLayout.Module that,
                                                  scala.Function2<A,B,C> f)

composeNoMat

public static StreamLayout.Module composeNoMat(StreamLayout.Module that)

isSealed

public static final boolean isSealed()

materializedValueComputation

public static StreamLayout.MaterializedValueNode materializedValueComputation()

hashCode

public static final int hashCode()

equals

public static final boolean equals(java.lang.Object obj)

subModules

public static final scala.collection.immutable.Set<StreamLayout.Module> subModules()

downstreams

public static final scala.collection.immutable.Map<OutPort,InPort> downstreams()

upstreams

public static final scala.collection.immutable.Map<InPort,OutPort> upstreams()

inPorts

public static final scala.collection.immutable.Set<InPort> inPorts()

outPorts

public static final scala.collection.immutable.Set<OutPort> outPorts()

canEqual

public abstract static boolean canEqual(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

shape

public Shape shape()

Specified by:

shape in interface StreamLayout.Module

attributes

public Attributes attributes()

Specified by:

attributes in interface StreamLayout.Module

stage

public GraphStageWithMaterializedValue<Shape,java.lang.Object> stage()

carbonCopy

public StreamLayout.Module 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’s shape.

Specified by:

carbonCopy in interface StreamLayout.Module

Returns:

(undocumented)

replaceShape

public StreamLayout.Module 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.

Specified by:

replaceShape in interface StreamLayout.Module

Parameters:

s - (undocumented)

Returns:

(undocumented)

withAttributes

public StreamLayout.Module withAttributes(Attributes attributes)

Specified by:

withAttributes in interface StreamLayout.Module

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object