Package nz.org.riskscape.pipeline.ast

Class StepDefinition

java.lang.Object

nz.org.riskscape.pipeline.ast.StepDeclaration

nz.org.riskscape.pipeline.ast.StepDefinition

All Implemented Interfaces:

PipelineExpression

public class StepDefinition
extends StepDeclaration

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

Field Summary

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

identToken, namedInputToken

Constructor Summary

Constructors

Constructor	Description
StepDefinition(String id)
StepDefinition(FunctionCall fc, Optional<Token> nameToken, Optional<Token> namedInputToken)

Method Summary

Modifier and Type	Method	Description
protected void	appendSource(StringBuilder appendTo)
protected void	appendString(StringBuilder appendTo)
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Optional<Pair<Token,Token>>	getBoundary()
Optional<String>	getName()
@NonNull Optional<Token>	getNameToken()
FunctionCall	getStep()
String	getStepId()
Token	getStepIdToken()
List<FunctionCall.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.pipeline.ast.StepDeclaration

getIdent, getIdentToken, getNamedInput, getNamedInputToken, isA

Methods inherited from class java.lang.Object

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

Constructor Details

StepDefinition

public StepDefinition(String id)

StepDefinition

public StepDefinition(FunctionCall fc,
 Optional<Token> nameToken,
 Optional<Token> namedInputToken)

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<FunctionCall.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

getBoundary

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

appendSource

protected void appendSource(StringBuilder appendTo)

appendString

protected void appendString(StringBuilder appendTo)

equals

public boolean equals(Object o)

Overrides:

equals in class StepDeclaration

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class StepDeclaration

hashCode

public int hashCode()

Overrides:

hashCode in class StepDeclaration

getStep

public FunctionCall getStep()

getNameToken

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

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 PipelineExpression

Returns:

a string that can be parsed back in to the same ast as this one. It might not be whitespace-faithful...