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:

java.lang.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 class	MaterialArgument.Builder<C>
static class	MaterialArgument.MaterialParseException
static class	MaterialArgument.MaterialParser<C>

Constructor Summary

Constructors

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

Method Summary

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

Constructor Detail

MaterialArgument

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

Method Detail

newBuilder

public static <C> @NonNull MaterialArgument.Builder<C> 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.Material> 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.Material> 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.Material> optional(@NonNull java.lang.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