Module org.praxislive.core

Package org.praxislive.core

Class Connection

java.lang.Object

org.praxislive.core.Value

org.praxislive.core.types.PArray.ArrayBasedValue

org.praxislive.core.Connection

public final class Connection
extends PArray.ArrayBasedValue

A type representing a connection between two ports.

Nested Class Summary

Nested classes/interfaces inherited from class org.praxislive.core.Value

Value.Type<T extends Value>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_NAME	Value type name.

Method Summary

Modifier and Type	Method	Description
static Optional<Connection>	from(Value value)	Coerce the provided value into a Connection if possible.
static Connection	of(String child1, String port1, String child2, String port2)	Create a connection reference.
String	sourceComponent()	Query the component ID of the source component.
String	sourcePort()	Query the port ID of the source port.
String	targetComponent()	Query the component ID of the target component.
String	targetPort()	Query the port ID of the target port.

Methods inherited from class org.praxislive.core.types.PArray.ArrayBasedValue

dataArray, equals, equivalent, hashCode, toString

Methods inherited from class org.praxislive.core.Value

info, isEmpty, ofObject, type

Methods inherited from class java.lang.Object

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

Field Details

TYPE_NAME

public static final String TYPE_NAME

Value type name.

See Also:

• Constant Field Values

Method Details

sourceComponent

public String sourceComponent()

Query the component ID of the source component.

Returns:

ID of first child

sourcePort

public String sourcePort()

Query the port ID of the source port.

Returns:

ID of port on first child

targetComponent

public String targetComponent()

Query the component ID of the target component.

Returns:

ID of the second child

targetPort

public String targetPort()

Query the port ID of the target port.

Returns:

ID of port on second child

of

public static Connection of(String child1,
 String port1,
 String child2,
 String port2)

Create a connection reference. The child IDs must be valid according to ComponentAddress.isValidID(java.lang.String). The port IDs must be valid according to PortAddress.isValidID(java.lang.String).

Parameters:

child1 - ID of first child

port1 - ID of port on first child

child2 - ID of second child

port2 - ID of port on second child

Returns:

new connection

Throws:

IllegalArgumentException - if the IDs are not valid

from

public static Optional<Connection> from(Value value)

Coerce the provided value into a Connection if possible.

Parameters:

value - value of unknown type

Returns:

connection or empty optional