dev.rollczi.litecommands.argument.parser

Interface Parser<SENDER,PARSED>

All Superinterfaces:

Matcher<SENDER,PARSED>, Rangeable<Argument<PARSED>>

All Known Subinterfaces:

ArgumentResolverBase<SENDER,PARSED>, MultipleArgumentResolver<SENDER,TYPE>

All Known Implementing Classes:

AbstractCollectorArgumentResolver, ArgumentResolver, ArrayArgumentResolver, ArrayListArgumentResolver, BigDecimalArgumentResolver, BigIntegerArgumentResolver, BooleanArgumentResolver, CollectionArgumentResolver, DurationArgumentResolver, EnumArgumentResolver, FlagArgumentResolver, InstantArgumentResolver, JoinArgumentResolver, JoinStringArgumentResolver, LinkedHashSetArgumentResolver, LinkedListArgumentResolver, LiteralArgumentResolver, LocalDateTimeArgumentResolver, NullableArgumentResolver, NumberArgumentResolver, PeriodArgumentResolver, ProfiledMultipleArgumentResolver, ProfiledParser, QuotedStringArgumentResolver, SetArgumentResolver, StackArgumentResolver, StringArgumentResolver, TreeSetArgumentResolver, UUIDArgumentResolver, VectorArgumentResolver

public interface Parser<SENDER,PARSED>
extends Matcher<SENDER,PARSED>, Rangeable<Argument<PARSED>>

Method Summary

Modifier and Type	Method and Description
default boolean	canParse(Argument<PARSED> argument) This method is used to check if the argument can be parsed by the parser.
default boolean	match(Invocation<SENDER> invocation, Argument<PARSED> argument, RawInput input) This method is used to check if the input can be parsed by the parser.
ParseResult<PARSED>	parse(Invocation<SENDER> invocation, Argument<PARSED> argument, RawInput input) This method is used to parse the input and return the result.

Methods inherited from interface dev.rollczi.litecommands.range.Rangeable

getRange

Method Detail

parse

ParseResult<PARSED> parse(Invocation<SENDER> invocation,
                          Argument<PARSED> argument,
                          RawInput input)

This method is used to parse the input and return the result.

canParse

default boolean canParse(Argument<PARSED> argument)

This method is used to check if the argument can be parsed by the parser. (pre-parsing check)

match

@ApiStatus.Experimental
default boolean match(Invocation<SENDER> invocation,
                                              Argument<PARSED> argument,
                                              RawInput input)

This method is used to check if the input can be parsed by the parser. It is used in the suggestion system. (you can override it to provide custom behavior and improve performance)

Specified by:

match in interface Matcher<SENDER,PARSED>