me.lucko.helper.command.argument

Interface Argument

All Known Implementing Classes:

SimpleArgument

public interface Argument

Represents a command argument

Method Summary

Modifier and Type	Method and Description
default void	assertPresent() Asserts that the permission is present
int	index() Gets the index of the argument
boolean	isPresent() Gets if the argument is present
default <T> Optional<T>	parse(ArgumentParser<T> parser)
default <T> Optional<T>	parse(Class<T> clazz)
default <T> Optional<T>	parse(TypeToken<T> type)
default <T> T	parseOrFail(ArgumentParser<T> parser)
default <T> T	parseOrFail(Class<T> clazz)
default <T> T	parseOrFail(TypeToken<T> type)
Optional<String>	value() Gets the value of the argument

Method Detail

index

int index()

Gets the index of the argument

Returns:

the index

value

@Nonnull
Optional<String> value()

Gets the value of the argument

Returns:

the value

parse

@Nonnull
default <T> Optional<T> parse(@Nonnull
                                        ArgumentParser<T> parser)

parseOrFail

@Nonnull
default <T> T parseOrFail(@Nonnull
                                    ArgumentParser<T> parser)
                             throws CommandInterruptException

Throws:

CommandInterruptException

parse

@Nonnull
default <T> Optional<T> parse(@Nonnull
                                        TypeToken<T> type)

parseOrFail

@Nonnull
default <T> T parseOrFail(@Nonnull
                                    TypeToken<T> type)
                             throws CommandInterruptException

Throws:

CommandInterruptException

parse

@Nonnull
default <T> Optional<T> parse(@Nonnull
                                        Class<T> clazz)

parseOrFail

@Nonnull
default <T> T parseOrFail(@Nonnull
                                    Class<T> clazz)
                             throws CommandInterruptException

Throws:

CommandInterruptException

isPresent

boolean isPresent()

Gets if the argument is present

Returns:

true if present

assertPresent

default void assertPresent()
                    throws CommandInterruptException

Asserts that the permission is present

Throws:

CommandInterruptException