Package org.incendo.cloud.velocity.parser

Class PlayerParser<C>

java.lang.Object

org.incendo.cloud.velocity.parser.PlayerParser<C>

Type Parameters:

C - Command sender type

All Implemented Interfaces:

ArgumentParser<C,com.velocitypowered.api.proxy.Player>, BlockingSuggestionProvider<C>, SuggestionProvider<C>, SuggestionProviderHolder<C>

public final class PlayerParser<C>
extends Object
implements ArgumentParser<C,com.velocitypowered.api.proxy.Player>, BlockingSuggestionProvider<C>

Argument parser for players

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PlayerParser.PlayerParseException

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

ArgumentParser.FutureArgumentParser<C,T>

Nested classes/interfaces inherited from interface org.incendo.cloud.suggestion.BlockingSuggestionProvider

BlockingSuggestionProvider.Strings<C>

Constructor Summary

Constructors

Constructor	Description
PlayerParser()

Method Summary

Modifier and Type	Method	Description
@NonNull ArgumentParseResult<@NonNull com.velocitypowered.api.proxy.Player>	parse(@NonNull CommandContext<@NonNull C> commandContext, @NonNull CommandInput commandInput)
static <C> @NonNull CommandComponent.Builder<C,com.velocitypowered.api.proxy.Player>	playerComponent()	Returns a CommandComponent.Builder using playerParser() as the parser.
static <C> @NonNull ParserDescriptor<C,com.velocitypowered.api.proxy.Player>	playerParser()	Creates a new player parser.
@NonNull Iterable<? extends @NonNull Suggestion>	suggestions(@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, parseFuture, suggestionProvider

Methods inherited from interface org.incendo.cloud.suggestion.BlockingSuggestionProvider

suggestionsFuture

Constructor Details

PlayerParser

public PlayerParser()

Method Details

playerParser

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull ParserDescriptor<C,com.velocitypowered.api.proxy.Player> playerParser()

Creates a new player parser.

Type Parameters:

C - command sender type

Returns:

the created parser

Since:

2.0.0

playerComponent

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull CommandComponent.Builder<C,com.velocitypowered.api.proxy.Player> playerComponent()

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

Type Parameters:

C - the command sender type

Returns:

the component builder

Since:

2.0.0

parse

public @NonNull ArgumentParseResult<@NonNull com.velocitypowered.api.proxy.Player> parse(@NonNull CommandContext<@NonNull C> commandContext,
 @NonNull CommandInput commandInput)

Specified by:

parse in interface ArgumentParser<C,com.velocitypowered.api.proxy.Player>

suggestions

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

Specified by:

suggestions in interface BlockingSuggestionProvider<C>