Module org.praxislive.project

Package org.praxislive.project

Class GraphElement

java.lang.Object

org.praxislive.project.GraphElement

Direct Known Subclasses:

GraphElement.Command, GraphElement.Comment, GraphElement.Component, GraphElement.Connection, GraphElement.Property

public abstract sealed class GraphElement
extends Object
permits GraphElement.Component, GraphElement.Command, GraphElement.Comment, GraphElement.Property, GraphElement.Connection

Elements of a graph tree.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GraphElement.Command
static final class	GraphElement.Comment
static class	GraphElement.Component	A component element.
static final class	GraphElement.Connection
static final class	GraphElement.Property
static final class	GraphElement.Root	A root component element.

Method Summary

Modifier and Type	Method	Description
static GraphElement.Command	command(String command)	Create a Command element from the given script line.
static GraphElement.Comment	comment(String text)	Create a Comment element from the given text.
static GraphElement.Connection	connection(String sourceComponent, String sourcePort, String targetComponent, String targetPort)	Create a Connection element between the given source component ID and port ID, and target component ID and port ID.
static GraphElement.Property	property(org.praxislive.core.Value value)	Create a property element of the given value.

Methods inherited from class java.lang.Object

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

Method Details

command

public static GraphElement.Command command(String command)

Create a Command element from the given script line. The command must be a single line of script with a plain first token.

Parameters:

command - script line

Returns:

command element

Throws:

IllegalArgumentException - if the command fails to parse according to the rules

comment

public static GraphElement.Comment comment(String text)

Create a Comment element from the given text.

Parameters:

text - comment text

Returns:

comment element

connection

public static GraphElement.Connection connection(String sourceComponent,
 String sourcePort,
 String targetComponent,
 String targetPort)

Create a Connection element between the given source component ID and port ID, and target component ID and port ID.

Parameters:

sourceComponent - source component ID

sourcePort - source port ID

targetComponent - target component ID

targetPort - target port ID

Returns:

connection element

property

public static GraphElement.Property property(org.praxislive.core.Value value)

Create a property element of the given value.

Parameters:

value - property value

Returns:

property element