Module org.praxislive.core

Package org.praxislive.core

Class PortInfo

java.lang.Object

org.praxislive.core.Value

org.praxislive.core.types.PMap.MapBasedValue

org.praxislive.core.PortInfo

public final class PortInfo
extends PMap.MapBasedValue

Information on the type, direction and properties for a Port.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PortInfo.Direction	Port direction.

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	KEY_DIRECTION	Map key for the port direction.
static final String	KEY_TYPE	Map key for port type name.
static final String	TYPE_NAME	Value type name.

Method Summary

Modifier and Type	Method	Description
static PortInfo	create(Class<? extends Port> typeClass, PortInfo.Direction direction, PMap properties)	Create a PortInfo.
PortInfo.Direction	direction()	The direction of the port.
static Optional<PortInfo>	from(Value arg)	Coerce the provided Value into a PortInfo if possible.
static PortInfo	parse(String string)	Parse the provided String into a PortInfo if possible.
String	portType()	The type of the port.
PMap	properties()	Access the map of properties.

Methods inherited from class org.praxislive.core.types.PMap.MapBasedValue

dataMap, 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

KEY_TYPE

public static final String KEY_TYPE

Map key for port type name. Value should be the String from Port.Type.name().

See Also:

• Constant Field Values

KEY_DIRECTION

public static final String KEY_DIRECTION

Map key for the port direction.

See Also:

• Constant Field Values

Method Details

portType

public String portType()

The type of the port.

Returns:

port type

direction

public PortInfo.Direction direction()

The direction of the port.

Returns:

port direction

properties

public PMap properties()

Access the map of properties. The map includes the type and direction, as well as any custom or optional properties.

This method is equivalent to calling PMap.MapBasedValue.dataMap().

Returns:

property map

create

public static PortInfo create(Class<? extends Port> typeClass,
 PortInfo.Direction direction,
 PMap properties)

Create a PortInfo.

Parameters:

typeClass - port base class

direction - port direction

properties - additional properties (may be null)

Returns:

port info

from

public static Optional<PortInfo> from(Value arg)

Coerce the provided Value into a PortInfo if possible.

Parameters:

arg - value of unknown type

Returns:

port info or empty optional

parse

public static PortInfo parse(String string)
                      throws ValueFormatException

Parse the provided String into a PortInfo if possible.

Parameters:

string - text to parse

Returns:

port info

Throws:

ValueFormatException - if parsing fails