Module net.luis.utils
Package net.luis.utils.io.token.rule.rules

Record Class OptionalTokenRule

java.lang.Object
java.lang.Record
net.luis.utils.io.token.rule.rules.OptionalTokenRule
Record Components:
tokenRule - The token rule to match optionally
All Implemented Interfaces:
TokenRule
public record OptionalTokenRule(@NotNull TokenRule tokenRule) extends Record implements TokenRule
A token rule that matches optionally a single token rule.
This rule is useful for creating optional matching logic.
It will match the token rule if it is present, otherwise it will return an empty match.

  • Field Details

    • tokenRule

      @NotNull private final @NotNull TokenRule tokenRule
      The field for the tokenRule record component.

  • Constructor Details

    • OptionalTokenRule

      public OptionalTokenRule(@NotNull @NotNull TokenRule tokenRule)
      Constructs a new optional token rule with the given token rule.
      Parameters:
      tokenRule - The token rule to match optionally
      Throws:
      NullPointerException - If the token rule is null

  • Method Details

    • match

      @Nullable public @Nullable TokenRuleMatch match(@NotNull @NotNull List<Token> tokens, int startIndex)
      Description copied from interface: TokenRule
      Checks if the given tokens match this rule starting from the specified index.
      If the match is successful, a TokenRuleMatch is returned, otherwise null.
      Specified by:
      match in interface TokenRule
      Parameters:
      tokens - The list of tokens to match against
      startIndex - The index to start matching from
      Returns:
      A token rule match if successful, otherwise null

    • 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.

    • tokenRule

      @NotNull public @NotNull TokenRule tokenRule()
      Returns the value of the tokenRule record component.
      Returns:
      the value of the tokenRule record component