Package org.incendo.cloud.bukkit.parser

Class ItemStackParser<C>

java.lang.Object

org.incendo.cloud.bukkit.parser.ItemStackParser<C>

Type Parameters:

C - Command sender type

All Implemented Interfaces:

ArgumentParser<C,ProtoItemStack>, ArgumentParser.FutureArgumentParser<C,ProtoItemStack>, SuggestionProviderHolder<C>

public class ItemStackParser<C>
extends Object
implements ArgumentParser.FutureArgumentParser<C,ProtoItemStack>

Parser for a Material and optional extra NBT data into a ProtoItemStack.

This parser 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/interfaces inherited from interface org.incendo.cloud.parser.ArgumentParser

ArgumentParser.FutureArgumentParser<C,T>

Constructor Summary

Constructors

Constructor	Description
ItemStackParser()	Create a new ItemStackParser.

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull CommandComponent.Builder<C,ProtoItemStack>	itemStackComponent()	Returns a CommandComponent.Builder using itemStackParser() as the parser.
static <C> @NonNull ParserDescriptor<C,ProtoItemStack>	itemStackParser()	Creates a new item stack parser.
final @NonNull CompletableFuture<@NonNull ArgumentParseResult<ProtoItemStack>>	parseFuture(@NonNull CommandContext<C> commandContext, @NonNull CommandInput commandInput)
final @NonNull SuggestionProvider<C>	suggestionProvider()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.incendo.cloud.parser.ArgumentParser

flatMap, flatMapSuccess, mapSuccess

Methods inherited from interface org.incendo.cloud.parser.ArgumentParser.FutureArgumentParser

parse

Constructor Details

ItemStackParser

public ItemStackParser()

Create a new ItemStackParser.

Since:

1.5.0

Method Details

itemStackParser

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull ParserDescriptor<C,ProtoItemStack> itemStackParser()

Creates a new item stack parser.

Type Parameters:

C - command sender type

Returns:

the created parser

Since:

2.0.0

itemStackComponent

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull CommandComponent.Builder<C,ProtoItemStack> itemStackComponent()

Returns a CommandComponent.Builder using itemStackParser() as the parser.

Type Parameters:

C - the command sender type

Returns:

the component builder

Since:

2.0.0

parseFuture

public final @NonNull CompletableFuture<@NonNull ArgumentParseResult<ProtoItemStack>> parseFuture(@NonNull CommandContext<C> commandContext,
 @NonNull CommandInput commandInput)

Specified by:

parseFuture in interface ArgumentParser<C,ProtoItemStack>

Specified by:

parseFuture in interface ArgumentParser.FutureArgumentParser<C,ProtoItemStack>

suggestionProvider

public final @NonNull SuggestionProvider<C> suggestionProvider()

Specified by:

suggestionProvider in interface ArgumentParser<C,ProtoItemStack>

Specified by:

suggestionProvider in interface SuggestionProviderHolder<C>