Package cloud.commandframework.bukkit.parsers

Class WorldArgument<C>

  • Type Parameters:
    C - Command sender type
    All Implemented Interfaces:
    cloud.commandframework.keys.CloudKeyHolder<org.bukkit.World>, java.lang.Comparable<cloud.commandframework.arguments.CommandArgument<?,​?>>
    public class WorldArgument<C>
extends cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.World>
    cloud argument type that parses Bukkit worlds

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected WorldArgument​(boolean required, @NonNull java.lang.String name, @NonNull java.lang.String defaultValue, @Nullable java.util.function.BiFunction<cloud.commandframework.context.CommandContext<C>,​java.lang.String,​java.util.List<java.lang.String>> suggestionsProvider, @NonNull cloud.commandframework.ArgumentDescription defaultDescription)  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static <C> @NonNull cloud.commandframework.arguments.CommandArgument.Builder<C,​org.bukkit.World> newBuilder​(@NonNull java.lang.String name)
      Create a new builder
      static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.World> of​(@NonNull java.lang.String name)
      Create a new required argument
      static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.World> optional​(@NonNull java.lang.String name)
      Create a new optional argument
      static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.World> optional​(@NonNull java.lang.String name, @NonNull java.lang.String defaultValue)
      Create a new optional argument 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

    • Constructor Detail

      • WorldArgument

        protected WorldArgument​(boolean required,
                        @NonNull java.lang.String name,
                        @NonNull java.lang.String defaultValue,
                        @Nullable java.util.function.BiFunction<cloud.commandframework.context.CommandContext<C>,​java.lang.String,​java.util.List<java.lang.String>> suggestionsProvider,
                        @NonNull cloud.commandframework.ArgumentDescription defaultDescription)

    • Method Detail

      • newBuilder

        public static <C> @NonNull cloud.commandframework.arguments.CommandArgument.Builder<C,​org.bukkit.World> newBuilder​(@NonNull java.lang.String name)
        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.World> of​(@NonNull java.lang.String name)
        Create a new required argument
        Type Parameters:
        C - Command sender type
        Parameters:
        name - Argument name
        Returns:
        Created argument

      • optional

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

      • optional

        public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,​org.bukkit.World> optional​(@NonNull java.lang.String name,
                                                                                                               @NonNull java.lang.String defaultValue)
        Create a new optional argument with a default value
        Type Parameters:
        C - Command sender type
        Parameters:
        name - Argument name
        defaultValue - Default value
        Returns:
        Created argument