dev.rollczi.litecommands.argument.profile

Class ProfiledMultipleArgumentResolver<SENDER,T,PROFILE>

java.lang.Object

dev.rollczi.litecommands.argument.profile.ProfiledMultipleArgumentResolver<SENDER,T,PROFILE>

All Implemented Interfaces:

Matcher<SENDER,T>, Parser<SENDER,T>, ArgumentResolverBase<SENDER,T>, MultipleArgumentResolver<SENDER,T>, Suggester<SENDER,T>, Rangeable<Argument<T>>

Direct Known Subclasses:

AbstractCollectorArgumentResolver, FlagArgumentResolver, LiteralArgumentResolver, NullableArgumentResolver, QuotedStringArgumentResolver

@ApiStatus.Experimental
public abstract class ProfiledMultipleArgumentResolver<SENDER,T,PROFILE>
extends java.lang.Object
implements MultipleArgumentResolver<SENDER,T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProfiledMultipleArgumentResolver(ArgumentProfileNamespace<PROFILE> namespace)

Method Summary

Modifier and Type	Method and Description
boolean	canParse(Argument<T> argument) This method is used to check if the argument can be parsed by the parser.
protected boolean	canParse(Argument<T> argument, PROFILE profile)
Range	getRange(Argument<T> argument)
protected abstract Range	getRange(Argument<T> argument, PROFILE profile)
boolean	match(Invocation<SENDER> invocation, Argument<T> argument, RawInput input) This method is used to check if the input can be parsed by the parser.
protected boolean	match(Invocation<SENDER> invocation, Argument<T> argument, RawInput input, PROFILE profile)
ParseResult<T>	parse(Invocation<SENDER> invocation, Argument<T> argument, RawInput input) This method is used to parse the input and return the result.
protected abstract ParseResult<T>	parse(Invocation<SENDER> invocation, Argument<T> argument, RawInput rawInput, PROFILE profile)
SuggestionResult	suggest(Invocation<SENDER> invocation, Argument<T> argument, SuggestionContext context)
protected SuggestionResult	suggest(Invocation<SENDER> invocation, Argument<T> argument, SuggestionContext context, PROFILE profile)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.rollczi.litecommands.argument.parser.Parser

of

Constructor Detail

ProfiledMultipleArgumentResolver

protected ProfiledMultipleArgumentResolver(ArgumentProfileNamespace<PROFILE> namespace)

Method Detail

canParse

public final boolean canParse(Argument<T> argument)

Description copied from interface: Parser

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

Specified by:

canParse in interface Parser<SENDER,T>

canParse

protected boolean canParse(Argument<T> argument,
                           PROFILE profile)

parse

public final ParseResult<T> parse(Invocation<SENDER> invocation,
                                  Argument<T> argument,
                                  RawInput input)

Description copied from interface: Parser

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

Specified by:

parse in interface Parser<SENDER,T>

parse

protected abstract ParseResult<T> parse(Invocation<SENDER> invocation,
                                        Argument<T> argument,
                                        RawInput rawInput,
                                        PROFILE profile)

getRange

public final Range getRange(Argument<T> argument)

Specified by:

getRange in interface Rangeable<Argument<T>>

getRange

protected abstract Range getRange(Argument<T> argument,
                                  PROFILE profile)

suggest

public final SuggestionResult suggest(Invocation<SENDER> invocation,
                                      Argument<T> argument,
                                      SuggestionContext context)

Specified by:

suggest in interface MultipleArgumentResolver<SENDER,T>

Specified by:

suggest in interface Suggester<SENDER,T>

suggest

protected SuggestionResult suggest(Invocation<SENDER> invocation,
                                   Argument<T> argument,
                                   SuggestionContext context,
                                   PROFILE profile)

match

public final boolean match(Invocation<SENDER> invocation,
                           Argument<T> argument,
                           RawInput input)

Description copied from interface: Parser

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,T>

Specified by:

match in interface Parser<SENDER,T>

match

protected boolean match(Invocation<SENDER> invocation,
                        Argument<T> argument,
                        RawInput input,
                        PROFILE profile)