org.hackystat.sensor.xmldata.option
Interface Option

All Known Implementing Classes:
AbstractOption, ArgListOption, FileOption, MigrationOption, MultiShellOption, ResourceOption, SdtOption, SetRuntimeOption, UniqueTstampOption, VerboseOption

public interface Option

The common interface between objects that wrap the options and parameters specified via command-line arguments. Options provide the capability to store the passed options and arguments, validate the parameters, and execute an action over the parameters.

Author:
Austen Ito

Method Summary
 void execute()
          Executes this option based on the option name and parameters.
 java.lang.String getName()
          Returns the name of this option.
 java.util.List<java.lang.String> getParameters()
          Returns a list of parameters used to execute this option.
 boolean isValid()
          Returns true if this option's parameters are valid.
 void process()
          Processes the parameters found in this option.
 

Method Detail

isValid

boolean isValid()
Returns true if this option's parameters are valid.

Returns:
true if all parameters are valid.

getName

java.lang.String getName()
Returns the name of this option.

Returns:
the option name.

process

void process()
Processes the parameters found in this option. This method is called before execution and can be used to setup option values or perform pre-execution processing.


getParameters

java.util.List<java.lang.String> getParameters()
Returns a list of parameters used to execute this option.

Returns:
the list of parameters.

execute

void execute()
Executes this option based on the option name and parameters.