Package net.apartium.cocoabeans.commands.parsers

Class MapBasedParser<T>

java.lang.Object

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

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

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

Type Parameters:

T - result type

All Implemented Interfaces:

Comparable<ArgumentParser<?>>

public abstract class MapBasedParser<T>
extends ContextualMapBasedParser<T>

Map-based parser that map of keyword to value When Map entry not found report NoSuchElementInMapResponse Unlike ContextualMapBasedParser MapBasedParser doesn't care for context

See Also:

• SourceParser
• ContextualMapBasedParser

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

Method Summary

Modifier and Type	Method	Description
abstract Map<String,T>	getMap()	If you want to ignore case to be applied, then remember to lowercase the keyword
Map<String,T>	getMap(CommandProcessingContext context)	If you want to ignore case to be applied, then remember to lowercase the keyword

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

parse, tabCompletion, tryParse

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

MapBasedParser

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

Constructor

Parameters:

keyword - keyword

clazz - result class

priority - priority

MapBasedParser

@AvailableSince("0.0.30")
protected MapBasedParser(String keyword,
 Class<T> clazz,
 int priority,
 boolean ignoreCase)

Constructor with ignoreCase

Parameters:

keyword - keyword

clazz - result class

priority - priority

ignoreCase - whether is it case-sensitive or not

MapBasedParser

@AvailableSince("0.0.30")
protected MapBasedParser(String keyword,
 Class<T> clazz,
 int priority,
 boolean ignoreCase,
 boolean lax)

Constructor with 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()

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

Returns:

map of keyword to value

getMap

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

Description copied from class: ContextualMapBasedParser

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

Specified by:

getMap in class ContextualMapBasedParser<T>

Parameters:

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

Returns:

map of keyword to value