me.vaperion.blade.tokenizer.input

Class CommandInput

java.lang.Object

me.vaperion.blade.tokenizer.input.CommandInput

public final class CommandInput
extends java.lang.Object

Represents the tokenized form of a command input string.

This should be initialized with the whole input string, e.g.: /mycommand -b param1 -f flagValue param2

While this class technically supports null commands, that should only be used in special circumstances, such as when tokenizing for sub-command suggestions.

Constructor Summary

Constructors

Constructor and Description
CommandInput(@NotNull Blade blade, @Nullable BladeCommand command, @NotNull java.lang.String input)
CommandInput(@NotNull Blade blade, @Nullable BladeCommand command, @NotNull java.lang.String input, @NotNull java.util.EnumSet<InputOption> options)
CommandInput(@NotNull Blade blade, @Nullable BladeCommand command, @NotNull java.lang.String input, InputOption... options)

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.List<ArgumentToken>	arguments() Get all argument tokens.
@Nullable BladeCommand	bladeCommand() Get the associated BladeCommand.
boolean	endsInWhitespace() Check if the input string ended with whitespace.
void	ensureTokenized() Ensure that the input has been tokenized.
@NotNull java.util.List<FlagToken>	flags() Get all flag tokens.
@NotNull java.lang.String	input() Get the original input string.
@NotNull java.util.Optional<LabelToken>	label() Get the label token, if present.
boolean	mergeTokensToFormWholeLabel(@NotNull java.lang.String wholeLabel) Merge tokens to form the given whole label.
<T extends Token> @NotNull java.util.stream.Stream<T>	ofType(@NotNull java.lang.Class<T> tokenClass) Get a stream of tokens of the specified type.
@NotNull java.util.EnumSet<InputOption>	options() Get the input options used during tokenization.
void	tokenize() Tokenize the input command string.
@NotNull @Unmodifiable java.util.List<Token>	tokens() Get the list of tokens produced by tokenization.
java.lang.String	toString()
@NotNull java.lang.String	unslashedInput() Get the original input string without a leading slash.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandInput

public CommandInput(@NotNull
                    @NotNull Blade blade,
                    @Nullable
                    @Nullable BladeCommand command,
                    @NotNull
                    @NotNull java.lang.String input)

CommandInput

public CommandInput(@NotNull
                    @NotNull Blade blade,
                    @Nullable
                    @Nullable BladeCommand command,
                    @NotNull
                    @NotNull java.lang.String input,
                    @NotNull
                    InputOption... options)

CommandInput

public CommandInput(@NotNull
                    @NotNull Blade blade,
                    @Nullable
                    @Nullable BladeCommand command,
                    @NotNull
                    @NotNull java.lang.String input,
                    @NotNull
                    @NotNull java.util.EnumSet<InputOption> options)

Method Detail

unslashedInput

@NotNull
public @NotNull java.lang.String unslashedInput()

Get the original input string without a leading slash.

Returns:

the unslashed input string

input

@NotNull
public @NotNull java.lang.String input()

Get the original input string.

Returns:

the input string

bladeCommand

@Nullable
public @Nullable BladeCommand bladeCommand()

Get the associated BladeCommand.

Returns:

the BladeCommand

options

@NotNull
public @NotNull java.util.EnumSet<InputOption> options()

Get the input options used during tokenization.

Returns:

an unmodifiable set of input options

tokens

@NotNull
public @NotNull @Unmodifiable java.util.List<Token> tokens()

Get the list of tokens produced by tokenization.

Returns:

an unmodifiable list of tokens

endsInWhitespace

public boolean endsInWhitespace()

Check if the input string ended with whitespace.

Returns:

true if the input ended with whitespace, false otherwise

label

@NotNull
public @NotNull java.util.Optional<LabelToken> label()

Get the label token, if present.

arguments

@NotNull
public @NotNull java.util.List<ArgumentToken> arguments()

Get all argument tokens.

flags

@NotNull
public @NotNull java.util.List<FlagToken> flags()

Get all flag tokens.

ofType

@NotNull
public <T extends Token> @NotNull java.util.stream.Stream<T> ofType(@NotNull
                                                                             @NotNull java.lang.Class<T> tokenClass)

Get a stream of tokens of the specified type.

Type Parameters:

T - the type of the token

Parameters:

tokenClass - the class of the token type to filter by

Returns:

a stream of tokens of the specified type

ensureTokenized

public void ensureTokenized()
                     throws TokenizerError

Ensure that the input has been tokenized.

Throws:

TokenizerError - if a tokenization error occurs

tokenize

public void tokenize()
              throws TokenizerError

Tokenize the input command string.

Throws:

TokenizerError - if a tokenization error occurs

mergeTokensToFormWholeLabel

public boolean mergeTokensToFormWholeLabel(@NotNull
                                           @NotNull java.lang.String wholeLabel)

Merge tokens to form the given whole label.

This means that parameter tokens after the label will be deleted, and merged according to the given whole label.

For example:
- Tokens: [label: "my", arg: "command", arg: "param1"]
- Whole label: "my command"
- Resulting tokens: [label: "my command", arg: "param1"]

Parameters:

wholeLabel - the whole label

Returns:

true if the merge was successful, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object