Package net.apartium.cocoabeans.commands.parsers

Class StringParser

java.lang.Object

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

net.apartium.cocoabeans.commands.parsers.StringParser

All Implemented Interfaces:

Comparable<ArgumentParser<?>>

public class StringParser
extends ArgumentParser<String>

Nested Class Summary

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

ArgumentParser.ParseResult<T>, ArgumentParser.TabCompletionResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_KEYWORD

Constructor Summary

Constructors

Constructor	Description
StringParser(int priority)	Creates a new string parser
StringParser(int priority, String keyword)	Creates a new string parser

Method Summary

Modifier and Type	Method	Description
Optional<ArgumentParser.ParseResult<String>>	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

Field Details

DEFAULT_KEYWORD

public static final String DEFAULT_KEYWORD

See Also:

• Constant Field Values

Constructor Details

StringParser

@AvailableSince("0.0.36")
public StringParser(int priority,
 String keyword)

Creates a new string parser

Parameters:

priority - parser priority of which should be higher than others or lower

keyword - parser keyword

StringParser

public StringParser(int priority)

Creates a new string parser

Parameters:

priority - parser priority of which should be higher than others or lower

Method Details

parse

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

Description copied from class: ArgumentParser

Tries to parse next argument in the context

Specified by:

parse in class ArgumentParser<String>

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<String>

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<String>

Parameters:

processingContext - cmd processing context

Returns:

tab completion result if success, otherwise empty option