uk.ac.ebi.microarray.zooma.utils
Interface ZoomaMode.Argument

Enclosing interface:

ZoomaMode

public static interface ZoomaMode.Argument

Defines an argument provided to modify an operation. Arguments have a series of descriptive getter methods so they can be invoked on the command line.

Method Summary

java.lang.String	getArgDescription() A short description of what this argument is for.
java.lang.String	getArgName() The full name of this argument.
java.lang.String	getArgShortName() The short name for this argument.
boolean	isRequired() Whether or not this argument is required.

Method Detail

getArgShortName

java.lang.String getArgShortName()

The short name for this argument. This will usually be the first one or two characters of the argument's full name. This value binds to the user supplied parameter when zooma is invoked from the command line. Arguments should, as a rule, always take string values.

Returns:

the short name of the argument

getArgName

java.lang.String getArgName()

The full name of this argument.

Returns:

the argument name

getArgDescription

java.lang.String getArgDescription()

A short description of what this argument is for.

Returns:

the description of this argument

isRequired

boolean isRequired()

Whether or not this argument is required. If true, the user must supply a value for this argument. If false, the value may safely be omitted - either this is optional, or the target fills in a sensible default.

Returns:

whether or not this argument must be specified for this target to be invoked