Package studio.mevera.imperat.type

Class ParameterPlayer

java.lang.Object
studio.mevera.imperat.util.TypeCapturer
studio.mevera.imperat.command.parameters.type.BaseParameterType<BukkitSource,org.bukkit.entity.Player>
studio.mevera.imperat.type.ParameterPlayer
All Implemented Interfaces:
studio.mevera.imperat.command.parameters.type.ParameterType<BukkitSource,org.bukkit.entity.Player>
public class ParameterPlayer extends studio.mevera.imperat.command.parameters.type.BaseParameterType<BukkitSource,org.bukkit.entity.Player>

  • Field Summary

    Fields inherited from class studio.mevera.imperat.command.parameters.type.BaseParameterType

    suggestions, type

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParameterPlayer()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    studio.mevera.imperat.resolvers.SuggestionResolver<BukkitSource>
    getSuggestionResolver()
    Returns the suggestion resolver associated with this parameter type.
    boolean
    matchesInput(int rawPosition, studio.mevera.imperat.context.Context<BukkitSource> context, studio.mevera.imperat.command.parameters.CommandParameter<BukkitSource> parameter)
     
    @Nullable org.bukkit.entity.Player
    resolve(@NotNull studio.mevera.imperat.context.ExecutionContext<BukkitSource> context, @NotNull studio.mevera.imperat.context.internal.CommandInputStream<BukkitSource> commandInputStream, @NotNull String input)
     
    studio.mevera.imperat.command.parameters.OptionalValueSupplier
    supplyDefaultValue()
    Returns the default value supplier for the given source and command parameter.

    Methods inherited from class studio.mevera.imperat.command.parameters.type.BaseParameterType

    type, withSuggestions

    Methods inherited from class studio.mevera.imperat.util.TypeCapturer

    extractType, extractType

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface studio.mevera.imperat.command.parameters.type.ParameterType

    equalsExactly, getConsumedArguments, isGreedy, isRelatedToType, wrappedType

  • Constructor Details

    • ParameterPlayer

      public ParameterPlayer()

  • Method Details

    • resolve

      @Nullable public @Nullable org.bukkit.entity.Player resolve(@NotNull @NotNull studio.mevera.imperat.context.ExecutionContext<BukkitSource> context, @NotNull @NotNull studio.mevera.imperat.context.internal.CommandInputStream<BukkitSource> commandInputStream, @NotNull @NotNull String input) throws studio.mevera.imperat.exception.ImperatException
      Throws:
      studio.mevera.imperat.exception.ImperatException

    • getSuggestionResolver

      public studio.mevera.imperat.resolvers.SuggestionResolver<BukkitSource> getSuggestionResolver()
      Returns the suggestion resolver associated with this parameter type.
      Specified by:
      getSuggestionResolver in interface studio.mevera.imperat.command.parameters.type.ParameterType<BukkitSource,org.bukkit.entity.Player>
      Overrides:
      getSuggestionResolver in class studio.mevera.imperat.command.parameters.type.BaseParameterType<BukkitSource,org.bukkit.entity.Player>
      Returns:
      the suggestion resolver for generating suggestions based on the parameter type.

    • supplyDefaultValue

      public studio.mevera.imperat.command.parameters.OptionalValueSupplier supplyDefaultValue()
      Returns the default value supplier for the given source and command parameter. By default, this returns an empty supplier, indicating no default value.
      Returns:
      an OptionalValueSupplier providing the default value, or empty if none.

    • matchesInput

      public boolean matchesInput(int rawPosition, studio.mevera.imperat.context.Context<BukkitSource> context, studio.mevera.imperat.command.parameters.CommandParameter<BukkitSource> parameter)
      Specified by:
      matchesInput in interface studio.mevera.imperat.command.parameters.type.ParameterType<BukkitSource,org.bukkit.entity.Player>
      Overrides:
      matchesInput in class studio.mevera.imperat.command.parameters.type.BaseParameterType<BukkitSource,org.bukkit.entity.Player>