uk.ac.ed.epcc.webapp.apps

Class Options

java.lang.Object

uk.ac.ed.epcc.webapp.apps.Options

public class Options
extends java.lang.Object

Stores a set of options and provides methods to parse command line arguments and convert them into option instances based on the options in this object. Like Option, Options stores everything a set of options could be, and Options.Instance stores the set of option instances from an actual parse of a command line. The Options.Instance object's behaviour is determined by the constraints placed by it's related Options object and the Options it contains. See Options.Instance.parse(java.lang.String[]) for a complete description on how arguments are parsed into options. If an object has a long name, it must be different to the long names of all other options in this object. The same is true for short names.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Options.Instance An instance of an Options object contains all options found in arguments on a command line.

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
Options	addOption(Option opt) Adds an option to this object
Option	getOption(java.lang.String argName) Returns the specified option, or null if this object does not contain an option by this name.
java.util.Collection<Option>	getOptions() Returns an unmodifiable collection of all the options in this object.
boolean	hasOption(java.lang.String argName) Tests to see if the specified option is present.
Options.Instance	newInstance() Returns a new instance of this options set that can store option instances from a parsed command line
Options.Instance	newInstance(java.lang.String[] args) Returns a new instance of this options set containing the option instances defined in the arguments passed in.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Method Detail

addOption

public Options addOption(Option opt)
                  throws java.lang.IllegalArgumentException

Adds an option to this object

Parameters:

opt - The option to add

Returns:

This Options object

Throws:

java.lang.IllegalArgumentException - If this objct already contains an option with the same long or short name as opt

getOptions

public java.util.Collection<Option> getOptions()

Returns an unmodifiable collection of all the options in this object. There will be no duplicates

Returns:

All the options in this object

getOption

public Option getOption(java.lang.String argName)

Returns the specified option, or null if this object does not contain an option by this name. The name is expected to have one or two hyphens at the beginning. These will be stripped. This method will work if the hyphens are not present so long as the name itself doesn't start with hyphens. In that case, the hyphens will be erroneously stripped.

Parameters:

argName - The name of the argument to return. The name is expected to start with hyphens

Returns:

The option with the specified name

hasOption

public boolean hasOption(java.lang.String argName)

Tests to see if the specified option is present. The name is expected to have one or two hyphens at the beginning. These will be stripped. This method will work if the hyphens are not present so long as the name itself doesn't start with hyphens. In that case, the hyphens will be erroneously stripped.

Parameters:

argName - The name of the argument to return. The name is expected to start with hyphens

Returns:

The option with the specified name

newInstance

public Options.Instance newInstance()

Returns a new instance of this options set that can store option instances from a parsed command line

Returns:

An instance holding version of this options set.

newInstance

public Options.Instance newInstance(java.lang.String[] args)

Returns a new instance of this options set containing the option instances defined in the arguments passed in. Parsing will occur using the constraints applied by this objects

Parameters:

args - the command line arguments to parse

Returns:

An instance holding version of this options set containing the parsed arguments

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

A list of all options supported by this object, formatted in a command line printable format with desctiptions of the options included

See Also:

Object.toString()