Module io.jenetics.ext
Package io.jenetics.ext.grammar

Record Class Cfg.Terminal<T>

java.lang.Object
java.lang.Record
io.jenetics.ext.grammar.Cfg.Terminal<T>
Type Parameters:
T - the terminal symbol value type
All Implemented Interfaces:
Cfg.Annotatable<T>, Cfg.Element<T>, Cfg.Symbol<T>
Enclosing class:
Cfg<T>
public static record Cfg.Terminal<T>(String name, T value, Object annotation) extends Record implements Cfg.Symbol<T>
Represents a terminal symbols of the grammar (T).

  • Constructor Summary

    Constructors
    Constructor
    Description
    Terminal(String name, T value)
     
    Terminal(String name, T value, Object annotation)
    Creates an instance of a Terminal record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    annotation()
    Returns the value of the annotation record component.
    Cfg.Terminal<T>
    at(Object annotation)
    Create a new copy of the CFG element, with the given annotation.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    static Cfg.Terminal<String>
    of(String name)
    Return a new terminal symbol where the name of the symbol is equal to its value.
    final String
    toString()
    Returns a string representation of this record class.
    T
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Terminal

      public Terminal(String name, T value, Object annotation)
      Creates an instance of a Terminal record class.
      Parameters:
      name - the value for the name record component
      value - the value for the value record component
      annotation - the value for the annotation record component

    • Terminal

      public Terminal(String name, T value)

  • Method Details

    • at

      public Cfg.Terminal<T> at(Object annotation)
      Description copied from interface: Cfg.Annotatable
      Create a new copy of the CFG element, with the given annotation.
      Specified by:
      at in interface Cfg.Annotatable<T>
      Specified by:
      at in interface Cfg.Symbol<T>
      Parameters:
      annotation - the annotation of the newly created element, may be null
      Returns:
      a copy of the element with the given annotation

    • of

      public static Cfg.Terminal<String> of(String name)
      Return a new terminal symbol where the name of the symbol is equal to its value.
      Parameters:
      name - the name (and value) of the terminal symbol
      Returns:
      a new terminal symbol with the given name
      Throws:
      IllegalArgumentException - if the given terminal name is empty

    • 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.
      Specified by:
      name in interface Cfg.Symbol<T>
      Returns:
      the value of the name record component

    • value

      public T value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • annotation

      public Object annotation()
      Returns the value of the annotation record component.
      Specified by:
      annotation in interface Cfg.Annotatable<T>
      Returns:
      the value of the annotation record component