de.weltraumschaf.commons.shell

Class LiteralCommandMap

java.lang.Object

de.weltraumschaf.commons.shell.LiteralCommandMap

public abstract class LiteralCommandMap
extends Object

Maps the literal string of an command to its enum type. This class is not thread safe!

Since:

1.0.0

Author:

Sven Strittmatter

Field Summary

Fields

Modifier and Type	Field and Description
private SubCommandType	defaultSubCommand Default sub command for commands w/o sub commands.
private Map<String,MainCommandType>	mainCommands Map the literal command string to corresponding type enum.
private Map<String,SubCommandType>	subCommands Map the literal sub command string to corresponding type enum.

Constructor Summary

Constructors

Constructor and Description
LiteralCommandMap(SubCommandType defaultSubCommand) Dedicated constructor.

Method Summary

Methods

Modifier and Type	Method and Description
MainCommandType	determineCommand(Token t) Determines the appropriate main command type for given string token.
SubCommandType	determineSubCommand(Token t) Determines the appropriate sub command type for given string token.
SubCommandType	getDefaultSubCommand() Get the default sub command for commands w/o sub commands.
protected abstract Class<? extends MainCommandType>	getMainCommandType() Return here the enum type which declares your main commands.
protected abstract Class<? extends SubCommandType>	getSubCommandType() Return here the enum type which declares your sub commands.
private void	init() Not overideable template method called in constructor.
private void	initMainCommandMap() Initializes the command map.
private void	initSubCommandMap() Initializes the sub command map.
boolean	isCommand(String token) Determines if the string literal value is a main command.
boolean	isCommand(Token token) Determines if the string literal value of the token is a main command.
boolean	isSubCommand(String token) Determines if the string literal value is a sub command.
boolean	isSubCommand(Token token) Determines if the string literal value of the token is a sub command.

Methods inherited from class java.lang.Object

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

Field Detail

mainCommands

private final Map<String,MainCommandType> mainCommands

Map the literal command string to corresponding type enum.

subCommands

private final Map<String,SubCommandType> subCommands

Map the literal sub command string to corresponding type enum.

defaultSubCommand

private final SubCommandType defaultSubCommand

Default sub command for commands w/o sub commands.

Constructor Detail

LiteralCommandMap

public LiteralCommandMap(SubCommandType defaultSubCommand)

Dedicated constructor.

Parameters:

defaultSubCommand - sub command used for commands w/o sub command, usually a NONE type, must not be null

Method Detail

isCommand

public final boolean isCommand(Token token)

Determines if the string literal value of the token is a main command.

Parameters:

token - token to check

Returns:

true if the token is a command else false

isCommand

public final boolean isCommand(String token)

Determines if the string literal value is a main command.

Parameters:

token - token string to check

Returns:

true if the token is a command else false

determineCommand

public final MainCommandType determineCommand(Token t)

Determines the appropriate main command type for given string token. Determining a non command token string will result in an exception.

Parameters:

t - token to check

Returns:

command main type // CHECKSTYLE:OFF

Throws:

IllegalArgumentException - if, token is not a main command // CHECKSTYLE:ON

isSubCommand

public final boolean isSubCommand(Token token)

Determines if the string literal value of the token is a sub command.

Parameters:

token - token to check

Returns:

true if the token is a sub command else false

isSubCommand

public final boolean isSubCommand(String token)

Determines if the string literal value is a sub command.

Parameters:

token - token string to check

Returns:

true if the token is a sub command else false

determineSubCommand

public final SubCommandType determineSubCommand(Token t)

Determines the appropriate sub command type for given string token. Determining a non sub command token string will result in an exception.

Parameters:

t - token to check

Returns:

command sub type // CHECKSTYLE:OFF

Throws:

IllegalArgumentException - if, token is not a sub command // CHECKSTYLE:ON

getDefaultSubCommand

public final SubCommandType getDefaultSubCommand()

Get the default sub command for commands w/o sub commands. Usually your sub command enum should specify a special type for a non sub command.

Returns:

the enum type of the "none" sub command

getMainCommandType

protected abstract Class<? extends MainCommandType> getMainCommandType()

Return here the enum type which declares your main commands.

Returns:

never null

initMainCommandMap

private void initMainCommandMap()

Initializes the command map.

initSubCommandMap

private void initSubCommandMap()

Initializes the sub command map.

getSubCommandType

protected abstract Class<? extends SubCommandType> getSubCommandType()

Return here the enum type which declares your sub commands.

Returns:

never null

init

private void init()

Not overideable template method called in constructor.