Module com.darkcollective.relix.ast
Package com.darkcollective.relix.ast

Record Class ParameterOperand

java.lang.Object
java.lang.Record
com.darkcollective.relix.ast.ParameterOperand
Record Components:
name - the parameter's name, without the $; an identifier
location - the source location of this operand; never null
All Implemented Interfaces:
Operand
public record ParameterOperand(String name, SourceLocation location) extends Record implements Operand
A bound query parameter, $name: a scalar whose value is supplied from outside the query text when it runs.

The value is never part of the expression. Printing the tree prints $name, a query pushed to a database sends it as a bind parameter, and so no value — a string holding a quote included — can change what the query means. A parameter is matched by name ignoring case, as a column is.

  • Constructor Details

    • ParameterOperand

      public ParameterOperand(String name, SourceLocation location)
      Creates an instance of a ParameterOperand record class.
      Parameters:
      name - the value for the name record component
      location - the value for the location record component

    • ParameterOperand

      public ParameterOperand(String name)
      Convenience constructor for tests; uses SourceLocation.UNKNOWN.

  • Method Details

    • accept

      public <R> R accept(OperandVisitor<R> visitor)
      Specified by:
      accept in interface Operand

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • location

      public SourceLocation location()
      Returns the value of the location record component.
      Specified by:
      location in interface Operand
      Returns:
      the value of the location record component