org.jboss.aesh.cl

Class CommandLineParser

java.lang.Object

org.jboss.aesh.cl.CommandLineParser

public class CommandLineParser
extends Object

A simple command line parser. It parses a given string based on the Parameter given and returns a CommandLine It can also print a formatted usage/help information.

Author:

Ståle W. Pedersen

Constructor Summary

Constructors

Constructor and Description
CommandLineParser(List<ParameterInt> parameters)
CommandLineParser(ParameterInt parameterInt)
CommandLineParser(String name, String usage)

Method Summary

Modifier and Type	Method and Description
void	addParameter(ParameterInt param)
List<ParameterInt>	getParameters()
CommandLine	parse(String line) Parse a command line with the defined parameter as base of the rules.
CommandLine	parse(String line, boolean ignoreMissingRequirements) Parse a command line with the defined parameter as base of the rules.
String	printHelp() Returns a usage String based on the defined parameter and options.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineParser

public CommandLineParser(List<ParameterInt> parameters)

CommandLineParser

public CommandLineParser(ParameterInt parameterInt)

CommandLineParser

public CommandLineParser(String name,
                         String usage)

Method Detail

addParameter

public void addParameter(ParameterInt param)

getParameters

public List<ParameterInt> getParameters()

printHelp

public String printHelp()

Returns a usage String based on the defined parameter and options. Useful when printing "help" info etc.

parse

public CommandLine parse(String line)
                  throws IllegalArgumentException

Parse a command line with the defined parameter as base of the rules. If any options are found, but not defined in the parameter object an IllegalArgumentException will be thrown. Also, if a required option is not found or options specified with value, but is not given any value an IllegalArgumentException will be thrown. The options found will be returned as a CommandLine object where they can be queried after.

Parameters:

line - input

Returns:

CommandLine

Throws:

IllegalArgumentException

parse

public CommandLine parse(String line,
                         boolean ignoreMissingRequirements)
                  throws IllegalArgumentException

Parse a command line with the defined parameter as base of the rules. If any options are found, but not defined in the parameter object an IllegalArgumentException will be thrown. Also, if a required option is not found or options specified with value, but is not given any value an IllegalArgumentException will be thrown. The options found will be returned as a CommandLine object where they can be queried after.

Parameters:

line - input

ignoreMissingRequirements - if we should ignore

Returns:

CommandLine

Throws:

IllegalArgumentException