Package net.apartium.cocoabeans.commands.parsers

Record Class ArgumentParser.ParseResult<T>

java.lang.Object
java.lang.Record
net.apartium.cocoabeans.commands.parsers.ArgumentParser.ParseResult<T>
Type Parameters:
T - type
Record Components:
result - the result of the parsing
newIndex - new index to change to
Enclosing class:
ArgumentParser<T>
public static record ArgumentParser.ParseResult<T>(T result, int newIndex) extends Record
Parse Result is the content of the parsing

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParseResult(T result, int newIndex)
    Creates an instance of a ParseResult 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.
    int
    newIndex()
    Returns the value of the newIndex 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

    • ParseResult

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

  • Method Details

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

    • result

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

    • newIndex

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