Class PipelineDeclaration

Method Details

• getBoundary

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

• findDefinition

  public Optional<PipelineDeclaration.Found> findDefinition(@NonNull @NonNull String stepName)

  Search through for the definition of a step with the given name, using either the step id or alias

  Parameters:

  stepName - name (id or alias) of a step to look for

  Returns:

  the first found declaration of the found step, along with the step chain that it was found in, or empty if nothing was found

• find

  public Optional<PipelineDeclaration.Found> find(Predicate<StepDeclaration> predicate)

  Convenience version of find(BiPredicate) that drops the chain from the predicate

• find

  public Optional<PipelineDeclaration.Found> find(BiPredicate<StepChain,StepDeclaration> predicate)

  General purpose step-finding method. Find a step using a predicate, returning the first step that matches (in ast order).

  Parameters:

  predicate - test each step against this predicate

  Returns:

  the first step (and chain) that matched, or empty if nothing found.

• findAll

  public List<PipelineDeclaration.Found> findAll(BiPredicate<StepChain,StepDeclaration> predicate)

  General purpose step-finding method. Find a list of steps using a predicate, returning all steps that match (in ast order).

  Parameters:

  predicate - test each step against this predicate

  Returns:

  a list of PipelineDeclaration.Found objects for the steps that matched the predicate

• replace

  public PipelineDeclaration replace(@NonNull @NonNull StepChain found, @NonNull @NonNull StepChain newChain) throws IllegalStateException

  Return a new PipelineDeclaration, with a replacement step chain

  Parameters:

  found - the step chain to replace

  newChain - the replacement chain

  Returns:

  a new PipelineDeclaration with the replacement made

  Throws:

  IllegalStateException - if found is not part of this pipeline declaration

• findParameters

  public Map<ParameterToken,List<StepDefinition>> findParameters()

• replaceParameters

  public Pair<PipelineDeclaration,List<ParameterToken>> replaceParameters(Map<ParameterToken,Expression> replacements)

  Builds a new PipelineDeclaration by replacing tokens with those specified

  Parameters:

  replacements - parameter tokens mapped to replacement expressions.

  Returns:

  a new PipelineDeclaration, as well as a list of all the parameter tokens found in the pipeline declaration that were not replaced. As long as the original pipeline has been parsed (rather than built programmatically) these tokens can be used to report errors, along with locations, back to the user.

• add

  public PipelineDeclaration add(@NonNull @NonNull StepChain toAdd)

  Return a new PipelineDeclaration with the given step chain added to the end of this PipelineDeclaration's list of chains

  Parameters:

  toAdd - the chain to add

  Returns:

  a new PipelineDeclaration containing the given chain

• add

  public PipelineDeclaration add(PipelineDeclaration toAdd)

  Return a new PipelineDeclaration that is the combination of this pipeline and the other - no merge or squishing or anything clever is going on

• getFirst

  public StepChain getFirst()

  Returns:

  the 0th chain in this declaration

  Throws:

  IndexOutOfBoundsException - if this declaration is empty

• getLast

  public StepChain getLast()

  Returns:

  the last chain in this declaration

  Throws:

  IndexOutOfBoundsException - if this declaration is empty

• isEmpty

  public boolean isEmpty()

  Returns:

  true if this declaration has no chains

• appendString

  protected void appendString(StringBuilder appendTo)

• appendSource

  protected void appendSource(StringBuilder appendTo)

• stepDefinitionIterator

  public Iterator<StepDefinition> stepDefinitionIterator()

  Returns:

  an Iterator that yields all of the StepDefinitions in this pipeline declaration in the order they appear in the source. Skips all the StepReferences.

• size

  public int size()

  Returns:

  the number of chains (not steps) in this pipeline declaration

• getStepNameFunction

  public Function<StepDeclaration,String> getStepNameFunction(StepNamingPolicy policy)

  Parameters:

  policy - the step naming policy that will be applied

  Returns:

  a function that gives the name for a step definition, returning either a unique generated name, if none was assigned, or the explicitly assigned name

• checkValid

  public ResultOrProblems<PipelineDeclaration> checkValid(Function<StepDeclaration,String> nameFunction)

  Check that this PipelineDeclaration is valid. This check includes checking for step redefinition and pipeline cycles.

  Parameters:

  nameFunction - maps a StepDefinition to a name, see getStepNameFunction(StepNamingPolicy)

  Returns:

  function that provides step names for this pipeline or errors found

• equals

  public boolean equals(Object o)

• canEqual

  protected boolean canEqual(Object other)

• hashCode

  public int hashCode()

• getChains

  public List<StepChain> getChains()

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