openbook.tools

Class CommandProcessor

java.lang.Object

openbook.tools.CommandProcessor

public class CommandProcessor
extends Object

Processes options.
User can register a set of command options. Then this processor will parse a set of Strings to store the values for each of the registered options as well as optionally any unrecognized option values.

Author:

Pinaki Poddar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandProcessor.Option A simple immutable object represents meta-data about a command option.

Constructor Summary

Constructors

Constructor and Description
CommandProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
CommandProcessor.Option	findCommand(String option) Finds a command with the given name.
boolean	getAllowsUnregisteredOption()
Set<CommandProcessor.Option>	getUnregisteredCommands() Gets all the unrecognized command options.
String	getValue(String alias) Gets value of the option matching the given alias.
int	lastIndex(String[] args) Gets the last index in the given array that can be processed as an option.
CommandProcessor.Option	register(boolean requiresValue, String... aliases) Register the given aliases as a command option.
void	setAllowsUnregisteredOption(boolean allowsUnregisteredOption)
String[]	setFrom(String[] args) Set the option values from the given arguments.
String[]	setFrom(String[] args, int from, int to) Set the option values from the given arguments between the given indices.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandProcessor

public CommandProcessor()

Method Detail

setFrom

public String[] setFrom(String[] args)

Set the option values from the given arguments. All elements of the given array is not consumed, only till the index that appears to be a valid option.

Parameters:

args - an array of arguments.

Returns:

the array elements that are not consumed.

See Also:

lastIndex(String[])

setFrom

public String[] setFrom(String[] args,
               int from,
               int to)

Set the option values from the given arguments between the given indices.

Parameters:

args - an array of arguments.

Returns:

the array elements that are not consumed.

See Also:

lastIndex(String[])

lastIndex

public int lastIndex(String[] args)

Gets the last index in the given array that can be processed as an option. The array elements are sequentially tested if they are a valid option name (i.e. starts with - character) and if valid then the next element is consumed as value, if the option requires a value. The search ends when either the array is exhausted or encounters elements that are not options.

Parameters:

args - an array of arguments

Returns:

the last index that will/can be consumed by this processor.

register

public CommandProcessor.Option register(boolean requiresValue,
                               String... aliases)

Register the given aliases as a command option.

Parameters:

requiresValue - if true then the option must be specified with a value.

aliases - strings to recognize this option. Each must begin with a dash character.

Returns:

the command that is registered

findCommand

public CommandProcessor.Option findCommand(String option)

Finds a command with the given name. If no command has been registered with the given name, but this processor allows unrecognized options, then as a result of this call, the unknown name is registered as an option.

Parameters:

option - a command alias.

Returns:

null if the given String is not a valid command option name.

getUnregisteredCommands

public Set<CommandProcessor.Option> getUnregisteredCommands()

Gets all the unrecognized command options.

Returns:

empty set if no commands are unrecognized.

getValue

public String getValue(String alias)

Gets value of the option matching the given alias.

Parameters:

alias - an alias.

Returns:

value of the given option.

getAllowsUnregisteredOption

public boolean getAllowsUnregisteredOption()

Returns:

the allowsUnregisteredOption

setAllowsUnregisteredOption

public void setAllowsUnregisteredOption(boolean allowsUnregisteredOption)

Parameters:

allowsUnregisteredOption - the allowsUnregisteredOption to set