Package net.apartium.cocoabeans.commands.parsers

Class ContextualMapBasedParser<T>

java.lang.Object

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

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

Type Parameters:

T - result type

All Implemented Interfaces:

Comparable<ArgumentParser<?>>

Direct Known Subclasses:

MapBasedParser

@AvailableSince("0.0.39")
public abstract class ContextualMapBasedParser<T>
extends ArgumentParser<T>

Contextual Map-based parser that map of keyword to value When Map entry not found report NoSuchElementInMapResponse

See Also:

• MapBasedParser

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	ContextualMapBasedParser(String keyword, Class<T> clazz, int priority)	Constructor
protected	ContextualMapBasedParser(String keyword, Class<T> clazz, int priority, boolean ignoreCase)	Constructor with an ignoreCase
protected	ContextualMapBasedParser(String keyword, Class<T> clazz, int priority, boolean ignoreCase, boolean lax)	Constructor with an ignoreCase and lax

Method Summary

Modifier and Type	Method	Description
abstract Map<String,T>	getMap(CommandProcessingContext context)	If you want to ignore case to be applied, then remember to lowercase the keyword
Optional<ArgumentParser.ParseResult<T>>	parse(CommandProcessingContext commandProcessingContext)	Tries to parse next argument in the context
Optional<ArgumentParser.TabCompletionResult>	tabCompletion(CommandProcessingContext commandProcessingContext)	Retrieves available options for tab completion of this argument
OptionalInt	tryParse(CommandProcessingContext commandProcessingContext)	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

ContextualMapBasedParser

protected ContextualMapBasedParser(String keyword,
 Class<T> clazz,
 int priority)

Constructor

Parameters:

keyword - keyword

clazz - result class

priority - priority

ContextualMapBasedParser

protected ContextualMapBasedParser(String keyword,
 Class<T> clazz,
 int priority,
 boolean ignoreCase)

Constructor with an ignoreCase

Parameters:

keyword - keyword

clazz - result class

priority - priority

ignoreCase - whether is it case-sensitive or not

ContextualMapBasedParser

protected ContextualMapBasedParser(String keyword,
 Class<T> clazz,
 int priority,
 boolean ignoreCase,
 boolean lax)

Constructor with an ignoreCase and lax

Parameters:

keyword - keyword

clazz - result class

priority - priority

ignoreCase - whether is it case-sensitive or not

lax - lazy mapping

Method Details

getMap

public abstract Map<String,T> getMap(CommandProcessingContext context)

If you want to ignore case to be applied, then remember to lowercase the keyword

Parameters:

context - the context that you can use to change the map for it

Returns:

map of keyword to value

parse

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

Description copied from class: ArgumentParser

Tries to parse next argument in the context

Specified by:

parse in class ArgumentParser<T>

Parameters:

commandProcessingContext - cmd processing context

Returns:

empty if failed, otherwise result

tryParse

public OptionalInt tryParse(CommandProcessingContext commandProcessingContext)

Description copied from class: ArgumentParser

Tries to lazily parse next argument in the context

Specified by:

tryParse in class ArgumentParser<T>

Parameters:

commandProcessingContext - cmd processing context

Returns:

new index int if success, empty if not

tabCompletion

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

Description copied from class: ArgumentParser

Retrieves available options for tab completion of this argument

Specified by:

tabCompletion in class ArgumentParser<T>

Parameters:

commandProcessingContext - cmd processing context

Returns:

tab completion result if success, otherwise empty option