Module io.jenetics.ext
Package io.jenetics.ext.rewriting

Record Class TreePattern.Var<V>

java.lang.Object
java.lang.Record
io.jenetics.ext.rewriting.TreePattern.Var<V>
Type Parameters:
V - the node type the tree-pattern is working on
All Implemented Interfaces:
TreePattern.Decl<V>, Serializable, Comparable<TreePattern.Var<V>>
Enclosing class:
TreePattern<V>
public static record TreePattern.Var<V>(String name) extends Record implements TreePattern.Decl<V>, Comparable<TreePattern.Var<V>>, Serializable
Represents a placeholder (variable) for an arbitrary subtree. A pattern variable is identified by its name. The pattern DSL denotes variable names with a leading '$' character, e.g. $x, $y or $my_var.
See Also:
Implementation Note:
This class is comparable by its name.

  • Constructor Details

    • Var

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

  • Method Details

    • map

      public <B> TreePattern.Var<B> map(Function<? super V,? extends B> mapper)
      Description copied from interface: TreePattern.Decl
      Returns a new TreePattern.Decl object with the mapped type B.
      Specified by:
      map in interface TreePattern.Decl<V>
      Type Parameters:
      B - the mapped type
      Parameters:
      mapper - the mapping function
      Returns:
      the mapped declaration

    • compareTo

      public int compareTo(TreePattern.Var<V> var)
      Specified by:
      compareTo in interface Comparable<V>

    • toString

      public 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