Package studio.mevera.imperat.command.suggestions

Record Class CompletionArg

java.lang.Object
java.lang.Record
studio.mevera.imperat.command.suggestions.CompletionArg
Record Components:
value - the argument input half-complete or empty to be completed
index - the index of this argument
@AvailableSince("1.0.0") public record CompletionArg(String value, int index) extends Record
Represents an argument that's being completed or an argument requested by the command-sender to be completed

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final CompletionArg
    EMPTY
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CompletionArg(String value, int index)
    Creates an instance of a CompletionArg 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
    index()
    Returns the value of the index record component.
    boolean
    isEmpty()
     
    final String
    toString()
    Returns a string representation of this record class.
    String
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • CompletionArg

      public CompletionArg(String value, int index)
      Creates an instance of a CompletionArg record class.
      Parameters:
      value - the value for the value record component
      index - the value for the index record component

  • Method Details

    • isEmpty

      public boolean isEmpty()

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

    • value

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

    • index

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