akka.stream

Class BidiShape<In1,Out1,In2,Out2>

java.lang.Object

akka.stream.Shape

akka.stream.BidiShape<In1,Out1,In2,Out2>

All Implemented Interfaces:

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

public final class BidiShape<In1,Out1,In2,Out2>
extends Shape
implements scala.Product, scala.Serializable

A bidirectional flow of elements that consequently has two inputs and two outputs, arranged like this:

        +------+
  In1 ~>|      |~> Out1
        | bidi |
 Out2 <~|      |<~ In2
        +------+
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BidiShape(FlowShape<In1,Out1> top, FlowShape<In2,Out2> bottom) Java API for creating from a pair of unidirectional flows.
BidiShape(Inlet<In1> in1, Outlet<Out1> out1, Inlet<In2> in2, Outlet<Out2> out2)

Method Summary

Modifier and Type	Method and Description
abstract static boolean	canEqual(java.lang.Object that)
Shape	copyFromPorts(scala.collection.immutable.Seq<Inlet<?>> inlets, scala.collection.immutable.Seq<Outlet<?>> outlets) Create a copy of this Shape object, returning the same type as the original but containing the ports given within the passed-in Shape.
BidiShape<In1,Out1,In2,Out2>	deepCopy() Create a copy of this Shape object, returning the same type as the original; this constraint can unfortunately not be expressed in the type system.
abstract static boolean	equals(java.lang.Object that)
static <I1,O1,I2,O2> BidiShape<I1,O1,I2,O2>	fromFlows(FlowShape<I1,O1> top, FlowShape<I2,O2> bottom)
static java.util.List<Inlet<?>>	getInlets()
static java.util.List<Outlet<?>>	getOutlets()
static boolean	hasSamePortsAndShapeAs(Shape s)
static boolean	hasSamePortsAs(Shape s)
Inlet<In1>	in1()
Inlet<In2>	in2()
scala.collection.immutable.Seq<Inlet<?>>	inlets() Scala API: get a list of all input ports
static <In1,Out1,In2,Out2> BidiShape<In1,Out1,In2,Out2>	of(Inlet<In1> in1, Outlet<Out1> out1, Inlet<In2> in2, Outlet<Out2> out2) Java API
Outlet<Out1>	out1()
Outlet<Out2>	out2()
scala.collection.immutable.Seq<Outlet<?>>	outlets() Scala API: get a list of all output ports
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()
static void	requireSamePortsAndShapeAs(Shape s)
static void	requireSamePortsAs(Shape s)
Shape	reversed()

Methods inherited from class akka.stream.Shape

getInlets, getOutlets, hasSamePortsAndShapeAs, hasSamePortsAs, requireSamePortsAndShapeAs, requireSamePortsAs

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

BidiShape

public BidiShape(Inlet<In1> in1,
                 Outlet<Out1> out1,
                 Inlet<In2> in2,
                 Outlet<Out2> out2)

BidiShape

public BidiShape(FlowShape<In1,Out1> top,
                 FlowShape<In2,Out2> bottom)

Java API for creating from a pair of unidirectional flows.

Parameters:

top - (undocumented)

bottom - (undocumented)

Method Detail

fromFlows

public static <I1,O1,I2,O2> BidiShape<I1,O1,I2,O2> fromFlows(FlowShape<I1,O1> top,
                                                             FlowShape<I2,O2> bottom)

of

public static <In1,Out1,In2,Out2> BidiShape<In1,Out1,In2,Out2> of(Inlet<In1> in1,
                                                                  Outlet<Out1> out1,
                                                                  Inlet<In2> in2,
                                                                  Outlet<Out2> out2)

Java API

getInlets

public static java.util.List<Inlet<?>> getInlets()

getOutlets

public static java.util.List<Outlet<?>> getOutlets()

hasSamePortsAs

public static boolean hasSamePortsAs(Shape s)

hasSamePortsAndShapeAs

public static boolean hasSamePortsAndShapeAs(Shape s)

requireSamePortsAs

public static void requireSamePortsAs(Shape s)

requireSamePortsAndShapeAs

public static void requireSamePortsAndShapeAs(Shape s)

canEqual

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

equals

public abstract static boolean equals(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()

in1

public Inlet<In1> in1()

out1

public Outlet<Out1> out1()

in2

public Inlet<In2> in2()

out2

public Outlet<Out2> out2()

inlets

public scala.collection.immutable.Seq<Inlet<?>> inlets()

Description copied from class: Shape

Scala API: get a list of all input ports

Specified by:

inlets in class Shape

Returns:

(undocumented)

outlets

public scala.collection.immutable.Seq<Outlet<?>> outlets()

Description copied from class: Shape

Scala API: get a list of all output ports

Specified by:

outlets in class Shape

Returns:

(undocumented)

deepCopy

public BidiShape<In1,Out1,In2,Out2> deepCopy()

Description copied from class: Shape

Create a copy of this Shape object, returning the same type as the original; this constraint can unfortunately not be expressed in the type system.

Specified by:

deepCopy in class Shape

Returns:

(undocumented)

copyFromPorts

public Shape copyFromPorts(scala.collection.immutable.Seq<Inlet<?>> inlets,
                           scala.collection.immutable.Seq<Outlet<?>> outlets)

Description copied from class: Shape

Create a copy of this Shape object, returning the same type as the original but containing the ports given within the passed-in Shape.

Specified by:

copyFromPorts in class Shape

Parameters:

inlets - (undocumented)

outlets - (undocumented)

Returns:

(undocumented)

reversed

public Shape reversed()