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

Record Class StringTokenDefinition

java.lang.Object
java.lang.Record
net.luis.utils.io.token.definition.StringTokenDefinition
Record Components:
token - The token string
equalsIgnoreCase - If the token should be compared case insensitive
All Implemented Interfaces:
TokenDefinition, TokenRule
public record StringTokenDefinition(@NotNull String token, boolean equalsIgnoreCase) extends Record implements TokenDefinition
Token definition for a string.
This token definition matches a string that is equal to the token string.

  • Field Details

    • token

      @NotNull private final @NotNull String token
      The field for the token record component.

    • equalsIgnoreCase

      private final boolean equalsIgnoreCase
      The field for the equalsIgnoreCase record component.

  • Constructor Details

    • StringTokenDefinition

      public StringTokenDefinition(@NotNull @NotNull String token, boolean equalsIgnoreCase)
      Constructs a new token definition for the given string.
      Parameters:
      token - The token string
      equalsIgnoreCase - If the token should be compared case insensitive
      Throws:
      NullPointerException - If the token is null
      IllegalArgumentException - If the token is empty

  • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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

      @NotNull public @NotNull String token()
      Returns the value of the token record component.
      Returns:
      the value of the token record component

    • equalsIgnoreCase

      public boolean equalsIgnoreCase()
      Returns the value of the equalsIgnoreCase record component.
      Returns:
      the value of the equalsIgnoreCase record component