Package net.apartium.cocoabeans.commands.parsers

Class CompoundParser<T>

java.lang.Object

net.apartium.cocoabeans.commands.parsers.ArgumentParser<T>

net.apartium.cocoabeans.commands.parsers.CompoundParser<T>

All Implemented Interfaces:

Comparable<ArgumentParser<?>>, GenericNode

@AvailableSince("0.0.37")
public class CompoundParser<T>
extends ArgumentParser<T>
implements GenericNode

Nested Class Summary

Nested classes/interfaces inherited from class net.apartium.cocoabeans.commands.parsers.ArgumentParser

ArgumentParser.ParseResult<T>, ArgumentParser.TabCompletionResult

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompoundParser(String keyword, Class<T> clazz, int priority, ArgumentMapper argumentMapper, CommandLexer commandLexer)	Deprecated, for removal: This API element is subject to removal in a future version.
protected	CompoundParser(String keyword, Class<T> clazz, int priority, EvaluationContext evaluationContext)	Constructs a new parser

Method Summary

Modifier and Type	Method	Description
Optional<ArgumentParser.ParseResult<T>>	parse(CommandProcessingContext processingContext)	Tries to parse next argument in the context
Optional<ArgumentParser.TabCompletionResult>	tabCompletion(CommandProcessingContext processingContext)	Retrieves available options for tab completion of this argument
OptionalInt	tryParse(CommandProcessingContext processingContext)	Tries to lazily parse next argument in the context

Methods inherited from class net.apartium.cocoabeans.commands.parsers.ArgumentParser

compareTo, getArgumentType, getKeyword, getPriority

Methods inherited from class java.lang.Object

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

Constructor Details

CompoundParser

@Deprecated(since="0.0.38",
            forRemoval=true)
protected CompoundParser(String keyword,
 Class<T> clazz,
 int priority,
 ArgumentMapper argumentMapper,
 CommandLexer commandLexer)

Deprecated, for removal: This API element is subject to removal in a future version.

Constructs a new parser

Parameters:

keyword - keyword of the parser

clazz - output class

priority - priority

argumentMapper - argument mapper

commandLexer - command lexer

CompoundParser

@AvailableSince("0.0.38")
protected CompoundParser(String keyword,
 Class<T> clazz,
 int priority,
 EvaluationContext evaluationContext)

Constructs a new parser

Parameters:

keyword - keyword of the parser

clazz - output class

priority - priority

evaluationContext - evaluation context

Method Details

parse

public Optional<ArgumentParser.ParseResult<T>> parse(CommandProcessingContext processingContext)

Description copied from class: ArgumentParser

Tries to parse next argument in the context

Specified by:

parse in class ArgumentParser<T>

Parameters:

processingContext - cmd processing context

Returns:

empty if failed, otherwise result

tryParse

public OptionalInt tryParse(CommandProcessingContext processingContext)

Description copied from class: ArgumentParser

Tries to lazily parse next argument in the context

Specified by:

tryParse in class ArgumentParser<T>

Parameters:

processingContext - cmd processing context

Returns:

new index int if success, empty if not

tabCompletion

public Optional<ArgumentParser.TabCompletionResult> tabCompletion(CommandProcessingContext processingContext)

Description copied from class: ArgumentParser

Retrieves available options for tab completion of this argument

Specified by:

tabCompletion in class ArgumentParser<T>

Parameters:

processingContext - cmd processing context

Returns:

tab completion result if success, otherwise empty option