Package cloud.commandframework.bukkit.parsers

Class ItemStackArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,ProtoItemStack>

cloud.commandframework.bukkit.parsers.ItemStackArgument<C>

Type Parameters:

C - Command sender type

All Implemented Interfaces:

cloud.commandframework.keys.CloudKeyHolder<ProtoItemStack>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>

public final class ItemStackArgument<C>
extends cloud.commandframework.arguments.CommandArgument<C,ProtoItemStack>

Argument type for parsing a Material and optional extra NBT data into a ProtoItemStack.

This argument type only provides basic suggestions by default. On Minecraft 1.13 and newer, enabling Brigadier compatibility through BukkitCommandManager.registerBrigadier() will allow client side validation and suggestions to be utilized.

Since:

1.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ItemStackArgument.Builder<C>	Builder for ItemStackArgument.
static final class	ItemStackArgument.Parser<C>	Parser for ProtoItemStack.

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 ItemStackArgument.Builder<C>	builder(@NonNull String name)	Create a new ItemStackArgument.Builder.
static <C> @NonNull ItemStackArgument<C>	of(@NonNull String name)	Create a new required ItemStackArgument.
static <C> @NonNull ItemStackArgument<C>	optional(@NonNull String name)	Create a new optional ItemStackArgument.

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

public static <C>
@NonNull ItemStackArgument.Builder<C> builder(@NonNull String name)

Create a new ItemStackArgument.Builder.

Type Parameters:

C - Command sender type

Parameters:

name - Name of the argument

Returns:

Created builder

Since:

1.5.0

of

public static <C> @NonNull ItemStackArgument<C> of(@NonNull String name)

Create a new required ItemStackArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

Since:

1.5.0

optional

public static <C> @NonNull ItemStackArgument<C> optional(@NonNull String name)

Create a new optional ItemStackArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

Since:

1.5.0