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

Class ComponentParser<C>

java.lang.Object

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

Type Parameters:

C - Command sender type

All Implemented Interfaces:

ArgumentParser<C,Component>, SuggestionProviderHolder<C>

public final class ComponentParser<C>
extends Object
implements ArgumentParser<C,Component>

Parser for components.

Uses a provided Function to decode a string into a Component.

Since:

2.0.0

Nested Class Summary

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

ArgumentParser.FutureArgumentParser<C,T>

Constructor Summary

Constructors

Constructor	Description
ComponentParser(@NonNull Function<String,? extends Component> componentDecoder, @NonNull StringParser.StringMode stringMode)	Construct a new component parser.

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull CommandComponent.Builder<C,Component>	componentComponent(@NonNull Function<String,? extends Component> componentDecoder, @NonNull StringParser.StringMode stringMode)	Create a new command component builder for the provided component decoder using the provided string mode.
@NonNull Function<String,? extends Component>	componentDecoder()	Returns the component decoder used by this parser.
static <C> @NonNull ParserDescriptor<C,Component>	componentParser(@NonNull Function<String,? extends Component> componentDecoder)	Create a new parser descriptor for the provided component decoder using the StringParser.StringMode.QUOTED mode.
static <C> @NonNull ParserDescriptor<C,Component>	componentParser(@NonNull Function<String,? extends Component> componentDecoder, @NonNull StringParser.StringMode stringMode)	Create a new parser descriptor for the provided component decoder using the provided string mode.
static <C> @NonNull ParserDescriptor<C,Component>	componentParser(@NonNull ComponentSerializer<?,? extends Component,String> componentSerializer)	Create a new parser descriptor for the provided component decoder using the StringParser.StringMode.QUOTED mode.
static <C> @NonNull ParserDescriptor<C,Component>	componentParser(@NonNull ComponentSerializer<?,? extends Component,String> componentSerializer, @NonNull StringParser.StringMode stringMode)	Create a new parser descriptor for the provided component decoder using the provided string mode.
static <C> @NonNull ParserDescriptor<C,Component>	miniMessageParser()	Create a new parser descriptor for the default MiniMessage serializer using the StringParser.StringMode.QUOTED mode.
static <C> @NonNull ParserDescriptor<C,Component>	miniMessageParser(@NonNull StringParser.StringMode stringMode)	Create a new parser descriptor for the default MiniMessage serializer using the provided string mode.
@NonNull ArgumentParseResult<@NonNull Component>	parse(@NonNull CommandContext<@NonNull C> commandContext, @NonNull CommandInput commandInput)
@NonNull StringParser.StringMode	stringMode()	Returns the string mode used by this 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

Constructor Details

ComponentParser

@API(status=STABLE,
     since="2.0.0")
public ComponentParser(@NonNull Function<String,? extends Component> componentDecoder,
 @NonNull StringParser.StringMode stringMode)

Construct a new component parser.

Parameters:

componentDecoder - the component decoder to deserialize the component

stringMode - the string mode to use for the input for the component decoder

Method Details

miniMessageParser

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

Create a new parser descriptor for the default MiniMessage serializer using the StringParser.StringMode.QUOTED mode.

Type Parameters:

C - Command sender type

Returns:

the parser descriptor

Since:

2.0.0

miniMessageParser

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull ParserDescriptor<C,Component> miniMessageParser(@NonNull StringParser.StringMode stringMode)

Create a new parser descriptor for the default MiniMessage serializer using the provided string mode.

Type Parameters:

C - Command sender type

Parameters:

stringMode - the string mode to use

Returns:

the parser descriptor

Since:

2.0.0

componentParser

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull ParserDescriptor<C,Component> componentParser(@NonNull ComponentSerializer<?,? extends Component,String> componentSerializer)

Create a new parser descriptor for the provided component decoder using the StringParser.StringMode.QUOTED mode.

Type Parameters:

C - Command sender type

Parameters:

componentSerializer - the component serializer

Returns:

the parser descriptor

Since:

2.0.0

componentParser

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull ParserDescriptor<C,Component> componentParser(@NonNull Function<String,? extends Component> componentDecoder)

Create a new parser descriptor for the provided component decoder using the StringParser.StringMode.QUOTED mode.

Type Parameters:

C - Command sender type

Parameters:

componentDecoder - the component decoder

Returns:

the parser descriptor

Since:

2.0.0

componentParser

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull ParserDescriptor<C,Component> componentParser(@NonNull ComponentSerializer<?,? extends Component,String> componentSerializer,
 @NonNull StringParser.StringMode stringMode)

Create a new parser descriptor for the provided component decoder using the provided string mode.

Type Parameters:

C - Command sender type

Parameters:

componentSerializer - the component decoder

stringMode - the string mode to use

Returns:

the parser descriptor

Since:

2.0.0

componentParser

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull ParserDescriptor<C,Component> componentParser(@NonNull Function<String,? extends Component> componentDecoder,
 @NonNull StringParser.StringMode stringMode)

Create a new parser descriptor for the provided component decoder using the provided string mode.

Type Parameters:

C - Command sender type

Parameters:

componentDecoder - the component decoder

stringMode - the string mode to use

Returns:

the parser descriptor

Since:

2.0.0

componentComponent

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull CommandComponent.Builder<C,Component> componentComponent(@NonNull Function<String,? extends Component> componentDecoder,
 @NonNull StringParser.StringMode stringMode)

Create a new command component builder for the provided component decoder using the provided string mode.

Type Parameters:

C - Command sender type

Parameters:

componentDecoder - the component decoder

stringMode - the string mode to use

Returns:

the command component builder

Since:

2.0.0

parse

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

Specified by:

parse in interface ArgumentParser<C,Component>

stringMode

@API(status=STABLE,
     since="2.0.0")
public @NonNull StringParser.StringMode stringMode()

Returns the string mode used by this parser.

Returns:

the string mode

Since:

2.0.0

componentDecoder

@API(status=STABLE,
     since="2.0.0")
public @NonNull Function<String,? extends Component> componentDecoder()

Returns the component decoder used by this parser.

Returns:

the component decoder

Since:

2.0.0