Package studio.mevera.imperat.command.flags

Interface FlagExtractor<S extends Source>

Type Parameters:

S - the type of the command source

@AvailableSince("1.9.6")
public sealed interface FlagExtractor<S extends Source>

A class that extracts flags from a single string/argument.

Method Summary

Modifier and Type	Method	Description
static <S extends Source> FlagExtractor<S>	createNative(CommandUsage<S> usage)
Set<FlagData<S>>	extract(String rawInput, Context<S> ctx)	Extracts all flags used from a single string with no spaces.
void	insertFlag(FlagData<S> flagData)	Inserts a flag during into the trie.

Method Details

insertFlag

void insertFlag(FlagData<S> flagData)

Inserts a flag during into the trie. May be useful if it's necessary to insert a flag during runtime.

Parameters:

flagData - the FlagData to insert

extract

Set<FlagData<S>> extract(String rawInput,
 Context<S> ctx)
                  throws UnknownFlagException

Extracts all flags used from a single string with no spaces.

Parameters:

rawInput - the raw input of an argument

ctx -

Returns:

the extracted FlagData for flags.

Throws:

UnknownFlagException

createNative

static <S extends Source> FlagExtractor<S> createNative(CommandUsage<S> usage)