Package cloud.commandframework.bukkit.parsers

Class MaterialArgument<C>

java.lang.Object
cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Material>
cloud.commandframework.bukkit.parsers.MaterialArgument<C>
Type Parameters:
C - Command sender type
All Implemented Interfaces:
cloud.commandframework.keys.CloudKeyHolder<org.bukkit.Material>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>
public class MaterialArgument<C> extends cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Material>
cloud argument type that parses Bukkit materials

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MaterialArgument.Builder<C>
     
    static final class 
    MaterialArgument.MaterialParseException
     
    static final class 
    MaterialArgument.MaterialParser<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>>

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static <C> @NonNull MaterialArgument.Builder<C>
    builder(@NonNull String name)
    Create a new MaterialArgument.Builder.
    static <C> @NonNull MaterialArgument.Builder<C>
    newBuilder(@NonNull String name)
    Deprecated.
    prefer builder(String)
    static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Material>
    of(@NonNull String name)
    Create a new required argument
    static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Material>
    optional(@NonNull String name)
    Create a new optional argument
    static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,org.bukkit.Material>
    optional(@NonNull String name, @NonNull org.bukkit.Material material)
    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 Details

    • MaterialArgument

      protected MaterialArgument(boolean required, @NonNull String name, @NonNull String defaultValue, @Nullable BiFunction<@NonNull cloud.commandframework.context.CommandContext<C>,@NonNull String,@NonNull List<@NonNull String>> suggestionsProvider, @NonNull cloud.commandframework.ArgumentDescription defaultDescription)

  • Method Details

    • builder

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

    • newBuilder

      @API(status=DEPRECATED, since="1.8.0") @Deprecated public static <C> @NonNull MaterialArgument.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.Material> of(@NonNull 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.Material> optional(@NonNull 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.Material> optional(@NonNull String name, @NonNull org.bukkit.Material material)
      Create a new optional argument with a default value
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Argument name
      material - Default value
      Returns:
      Created argument