Package cloud.commandframework.bukkit.parsers

Class OfflinePlayerArgument<C>

  • Type Parameters:
    C - Command sender type
    All Implemented Interfaces:
    java.lang.Comparable<cloud.commandframework.arguments.CommandArgument<?,​?>>
    public final class OfflinePlayerArgument<C>
extends cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.OfflinePlayer>
    Argument type that parses into OfflinePlayer. This is not thread safe. This may also result in a blocking request to get the UUID for the offline player.

    Avoid using this type if possible.

    • Method Summary

      Modifier and Type Method Description
      static <C> @NonNull OfflinePlayerArgument.Builder<C> newBuilder​(@NonNull java.lang.String name)
      Create a new builder
      static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.OfflinePlayer> of​(@NonNull java.lang.String name)
      Create a new required command component
      static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.OfflinePlayer> optional​(@NonNull java.lang.String name)
      Create a new optional command component
      static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.OfflinePlayer> optional​(@NonNull java.lang.String name, @NonNull java.lang.String defaultPlayer)
      Create a new required command component with a default value

      • Methods inherited from class cloud.commandframework.arguments.CommandArgument

        addPreprocessor, compareTo, copy, equals, getDefaultValue, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • newBuilder

        public static <C> @NonNull OfflinePlayerArgument.Builder<C> newBuilder​(@NonNull java.lang.String name)
        Create a new builder
        Type Parameters:
        C - Command sender type
        Parameters:
        name - Name of the component
        Returns:
        Created builder

      • of

        public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.OfflinePlayer> of​(@NonNull java.lang.String name)
        Create a new required command component
        Type Parameters:
        C - Command sender type
        Parameters:
        name - Component name
        Returns:
        Created component

      • optional

        public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.OfflinePlayer> optional​(@NonNull java.lang.String name)
        Create a new optional command component
        Type Parameters:
        C - Command sender type
        Parameters:
        name - Component name
        Returns:
        Created component

      • optional

        public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.OfflinePlayer> optional​(@NonNull java.lang.String name,
                                                                                                                       @NonNull java.lang.String defaultPlayer)
        Create a new required command component with a default value
        Type Parameters:
        C - Command sender type
        Parameters:
        name - Component name
        defaultPlayer - Default player
        Returns:
        Created component