Package nz.org.riskscape.rl.ast

Class GenericArgument<T extends AST>

java.lang.Object
nz.org.riskscape.rl.ast.GenericArgument<T>
All Implemented Interfaces:
AST
Direct Known Subclasses:
FunctionCall.Argument, StepDefinition.Argument
public class GenericArgument<T extends AST> extends Object

  • Constructor Details

    • GenericArgument

      public GenericArgument(T value, Optional<Token> nameToken)

      Creates a new GenericArgument instance.

      Parameters:
      value - The value of this argument, e.g. the non-keyword part of it.
      nameToken -

  • Method Details

    • getName

      public Optional<String> getName()

    • appendSource

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

    • isKeywordArgument

      public boolean isKeywordArgument()
      Returns:
      if this argument has a keyword, e.g. foo(bar: baz) vs foo(baz)

    • getBoundary

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

    • equals

      public boolean equals(Object obj)

    • hashCode

      public int hashCode()

    • getValue

      public T getValue()

      The value of this argument, e.g. the non-keyword part of it.

    • getNameToken

      public Optional<Token> getNameToken()

    • 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

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

    • 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