com.aragost.util.cmdline
Class OptionParser

java.lang.Object
  |
  +--com.aragost.util.cmdline.OptionParser

public class OptionParser

extends java.lang.Object

A class used to parse command line options.

Constructor Summary

OptionParser()

Method Summary

Option	addOption(char shortName, java.lang.String longName, java.lang.String explanation, java.lang.Class type) Create an Option from the specified paraemters and add it to the receiver
Option	addOption(Option opt) Add an Option to the receiver
void	addRule(Rule rule)
void	addRuleAtMostOne(Option opt1, Option opt2)
void	addRuleAtMostOne(Option opt1, Option opt2, Option opt3)
void	addRuleAtMostOne(Option opt1, Option opt2, Option opt3, Option opt4)
void	addRuleExactlyOne(Option opt1, Option opt2)
void	addRuleExactlyOne(Option opt1, Option opt2, Option opt3)
void	addRuleExactlyOne(Option opt1, Option opt2, Option opt3, Option opt4)
java.lang.String	getExplanation() Getter for property explanation.
int	getIntValue(java.lang.String longName) Return the int value for the specified option.
java.lang.String	getStringValue(java.lang.String longName)
java.util.Collection	getUnsatisfiedRules() After parsing this method return all the unsatisfied rules.
java.lang.String	getUsage() Getter for property usage.
java.lang.Object	getValue(java.lang.String longName) Get the value for the specified option
boolean	hasOption(Option option) Check if the specified option is present
boolean	hasOption(java.lang.String longName) Check if the specified option is present
java.lang.String[]	parse(java.lang.String[] args) Parse the options, and return the remaining arguments.
void	printHelp()
void	printHelp(OptionParserException exception)
void	printHelp(java.lang.String errorMessage)
void	printHelp(java.lang.String errorMessage, java.io.PrintWriter writer)
void	printOptions(java.io.PrintWriter w) Print all options to the specified Writer.
void	printRules(java.io.PrintWriter writer)
java.lang.String[]	safeParse(java.lang.String[] args) Parse the options of the specified String array.
void	setExplanation(java.lang.String explanation) Setter for property explanation.
void	setUsage(java.lang.String usage) Setter for property usage.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionParser

public OptionParser()

Method Detail

addOption

public Option addOption(Option opt)

Add an Option to the receiver

addOption

public Option addOption(char shortName,
                        java.lang.String longName,
                        java.lang.String explanation,
                        java.lang.Class type)

Create an Option from the specified paraemters and add it to the receiver

safeParse

public java.lang.String[] safeParse(java.lang.String[] args)

Parse the options of the specified String array. Return the remaining arguments.

parse

public java.lang.String[] parse(java.lang.String[] args)

Parse the options, and return the remaining arguments. In case of a parse error throw an OptionParserException.

hasOption

public boolean hasOption(java.lang.String longName)

Check if the specified option is present

hasOption

public boolean hasOption(Option option)

Check if the specified option is present

getValue

public java.lang.Object getValue(java.lang.String longName)

Get the value for the specified option

getStringValue

public java.lang.String getStringValue(java.lang.String longName)

getIntValue

public int getIntValue(java.lang.String longName)

Return the int value for the specified option. If the option is not found return 0

printHelp

public void printHelp()

printHelp

public void printHelp(java.lang.String errorMessage)

printHelp

public void printHelp(OptionParserException exception)

printHelp

public void printHelp(java.lang.String errorMessage,
                      java.io.PrintWriter writer)

addRuleExactlyOne

public void addRuleExactlyOne(Option opt1,
                              Option opt2,
                              Option opt3,
                              Option opt4)

addRuleExactlyOne

public void addRuleExactlyOne(Option opt1,
                              Option opt2,
                              Option opt3)

addRuleExactlyOne

public void addRuleExactlyOne(Option opt1,
                              Option opt2)

addRuleAtMostOne

public void addRuleAtMostOne(Option opt1,
                             Option opt2,
                             Option opt3,
                             Option opt4)

addRuleAtMostOne

public void addRuleAtMostOne(Option opt1,
                             Option opt2,
                             Option opt3)

addRuleAtMostOne

public void addRuleAtMostOne(Option opt1,
                             Option opt2)

addRule

public void addRule(Rule rule)

getUnsatisfiedRules

public java.util.Collection getUnsatisfiedRules()

After parsing this method return all the unsatisfied rules. If all rules is satisfied the null is returned.

printOptions

public void printOptions(java.io.PrintWriter w)

Print all options to the specified Writer.

printRules

public void printRules(java.io.PrintWriter writer)

getUsage

public java.lang.String getUsage()

Getter for property usage.

Returns:

Value of property usage.

setUsage

public void setUsage(java.lang.String usage)

Setter for property usage.

Parameters:

usage - New value of property usage.

getExplanation

public java.lang.String getExplanation()

Getter for property explanation.

Returns:

Value of property explanation.

setExplanation

public void setExplanation(java.lang.String explanation)

Setter for property explanation.

Parameters:

explanation - New value of property explanation.