Module net.luis.utils
Package net.luis.utils.io.token.definition

Record Class EscapedTokenDefinition

java.lang.Object
java.lang.Record
net.luis.utils.io.token.definition.EscapedTokenDefinition
Record Components:
token - The escaped token character
All Implemented Interfaces:
TokenDefinition, TokenRule
public record EscapedTokenDefinition(char token) extends Record implements TokenDefinition
Token definition for escaped characters.
This token definition matches a string that starts with a backslash (\) and is followed by the token character.
Example: 

 \<token> // Generic
 \t // Tab
 \n // New line
 \\ // Backslash

  • Field Details

    • token

      private final char token
      The field for the token record component.

  • Constructor Details

    • EscapedTokenDefinition

      public EscapedTokenDefinition(char token)
      Creates an instance of a EscapedTokenDefinition record class.
      Parameters:
      token - the value for the token record component

  • Method Details

    • matches

      public boolean matches(@NotNull @NotNull String word)
      Description copied from interface: TokenDefinition
      Checks if the given word matches this token definition.
      Specified by:
      matches in interface TokenDefinition
      Parameters:
      word - The word to check
      Returns:
      True if the word matches this token definition, false otherwise

    • toString

      @NotNull public @NotNull 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 '=='.
      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.

    • token

      public char token()
      Returns the value of the token record component.
      Returns:
      the value of the token record component