me.lucko.helper.command.argument

Interface ArgumentParser<T>

Type Parameters:

T - the value type

@NonnullByDefault
public interface ArgumentParser<T>

Parses an argument from a String

Method Summary

Modifier and Type	Method and Description
default CommandInterruptException	generateException(int missingArgumentIndex) Generates a CommandInterruptException for when parsing fails due to the lack of an argument.
default CommandInterruptException	generateException(String s) Generates a CommandInterruptException for when parsing fails with the given content.
static <T> ArgumentParser<T>	of(Function<String,Optional<T>> parseFunction)
static <T> ArgumentParser<T>	of(Function<String,Optional<T>> parseFunction, Function<String,CommandInterruptException> generateExceptionFunction)
default Optional<T>	parse(Argument argument) Tries to parse the value from the argument
Optional<T>	parse(String s) Parses the value from a string
default T	parseOrFail(Argument argument) Parses the value from an argument, throwing an interrupt exception if parsing failed.
default T	parseOrFail(String s) Parses the value from a string, throwing an interrupt exception if parsing failed.
default ArgumentParser<T>	thenTry(ArgumentParser<T> other) Creates a new parser which first tries to obtain a value from this parser, then from another if the former was not successful.

Method Detail

of

static <T> ArgumentParser<T> of(Function<String,Optional<T>> parseFunction)

of

static <T> ArgumentParser<T> of(Function<String,Optional<T>> parseFunction,
                                Function<String,CommandInterruptException> generateExceptionFunction)

parse

Optional<T> parse(@Nonnull
                  String s)

Parses the value from a string

Parameters:

s - the string

Returns:

the value, if parsing was successful

generateException

default CommandInterruptException generateException(@Nonnull
                                                    String s)

Generates a CommandInterruptException for when parsing fails with the given content.

Parameters:

s - the string input

Returns:

the exception

generateException

default CommandInterruptException generateException(int missingArgumentIndex)

Generates a CommandInterruptException for when parsing fails due to the lack of an argument.

Parameters:

missingArgumentIndex - the missing argument index

Returns:

the exception

parseOrFail

@Nonnull
default T parseOrFail(@Nonnull
                               String s)
                        throws CommandInterruptException

Parses the value from a string, throwing an interrupt exception if parsing failed.

Parameters:

s - the string

Returns:

the value

Throws:

CommandInterruptException

parse

@Nonnull
default Optional<T> parse(@Nonnull
                                   Argument argument)

Tries to parse the value from the argument

Parameters:

argument - the argument

Returns:

the value, if parsing was successful

parseOrFail

@Nonnull
default T parseOrFail(@Nonnull
                               Argument argument)
                        throws CommandInterruptException

Parses the value from an argument, throwing an interrupt exception if parsing failed.

Parameters:

argument - the argument

Returns:

the value

Throws:

CommandInterruptException

thenTry

@Nonnull
default ArgumentParser<T> thenTry(@Nonnull
                                           ArgumentParser<T> other)

Creates a new parser which first tries to obtain a value from this parser, then from another if the former was not successful.

Parameters:

other - the other parser

Returns:

the combined parser