Module io.github.darvil.lanat

Package io.github.darvil.lanat.parsing

Class Parser

java.lang.Object

io.github.darvil.lanat.utils.errors.ErrorContainerImpl<T>

io.github.darvil.lanat.parsing.ParsingStateBase<Error.ParseError>

io.github.darvil.lanat.parsing.Parser

All Implemented Interfaces:

ErrorContainer<Error.ParseError>, Resettable

public final class Parser
extends ParsingStateBase<Error.ParseError>

Parses the tokens that have been tokenized from the CLI input.

This class is responsible for parsing the tokens and delegating the parsing of the values to the ArgumentTypes of the arguments that are being parsed.

When finished parsing, this class will contain a map of the arguments to their parsed values. This map can be accessed by calling getParsedArgsMap().

Field Summary

Fields inherited from class io.github.darvil.lanat.parsing.ParsingStateBase

command, hasFinished, nestingOffset

Constructor Summary

Constructors

Constructor	Description
Parser(@NotNull Command command)

Method Summary

Modifier and Type	Method	Description
int	getCurrentTokenIndex()	Returns the index of the current token that is being parsed.
@Nullable String	getForwardValue()	Returns the forward value if one was found.
@NotNull HashMap<@NotNull Argument<?,?>,@Nullable Object>	getParsedArgsMap()	Returns a hashmap of Arguments and their corresponding parsed values.
void	parseTokens(@Nullable Parser previousParser)	Parses the tokens that have been set.
void	setTokens(@NotNull List<@NotNull Token> tokens)	Sets the tokens that this parser will parse.

Methods inherited from class io.github.darvil.lanat.parsing.ParsingStateBase

getMatchingArgument, getMatchingArgument, getNestingOffset, hasFinished, resetState, runForMatchingArgument, runForMatchingArgument

Methods inherited from class io.github.darvil.lanat.utils.errors.ErrorContainerImpl

addError, getErrorDisplayThreshold, getErrorExitThreshold, getErrorsUnderDisplayThreshold, getErrorsUnderExitThreshold, getErrorsUnderThreshold, hasDisplayErrors, hasExitErrors, setErrorDisplayThreshold, setErrorExitThreshold

Methods inherited from class java.lang.Object

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

Constructor Details

Parser

public Parser(@NotNull
 @NotNull Command command)

Method Details

getCurrentTokenIndex

public int getCurrentTokenIndex()

Returns the index of the current token that is being parsed.

getForwardValue

@Nullable
public @Nullable String getForwardValue()

Returns the forward value if one was found.

Returns:

The forward value, or null if there is no forward value.

setTokens

public void setTokens(@NotNull
 @NotNull List<@NotNull Token> tokens)

Sets the tokens that this parser will parse.

parseTokens

public void parseTokens(@Nullable
 @Nullable Parser previousParser)

Parses the tokens that have been set. Delegates parsing of argument values to the ArgumentType of the argument that is being parsed.

getParsedArgsMap

@NotNull
public @NotNull HashMap<@NotNull Argument<?,?>,@Nullable Object> getParsedArgsMap()

Returns a hashmap of Arguments and their corresponding parsed values. This function invokes the Argument.finishParsing() method on each argument the first time it is called. After that, it will return the same hashmap.