Package nz.org.riskscape.rl.ast

Class StepDefinition

java.lang.Object

nz.org.riskscape.rl.ast.StepDeclaration

nz.org.riskscape.rl.ast.StepDefinition

All Implemented Interfaces:

AST, PipelineAST

public class StepDefinition
extends StepDeclaration

Defines a step. May optionally include parameter defaults and name for the step.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StepDefinition.Argument

Field Summary

Fields inherited from class nz.org.riskscape.rl.ast.StepDeclaration

identToken, namedInputToken

Constructor Summary

Constructors

Constructor	Description
StepDefinition(String id)
StepDefinition(Token identifier, List<StepDefinition.Argument> arguments, Optional<Token> nameToken, Optional<Token> namedInputToken, Optional<Pair<Token,Token>> boundary)

Method Summary

Modifier and Type	Method	Description
<T, R> R	accept(PipelineVisitor<T,R> visitor, T data)
protected void	appendSource(StringBuilder appendTo)	Implementers extend this to append their source to the given string builder.
protected static void	appendSource(AST ast, StringBuilder appendTo)	Helper method for appending the source of another ast element to a string builder, efficiently if possible.
protected void	appendString(StringBuilder appendTo)	Append a simplified string representation to the builder.
boolean	equals(Object o)
@NonNull List<StepDefinition.Argument>	getArguments()
@NonNull Optional<Pair<Token,Token>>	getBoundary()
List<StepReference>	getInputChainStepReferences()	Collects all the StepReferences from any arguments via InputChain.getStepReferences()
Optional<String>	getName()
@NonNull Optional<Token>	getNameToken()
String	getStepId()
Token	getStepIdToken()
List<StepDefinition.Argument>	getStepParameters()
int	hashCode()
final String	toSource()
final String	toString()	Returns a simplified view of the ast in a source-like fashion, but with a lot of details left out for conciseness

Methods inherited from class nz.org.riskscape.rl.ast.StepDeclaration

canEqual, getIdent, getIdentToken, getNamedInput, getNamedInputToken

Methods inherited from class java.lang.Object

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

Methods inherited from interface nz.org.riskscape.rl.ast.AST

isA, switchType, toSource

Constructor Details

StepDefinition

public StepDefinition(String id)

StepDefinition

public StepDefinition(Token identifier,
 List<StepDefinition.Argument> arguments,
 Optional<Token> nameToken,
 Optional<Token> namedInputToken,
 Optional<Pair<Token,Token>> boundary)

Method Details

getStepId

public String getStepId()

Returns:

an identifier used to link the step definition to a Step that the engine provides for pipeline processing

getName

public Optional<String> getName()

Returns:

a name that the user assigned to this step definition, or empty if the step is anonymous

getStepParameters

public List<StepDefinition.Argument> getStepParameters()

getStepIdToken

public Token getStepIdToken()

Returns:

the ast token for the identifier used to link the step definition to a Step that the engine provides for pipeline processing

appendSource

protected void appendSource(StringBuilder appendTo)

Implementers extend this to append their source to the given string builder. Done via string builder to encourage a more efficient implementation than is possible with concatenating multiple toString calls that typically contruct a string builder anyway.

appendString

protected void appendString(StringBuilder appendTo)

Append a simplified string representation to the builder. Default implementation uses appendSource. Subclasses can override to provide a more concise representation.

equals

public boolean equals(Object o)

Overrides:

equals in class StepDeclaration

hashCode

public int hashCode()

Overrides:

hashCode in class StepDeclaration

accept

public <T,
R> R accept(PipelineVisitor<T,R> visitor,
 T data)

getInputChainStepReferences

public List<StepReference> getInputChainStepReferences()

Collects all the StepReferences from any arguments via InputChain.getStepReferences()

getArguments

@NonNull
public @NonNull List<StepDefinition.Argument> getArguments()

getNameToken

@NonNull
public @NonNull Optional<Token> getNameToken()

getBoundary

@NonNull
public @NonNull Optional<Pair<Token,Token>> getBoundary()

Returns:

a pair of tokens that represent the start and end of this expression, to be used when giving users information about where errors have occurred. If the expression has been rebuilt then the boundary may be empty or it may be from the original AST. Intended for use in problems to trace errors back to their source.

appendSource

protected static void appendSource(AST ast,
 StringBuilder appendTo)

Helper method for appending the source of another ast element to a string builder, efficiently if possible.

toString

public final String toString()

Returns a simplified view of the ast in a source-like fashion, but with a lot of details left out for conciseness

Overrides:

toString in class Object

toSource

public final String toSource()

Specified by:

toSource in interface AST

Returns:

a normalized version of the AST that can be parsed to be exactly the same AST as this