Package studio.mevera.imperat.context.internal

Record Class Argument<S extends Source>

java.lang.Object
java.lang.Record
studio.mevera.imperat.context.internal.Argument<S>
@Internal public record Argument<S extends Source>(@Nullable String raw, CommandParameter<S extends Source> parameter, int index, @Nullable Object value) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    Argument(@Nullable String raw, CommandParameter<S> parameter, int index, @Nullable Object value)
    Creates an instance of a Argument 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.
    CommandParameter<S>
    parameter()
    Returns the value of the parameter record component.
    @Nullable String
    raw()
    Returns the value of the raw record component.
    String
    toString()
    Returns a string representation of this record class.
    @Nullable Object
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Argument

      public Argument(@Nullable @Nullable String raw, CommandParameter<S> parameter, int index, @Nullable @Nullable Object value)
      Creates an instance of a Argument record class.
      Parameters:
      raw - the value for the raw record component
      parameter - the value for the parameter record component
      index - the value for the index record component
      value - the value for the value record component

  • Method Details

    • toString

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

    • raw

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

    • parameter

      public CommandParameter<S> parameter()
      Returns the value of the parameter record component.
      Returns:
      the value of the parameter record component

    • index

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

    • value

      @Nullable public @Nullable Object value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component