Package studio.mevera.imperat.context

Interface SuggestionContext<S extends CommandSource>

Type Parameters:

S - the command-source

All Superinterfaces:

CommandContext<S>

public interface SuggestionContext<S extends CommandSource>
extends CommandContext<S>

Represents the context for auto-completion while providing suggestions

Method Summary

Modifier and Type	Method	Description
@NotNull CompletionArg	getArgToComplete()
boolean	isFlagPosition(int depth)	Checks whether the current input at index is a flag

Methods inherited from interface studio.mevera.imperat.context.CommandContext

arguments, command, getRootCommandLabelUsed, imperat, imperatConfig, source

Method Details

getArgToComplete

@NotNull
@NotNull CompletionArg getArgToComplete()

Returns:

The info about the argument being completed

isFlagPosition

boolean isFlagPosition(int depth)

Checks whether the current input at index is a flag

Parameters:

depth - the index in the input ArgumentInput

Returns:

Whether the input at the given depth/index is a flag.