Package org.apache.pekko.stream

Class BidiShape<In1,Out1,In2,Out2>

java.lang.Object

org.apache.pekko.stream.Shape

org.apache.pekko.stream.BidiShape<In1,Out1,In2,Out2>

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

public final class BidiShape<In1,Out1,In2,Out2>
extends Shape
implements scala.Product, 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	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	Description
static <In1, Out1, In2, Out2> BidiShape<In1,Out1,In2,Out2>	apply(Inlet<In1> in1, Outlet<Out1> out1, Inlet<In2> in2, Outlet<Out2> out2)
boolean	canEqual(Object x$1)
<In1, Out1, In2, Out2> BidiShape<In1,Out1,In2,Out2>	copy(Inlet<In1> in1, Outlet<Out1> out1, Inlet<In2> in2, Outlet<Out2> out2)
<In1, Out1, In2, Out2> Inlet<In1>	copy$default$1()
<In1, Out1, In2, Out2> Outlet<Out1>	copy$default$2()
<In1, Out1, In2, Out2> Inlet<In2>	copy$default$3()
<In1, Out1, In2, Out2> Outlet<Out2>	copy$default$4()
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.
boolean	equals(Object x$1)
static <I1, O1, I2, O2> BidiShape<I1,O1,I2,O2>	fromFlows(FlowShape<I1,O1> top, FlowShape<I2,O2> bottom)
int	hashCode()
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
int	productArity()
Object	productElement(int x$1)
String	productElementName(int x$1)
scala.collection.Iterator<Object>	productIterator()
String	productPrefix()
String	toString()
static <In1, Out1, In2, Out2> scala.Option<scala.Tuple4<Inlet<In1>,Outlet<Out1>,Inlet<In2>,Outlet<Out2>>>	unapply(BidiShape<In1,Out1,In2,Out2> x$0)

Methods inherited from class org.apache.pekko.stream.Shape

getInlets, getOutlets, hasOnePort, hasSamePortsAndShapeAs, hasSamePortsAs, requireSamePortsAndShapeAs, requireSamePortsAs

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Product

productElementNames

Constructor Details

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.

Method Details

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

apply

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

unapply

public static <In1,
Out1,
In2,
Out2>
scala.Option<scala.Tuple4<Inlet<In1>,Outlet<Out1>,Inlet<In2>,Outlet<Out2>>> unapply(BidiShape<In1,Out1,In2,Out2> x$0)

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

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

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

copy

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

copy$default$1

public <In1,
Out1,
In2,
Out2> Inlet<In1> copy$default$1()

copy$default$2

public <In1,
Out1,
In2,
Out2> Outlet<Out1> copy$default$2()

copy$default$3

public <In1,
Out1,
In2,
Out2> Inlet<In2> copy$default$3()

copy$default$4

public <In1,
Out1,
In2,
Out2> Outlet<Out2> copy$default$4()

productPrefix

public String productPrefix()

Specified by:

productPrefix in interface scala.Product

productArity

public int productArity()

Specified by:

productArity in interface scala.Product

productElement

public Object productElement(int x$1)

Specified by:

productElement in interface scala.Product

productIterator

public scala.collection.Iterator<Object> productIterator()

Specified by:

productIterator in interface scala.Product

canEqual

public boolean canEqual(Object x$1)

Specified by:

canEqual in interface scala.Equals

productElementName

public String productElementName(int x$1)

Specified by:

productElementName in interface scala.Product

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object x$1)

Specified by:

equals in interface scala.Equals

Overrides:

equals in class Object