com.verhas.utils

Class CommandLineProcessor

java.lang.Object

com.verhas.utils.CommandLineProcessor

public class CommandLineProcessor
extends Object

Constructor Summary

Constructors

Constructor and Description
CommandLineProcessor()

Method Summary

Modifier and Type	Method and Description
List<String>	getFiles() Get the non option (file) arguments that were gathered by the method process().
Map<String,String>	getOptions() Get the options that were gathered by the method process().
String	option(String name) Get a command line option value.
Boolean	optionExists(String name) Decides if a command line option was specified on the command line or not.
void	process(String[] args) Parses the command line to discover all the 'option' arguments and all the 'file' arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineProcessor

public CommandLineProcessor()

Method Detail

getOptions

public Map<String,String> getOptions()

Get the options that were gathered by the method process().

Returns:

the map containing the command line argument key value pairs

optionExists

public Boolean optionExists(String name)

Decides if a command line option was specified on the command line or not.

Should only be called after the method process() was invoked.

Parameters:

name - the name of the option we are looking for

Returns:

true if the option was specified on the command line, and false if the option was not specified

option

public String option(String name)

Get a command line option value.

Should only be called after the method process() was invoked.

Parameters:

name - the name of the option we are looking for

Returns:

the value of the option

getFiles

public List<String> getFiles()

Get the non option (file) arguments that were gathered by the method process().

Returns:

the list of the arguments that do not have name in the order as they appeared on the command line

process

public void process(String[] args)

Parses the command line to discover all the 'option' arguments and all the 'file' arguments. When an argument starts with double dash -- then this is a

 --arg=value
 

formatted argument. The value and the name of the option are separated using an = equal sign and thus present in the same command line argument.

When the argument starts with single dash - (and not double dash --) then it is a

 -arg value
 

type argument. The difference is that in this case the argument value is the next command line argument separated by space on the command line from the name of the options.

When an argument does not start with dash then this is a 'file' parameter and it gets into the files collection.

When a 'file' argument starts with a dash '-' then it has to be preceded with two dashes. For example -specialFile has to be written as ---specialFile.

The order of the parameters and the way they are specified ( -- or - ) is not preserved. The order of 'file' arguments is reserved in the array.

Parameters:

args - the arguments passed to the main function