Package org.incendo.cloud.minecraft.extras.parser

Class TextColorParser<C>

java.lang.Object

org.incendo.cloud.minecraft.extras.parser.TextColorParser<C>

Type Parameters:

C - Command sender type

All Implemented Interfaces:

ArgumentParser<C,TextColor>, BlockingSuggestionProvider<C>, BlockingSuggestionProvider.Strings<C>, SuggestionProvider<C>, SuggestionProviderHolder<C>

public final class TextColorParser<C>
extends Object
implements ArgumentParser<C,TextColor>, BlockingSuggestionProvider.Strings<C>

Parser for color codes.

Accepts NamedTextColors, Legacy Minecraft & color codes, and Hex Codes (#RRGGBB or RRGGBB)

Since:

1.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TextColorParser.Contributor

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
TextColorParser()

Method Summary

Modifier and Type	Method	Description
@NonNull ArgumentParseResult<@NonNull TextColor>	parse(@NonNull CommandContext<@NonNull C> commandContext, @NonNull CommandInput commandInput)
@NonNull Iterable<@NonNull String>	stringSuggestions(@NonNull CommandContext<C> commandContext, @NonNull CommandInput input)
static <C> @NonNull CommandComponent.Builder<C,TextColor>	textColorComponent()	Returns a CommandComponent.Builder using textColorParser() as the parser.
static <C> @NonNull ParserDescriptor<C,TextColor>	textColorParser()	Creates a new text color parser.

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

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

suggestions

Constructor Details

TextColorParser

public TextColorParser()

Method Details

textColorParser

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

Creates a new text color parser.

Type Parameters:

C - command sender type

Returns:

the created parser

Since:

2.0.0

textColorComponent

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

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

Type Parameters:

C - the command sender type

Returns:

the component builder

Since:

2.0.0

parse

public @NonNull ArgumentParseResult<@NonNull TextColor> parse(@NonNull CommandContext<@NonNull C> commandContext,
 @NonNull CommandInput commandInput)

Specified by:

parse in interface ArgumentParser<C,TextColor>

stringSuggestions

public @NonNull Iterable<@NonNull String> stringSuggestions(@NonNull CommandContext<C> commandContext,
 @NonNull CommandInput input)

Specified by:

stringSuggestions in interface BlockingSuggestionProvider.Strings<C>