Record Class CommandParameterInfo<T>

java.lang.Object
java.lang.Record
nl.pim16aap2.animatedarchitecture.spigot.core.comands.CommandParameterInfo<T>
Type Parameters:
T - the type of the parameter.
Record Components:
name - the name of the parameter.
clz - the class of the parameter.
public record CommandParameterInfo<T>(String name, Class<T> clz) extends Record
Record that holds the name and class of a command parameter with some utility methods.

  • Field Details

  • Constructor Details

    • CommandParameterInfo

      public CommandParameterInfo(String name, Class<T> clz)
      Creates an instance of a CommandParameterInfo record class.
      Parameters:
      name - the value for the name record component
      clz - the value for the clz record component

  • Method Details

    • getNullable

      public @Nullable T getNullable(cloud.commandframework.context.CommandContext<ICommandSender> context)
      Gets the parameter from the context, or null if not present.
      Parameters:
      context - the command context.
      Returns:
      the parameter value, or null if not present.

    • get

      public T get(cloud.commandframework.context.CommandContext<ICommandSender> context)
      Gets the parameter from the context.
      Parameters:
      context - the command context.
      Returns:
      the parameter value.

    • getOrDefault

      public T getOrDefault(cloud.commandframework.context.CommandContext<ICommandSender> context, T defaultValue)
      Gets the parameter from the context, or returns the default value if not present.
      Parameters:
      context - the command context.
      defaultValue - the default value to return if the parameter is not present.
      Returns:
      the parameter value, or the default value if not present.

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

    • name

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

    • clz

      public Class<T> clz()
      Returns the value of the clz record component.
      Returns:
      the value of the clz record component