Package org.incendo.cloud.bukkit.parser.selector

Class SinglePlayerSelectorParser<C>

java.lang.Object

org.incendo.cloud.bukkit.parser.selector.SinglePlayerSelectorParser<C>

Type Parameters:

C - sender type

All Implemented Interfaces:

ArgumentParser<C,SinglePlayerSelector>, ArgumentParser.FutureArgumentParser<C,SinglePlayerSelector>, SuggestionProvider<C>, SuggestionProviderHolder<C>

public final class SinglePlayerSelectorParser<C>
extends Object

Parser for SinglePlayerSelector. On Minecraft 1.13+ this argument uses Minecraft's built-in entity selector argument for parsing and suggestions. On prior versions, this argument behaves similarly to PlayerParser.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final class	org.incendo.cloud.bukkit.parser.selector.SelectorUtils.SelectorParser.Thrower

Nested classes/interfaces inherited from interface org.incendo.cloud.parser.ArgumentParser

ArgumentParser.FutureArgumentParser<C,T>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Supplier<Object>	NO_ENTITIES_EXCEPTION_TYPE
protected static final Supplier<Object>	NO_PLAYERS_EXCEPTION_TYPE

Constructor Summary

Constructors

Constructor	Description
SinglePlayerSelectorParser()	Creates a new SinglePlayerSelectorParser.

Method Summary

Modifier and Type	Method	Description
protected @NonNull CompletableFuture<ArgumentParseResult<SinglePlayerSelector>>	legacyParse(@NonNull CommandContext<C> commandContext, @NonNull CommandInput commandInput)
protected @NonNull Iterable<@NonNull Suggestion>	legacySuggestions(CommandContext<C> commandContext, CommandInput input)
SinglePlayerSelector	mapResult(@NonNull String input, @NonNull org.incendo.cloud.bukkit.parser.selector.SelectorUtils.EntitySelectorWrapper wrapper)
CompletableFuture<ArgumentParseResult<SinglePlayerSelector>>	parseFuture(CommandContext<C> commandContext, CommandInput commandInput)
static <C> @NonNull CommandComponent.Builder<C,SinglePlayerSelector>	singlePlayerSelectorComponent()	Returns a CommandComponent.Builder using singlePlayerSelectorParser() as the parser.
static <C> @NonNull ParserDescriptor<C,SinglePlayerSelector>	singlePlayerSelectorParser()	Creates a new single player selector parser.
CompletableFuture<? extends @NonNull Iterable<? extends @NonNull Suggestion>>	suggestionsFuture(@NonNull CommandContext<C> commandContext, @NonNull CommandInput input)

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, suggestionProvider

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

parse

Field Details

NO_PLAYERS_EXCEPTION_TYPE

protected static final Supplier<Object> NO_PLAYERS_EXCEPTION_TYPE

NO_ENTITIES_EXCEPTION_TYPE

protected static final Supplier<Object> NO_ENTITIES_EXCEPTION_TYPE

Constructor Details

SinglePlayerSelectorParser

public SinglePlayerSelectorParser()

Creates a new SinglePlayerSelectorParser.

Method Details

singlePlayerSelectorParser

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

Creates a new single player selector parser.

Type Parameters:

C - command sender type

Returns:

the created parser

Since:

2.0.0

singlePlayerSelectorComponent

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

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

Type Parameters:

C - the command sender type

Returns:

the component builder

Since:

2.0.0

mapResult

@API(status=INTERNAL,
     consumers="org.incendo.cloud.*")
public SinglePlayerSelector mapResult(@NonNull String input,
 @NonNull org.incendo.cloud.bukkit.parser.selector.SelectorUtils.EntitySelectorWrapper wrapper)

legacyParse

protected @NonNull CompletableFuture<ArgumentParseResult<SinglePlayerSelector>> legacyParse(@NonNull CommandContext<C> commandContext,
 @NonNull CommandInput commandInput)

legacySuggestions

protected @NonNull Iterable<@NonNull Suggestion> legacySuggestions(CommandContext<C> commandContext,
 CommandInput input)

parseFuture

public CompletableFuture<ArgumentParseResult<SinglePlayerSelector>> parseFuture(CommandContext<C> commandContext,
 CommandInput commandInput)

Specified by:

parseFuture in interface ArgumentParser<C,T>

Specified by:

parseFuture in interface ArgumentParser.FutureArgumentParser<C,T>

suggestionsFuture

public CompletableFuture<? extends @NonNull Iterable<? extends @NonNull Suggestion>> suggestionsFuture(@NonNull CommandContext<C> commandContext,
 @NonNull CommandInput input)

Specified by:

suggestionsFuture in interface SuggestionProvider<C>