adaptj.util.OptionParser
Interface Option

All Known Implementing Classes:
BasicOption

public interface Option


Method Summary
 java.lang.String[] getArgumentDescriptions()
          Returns an array of argument descriptions corresponding to the Argument objects returned by getArguments
 Argument[] getArguments()
          Returns the array of Argument objects for this option.
 java.lang.String getDescription()
          Returns the textual description of this option.
 java.lang.String[] getSwitches()
          Returns the valid switches for this option.
 

Method Detail

getDescription

public java.lang.String getDescription()
Returns the textual description of this option. This value is used to print help about the commands.

Returns:
the textual description of this option.

getSwitches

public java.lang.String[] getSwitches()
Returns the valid switches for this option. Typical exaples include "-s" and "--long-option", or null if the option is to be ignored, in which case this option will not appear in the usage and help information.

Returns:
a array of switches that can be used to specify this option, or null if none exists.

getArguments

public Argument[] getArguments()
Returns the array of Argument objects for this option. Argument objects are used to specifify the arguments that this option accepts.

Returns:
an array of Argument objects, or null if none exists.

getArgumentDescriptions

public java.lang.String[] getArgumentDescriptions()
Returns an array of argument descriptions corresponding to the Argument objects returned by getArguments

Returns:
an array of argument descriptions, or null if none exists.