Package net.diversionmc.parser.pattern

Record Class PatternResult<T extends Sentence>

java.lang.Object
java.lang.Record
net.diversionmc.parser.pattern.PatternResult<T>
Type Parameters:
T - Sentence type, matching ParsePattern and Parser.
Record Components:
length - Amount of pieces used by this pattern.
result - Resulting sentence.
public record PatternResult<T extends Sentence>(int length, T extends Sentence result) extends Record
Represents a result of a sentence parse.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PatternResult(int length, T result)
    Creates an instance of a PatternResult 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.
    boolean
    isStatement()
    Check if resulting sentence is a statement.
    int
    length()
    Returns the value of the length record component.
    T
    result()
    Returns the value of the result record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PatternResult

      public PatternResult(int length, T result)
      Creates an instance of a PatternResult record class.
      Parameters:
      length - the value for the length record component
      result - the value for the result record component

  • Method Details

    • isStatement

      public boolean isStatement()
      Check if resulting sentence is a statement.
      Returns:
      Sentence.isStatement()

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

    • length

      public int length()
      Returns the value of the length record component.
      Returns:
      the value of the length record component

    • result

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