Package cloud.commandframework.bukkit.parsers

Class OfflinePlayerArgument<C>

java.lang.Object
cloud.commandframework.arguments.CommandArgument<C,org.bukkit.OfflinePlayer>
cloud.commandframework.bukkit.parsers.OfflinePlayerArgument<C>
Type Parameters:
C - Command sender type
All Implemented Interfaces:
cloud.commandframework.keys.CloudKeyHolder<org.bukkit.OfflinePlayer>, 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.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    OfflinePlayerArgument.Builder<C>
     
    static final class 
    OfflinePlayerArgument.OfflinePlayerParseException
    OfflinePlayer parse exception
    static final class 
    OfflinePlayerArgument.OfflinePlayerParser<C>
     

    Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

    cloud.commandframework.arguments.CommandArgument.TypedBuilder<C extends Object,T extends Object,B extends cloud.commandframework.arguments.CommandArgument.Builder<C,T>>

  • Method Summary

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

    Methods inherited from class cloud.commandframework.arguments.CommandArgument

    addPreprocessor, compareTo, copy, equals, getDefaultDescription, getDefaultValue, getKey, 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 Details

    • builder

      @API(status=STABLE, since="1.8.0") public static <C> @NonNull OfflinePlayerArgument.Builder<C> builder(@NonNull String name)
      Create a new OfflinePlayerArgument.Builder.
      Type Parameters:
      C - sender type
      Parameters:
      name - argument name
      Returns:
      new OfflinePlayerArgument.Builder
      Since:
      1.8.0

    • newBuilder

      @API(status=DEPRECATED, since="1.8.0") @Deprecated public static <C> @NonNull OfflinePlayerArgument.Builder<C> newBuilder(@NonNull String name)
      Deprecated.
      prefer builder(String)
      Create a new builder
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Name of the argument
      Returns:
      Created builder

    • of

      public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,org.bukkit.OfflinePlayer> of(@NonNull 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 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 String name, @NonNull 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