Package nz.org.riskscape.rl.ast

Class ParameterToken

java.lang.Object
nz.org.riskscape.rl.ast.ParameterToken
All Implemented Interfaces:
AST, Expression
public class ParameterToken extends Object

Represents an unresolved expression within a larger expression. Here to facilitate AST-aware substitutions in expressions, e.g. input(relation: $some_bookmark_id)

  • Constructor Details

    • ParameterToken

      public ParameterToken(Token token)

  • Method Details

    • named

      public static ParameterToken named(String name)

      AST-less constructor

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

    • getValue

      public String getValue()
      Returns:
      the name of the token without the $, e.g. $foo_bar becomes foo_bar

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

    • accept

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

    • isLiteral

      public boolean isLiteral()
      Description copied from interface: Expression

      Tests whether this expression is a literal expression - a literal expression is a constant expression that is unaffected by the scope in which it was realized/evaluated and contains no function-defined behaviour. Therefore a literal expression is one that contains no property access (unless the receiver is a literal) and no function calls.

      A literal expression will always realize to being a constant (e.g. RealizedExpression.isConstant() will return true), however there are constant expressions that are not literal.

      One edge case to be aware of is a limitation of the AST in determining literal expressions in contrived cases like this one - {foo: 'bar', baz: qux}.foo. The struct is not literal, but the property being accessed is. But because the AST is relatively 'dumb', the expression itself is not literal. It can, however, be realized as a constant - realization is 'smarter' and can pick out the that the property being accessed is constant.

    • equals

      public boolean equals(Object o)

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()

    • getToken

      public Token getToken()

    • 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