Record Class ScriptArgumentBuilder

java.lang.Object
java.lang.Record
org.skriptlang.skript.bukkit.command.elements.structures.util.ScriptArgumentBuilder
Record Components:
builder - The builder for the argument.
data - The data describing the argument.
public record ScriptArgumentBuilder(com.mojang.brigadier.builder.ArgumentBuilder<io.papermc.paper.command.brigadier.CommandSourceStack, ?> builder, @Nullable ArgumentData<?> data) extends Record
Utility record for passing around an argument builder with additional data.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScriptArgumentBuilder(com.mojang.brigadier.builder.ArgumentBuilder<io.papermc.paper.command.brigadier.CommandSourceStack, ?> builder, @Nullable ArgumentData<?> data)
    Creates an instance of a ScriptArgumentBuilder record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.mojang.brigadier.builder.ArgumentBuilder<io.papermc.paper.command.brigadier.CommandSourceStack, ?>
    builder()
    Returns the value of the builder record component.
    @Nullable ArgumentData<?>
    data()
    Returns the value of the data record component.
    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.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • ScriptArgumentBuilder

      public ScriptArgumentBuilder(com.mojang.brigadier.builder.ArgumentBuilder<io.papermc.paper.command.brigadier.CommandSourceStack, ?> builder, @Nullable @Nullable ArgumentData<?> data)
      Creates an instance of a ScriptArgumentBuilder record class.
      Parameters:
      builder - the value for the builder record component
      data - the value for the data 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • builder

      public com.mojang.brigadier.builder.ArgumentBuilder<io.papermc.paper.command.brigadier.CommandSourceStack, ?> builder()
      Returns the value of the builder record component.
      Returns:
      the value of the builder record component

    • data

      @Nullable public @Nullable ArgumentData<?> data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component