Record Class Grammar<T>

java.lang.Object
java.lang.Record
net.minecraft.util.parsing.packrat.commands.Grammar<T>
All Implemented Interfaces:
CommandArgumentParser<T>
public record Grammar<T>(Dictionary<com.mojang.brigadier.StringReader> rules, NamedRule<com.mojang.brigadier.StringReader, T> top) extends Record implements CommandArgumentParser<T>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final Dictionary<com.mojang.brigadier.StringReader>
    rules
    The field for the rules record component.
    private final NamedRule<com.mojang.brigadier.StringReader, T>
    top
    The field for the top record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Grammar(Dictionary<com.mojang.brigadier.StringReader> rules, NamedRule<com.mojang.brigadier.StringReader, T> top)
    Creates an instance of a Grammar record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    Optional<T>
    parse(ParseState<com.mojang.brigadier.StringReader> state)
     
    T
    parseForCommands(com.mojang.brigadier.StringReader reader)
     
    CompletableFuture<com.mojang.brigadier.suggestion.Suggestions>
    parseForSuggestions(com.mojang.brigadier.suggestion.SuggestionsBuilder suggestionsBuilder)
     
    Dictionary<com.mojang.brigadier.StringReader>
    rules()
    Returns the value of the rules record component.
    NamedRule<com.mojang.brigadier.StringReader, T>
    top()
    Returns the value of the top record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

    Methods inherited from interface CommandArgumentParser

    mapResult, withCodec

  • Field Details

    • rules

      private final Dictionary<com.mojang.brigadier.StringReader> rules
      The field for the rules record component.

    • top

      private final NamedRule<com.mojang.brigadier.StringReader, T> top
      The field for the top record component.

  • Constructor Details

    • Grammar

      public Grammar(Dictionary<com.mojang.brigadier.StringReader> rules, NamedRule<com.mojang.brigadier.StringReader, T> top)
      Creates an instance of a Grammar record class.
      Parameters:
      rules - the value for the rules record component
      top - the value for the top record component

  • Method Details

    • parse

      public Optional<T> parse(ParseState<com.mojang.brigadier.StringReader> state)

    • parseForCommands

      public T parseForCommands(com.mojang.brigadier.StringReader reader) throws com.mojang.brigadier.exceptions.CommandSyntaxException
      Specified by:
      parseForCommands in interface CommandArgumentParser<T>
      Throws:
      com.mojang.brigadier.exceptions.CommandSyntaxException

    • parseForSuggestions

      public CompletableFuture<com.mojang.brigadier.suggestion.Suggestions> parseForSuggestions(com.mojang.brigadier.suggestion.SuggestionsBuilder suggestionsBuilder)
      Specified by:
      parseForSuggestions in interface CommandArgumentParser<T>

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

    • rules

      public Dictionary<com.mojang.brigadier.StringReader> rules()
      Returns the value of the rules record component.
      Returns:
      the value of the rules record component

    • top

      public NamedRule<com.mojang.brigadier.StringReader, T> top()
      Returns the value of the top record component.
      Returns:
      the value of the top record component