Record Class ArgumentData<T>

java.lang.Object
java.lang.Record
org.skriptlang.skript.bukkit.command.custom.ArgumentData<T>
Type Parameters:
T - The type of the argument.
Record Components:
name - The name of the argument.
isAutomaticName - Whether name was automatically generated.
type - The type of the argument.
defaultValue - The default value of the argument, if specified.
min - A minimum (inclusive) permitted value for this argument. Null if there is no minimum.
max - A maximum (inclusive) permitted value for this argument. Null if there is no maximum.
public record ArgumentData<T>(String name, boolean isAutomaticName, ClassInfo<T> type, boolean isSingle, @Nullable Expression<T> defaultValue, T min, T max) extends Record
Data describing a command argument.

  • Constructor Details

    • ArgumentData

      public ArgumentData(String name, boolean isAutomaticName, ClassInfo<T> type, boolean isSingle, @Nullable @Nullable Expression<T> defaultValue, @Nullable T min, @Nullable T max)
      Creates an instance of a ArgumentData record class.
      Parameters:
      name - the value for the name record component
      isAutomaticName - the value for the isAutomaticName record component
      type - the value for the type record component
      isSingle - the value for the isSingle record component
      defaultValue - the value for the defaultValue record component
      min - the value for the min record component
      max - the value for the max 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 the compare method from their corresponding wrapper classes.
      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.

    • name

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

    • isAutomaticName

      public boolean isAutomaticName()
      Returns the value of the isAutomaticName record component.
      Returns:
      the value of the isAutomaticName record component

    • type

      public ClassInfo<T> type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • isSingle

      public boolean isSingle()
      Returns the value of the isSingle record component.
      Returns:
      the value of the isSingle record component

    • defaultValue

      @Nullable public @Nullable Expression<T> defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component

    • min

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

    • max

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