Package net.apartium.cocoabeans.commands.parsers

Class ParagraphParser

java.lang.Object

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

net.apartium.cocoabeans.commands.parsers.ParagraphParser

All Implemented Interfaces:

Comparable<ArgumentParser<?>>

@AvailableSince("0.0.36")
public class ParagraphParser
extends ArgumentParser<String>

Parsers that let you press strings that are more than one word and are limited by using quotation marks and has support for new lines
Example
Input /test Hello\nWorld
Output Hello
World

See Also:

• LongStringParser

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
static final char	ESCAPE_CHARACTER
static final String	INVALID_QUOTATION_MESSAGE
static final char	NEW_LINE_CHARACTER
static final char	QUOTATION_CHARACTER

Constructor Summary

Constructors

Constructor	Description
ParagraphParser(int priority)	Creates paragraph parser
ParagraphParser(int priority, String keyword)	Creates paragraph 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

ESCAPE_CHARACTER

public static final char ESCAPE_CHARACTER

See Also:

• Constant Field Values

QUOTATION_CHARACTER

public static final char QUOTATION_CHARACTER

See Also:

• Constant Field Values

NEW_LINE_CHARACTER

public static final char NEW_LINE_CHARACTER

See Also:

• Constant Field Values

INVALID_QUOTATION_MESSAGE

public static final String INVALID_QUOTATION_MESSAGE

See Also:

• Constant Field Values

Constructor Details

ParagraphParser

public ParagraphParser(int priority,
 String keyword)

Creates paragraph parser

Parameters:

priority - priority of the parser

keyword - keyword that should be used

ParagraphParser

public ParagraphParser(int priority)

Creates paragraph parser

Parameters:

priority - priority of the parser

Method Details

parse

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

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)

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)

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