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

Class MultipleEntitySelectorParser<C>

java.lang.Object

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

Type Parameters:

C - sender type

All Implemented Interfaces:

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

public final class MultipleEntitySelectorParser<C>
extends Object

Parser for MultipleEntitySelector. On Minecraft 1.13+ this argument uses Minecraft's built-in entity selector argument for parsing and suggestions. On prior versions, this argument will suggest nothing and always fail parsing with SelectorUnsupportedException.

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
MultipleEntitySelectorParser()	Creates a new MultipleEntitySelectorParser.
MultipleEntitySelectorParser(boolean allowEmpty)	Creates a new MultipleEntitySelectorParser.

Method Summary

Modifier and Type	Method	Description
protected CompletableFuture<ArgumentParseResult<MultipleEntitySelector>>	legacyParse(CommandContext<C> commandContext, CommandInput commandInput)
protected @NonNull Iterable<@NonNull Suggestion>	legacySuggestions(CommandContext<C> commandContext, CommandInput input)
MultipleEntitySelector	mapResult(@NonNull String input, @NonNull org.incendo.cloud.bukkit.parser.selector.SelectorUtils.EntitySelectorWrapper wrapper)
static <C> @NonNull CommandComponent.Builder<C,MultipleEntitySelector>	multipleEntitySelectorComponent()	Returns a CommandComponent.Builder using multipleEntitySelectorParser() as the parser.
static <C> @NonNull ParserDescriptor<C,MultipleEntitySelector>	multipleEntitySelectorParser()	Creates a new multiple entity selector parser that allows empty results.
static <C> @NonNull ParserDescriptor<C,MultipleEntitySelector>	multipleEntitySelectorParser(boolean allowEmpty)	Creates a new multiple entity selector parser.
CompletableFuture<ArgumentParseResult<MultipleEntitySelector>>	parseFuture(CommandContext<C> commandContext, CommandInput commandInput)
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

MultipleEntitySelectorParser

@API(status=STABLE,
     since="1.8.0")
public MultipleEntitySelectorParser(boolean allowEmpty)

Creates a new MultipleEntitySelectorParser.

Parameters:

allowEmpty - Whether to allow an empty result

Since:

1.8.0

MultipleEntitySelectorParser

public MultipleEntitySelectorParser()

Creates a new MultipleEntitySelectorParser.

Method Details

multipleEntitySelectorParser

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

Creates a new multiple entity selector parser that allows empty results.

Type Parameters:

C - command sender type

Returns:

the created parser

Since:

2.0.0

multipleEntitySelectorParser

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull ParserDescriptor<C,MultipleEntitySelector> multipleEntitySelectorParser(boolean allowEmpty)

Creates a new multiple entity selector parser.

Type Parameters:

C - command sender type

Parameters:

allowEmpty - whether to allow empty selections

Returns:

the created parser

Since:

2.0.0

multipleEntitySelectorComponent

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

Returns a CommandComponent.Builder using multipleEntitySelectorParser() 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 MultipleEntitySelector mapResult(@NonNull String input,
 @NonNull org.incendo.cloud.bukkit.parser.selector.SelectorUtils.EntitySelectorWrapper wrapper)

legacyParse

protected CompletableFuture<ArgumentParseResult<MultipleEntitySelector>> legacyParse(CommandContext<C> commandContext,
 CommandInput commandInput)

legacySuggestions

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

parseFuture

public CompletableFuture<ArgumentParseResult<MultipleEntitySelector>> 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>