Module org.praxislive.project

Package org.praxislive.project

Class GraphBuilder.Root

java.lang.Object

org.praxislive.project.GraphBuilder.Base<GraphBuilder.Root>

org.praxislive.project.GraphBuilder.Root

Enclosing class:

GraphBuilder

public static final class GraphBuilder.Root
extends GraphBuilder.Base<GraphBuilder.Root>

Root element builder.

Method Summary

Modifier and Type	Method	Description
GraphElement.Root	build()	Build a root element from this builder.
GraphBuilder.Root	clearCommands()	Clear the existing commands.
GraphBuilder.Root	command(String command)	Add a command element.
GraphBuilder.Root	command(GraphElement.Command command)	Add a command element.
List<GraphElement.Command>	commands()	Immutable snapshot of commands.
String	id()	Root ID.
boolean	isSynthetic()	Query whether the root is synthetic.
GraphBuilder.Root	property(String id, GraphElement.Property property)	Add a property element.
GraphBuilder.Root	transformCommands(Function<Stream<GraphElement.Command>,List<GraphElement.Command>> transform)	Transform the existing commands.

Methods inherited from class org.praxislive.project.GraphBuilder.Base

child, child, children, clearChildren, clearComments, clearConnections, clearProperties, comment, comment, comments, connection, connection, connections, properties, property, transformChildren, transformComments, transformConnections, transformProperties, type

Methods inherited from class java.lang.Object

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

Method Details

command

public GraphBuilder.Root command(GraphElement.Command command)

Add a command element.

Parameters:

command - command element

Returns:

this

command

public GraphBuilder.Root command(String command)

Add a command element.

Parameters:

command - command line

Returns:

this

clearCommands

public GraphBuilder.Root clearCommands()

Clear the existing commands.

Returns:

this

property

public GraphBuilder.Root property(String id,
 GraphElement.Property property)

Description copied from class: GraphBuilder.Base

Add a property element.

Overrides:

property in class GraphBuilder.Base<GraphBuilder.Root>

Parameters:

id - property ID

property - property element

Returns:

this

transformCommands

public GraphBuilder.Root transformCommands(Function<Stream<GraphElement.Command>,List<GraphElement.Command>> transform)

Transform the existing commands. The transform function is called with a stream of the existing command elements, and should return a list of desired command elements. The returned list will be used to replace the existing commands.

Parameters:

transform - command transform function

Returns:

this

commands

public List<GraphElement.Command> commands()

Immutable snapshot of commands.

Returns:

commands

id

public String id()

Root ID.

Returns:

id

isSynthetic

public boolean isSynthetic()

Query whether the root is synthetic.

Returns:

true if synthetic

build

public GraphElement.Root build()

Build a root element from this builder.

Returns:

created root element