Package weka.core
Class ListOptions
java.lang.Object
weka.core.ListOptions
- All Implemented Interfaces:
CommandlineRunnable,OptionHandler,RevisionHandler
public class ListOptions
extends Object
implements OptionHandler, RevisionHandler, CommandlineRunnable
Lists the options of an OptionHandler
- Version:
- $Revision: 12950 $
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongenerate()generates the options string.generates a string to print as help on the consolereturns the current classnameString[]Gets the current settings of this object.Returns the revision string.Returns an enumeration describing the available options.static voidruns the javadoc producer with the given commandline optionsvoidPerform any teardown stuff that might need to happen after execution.voidPerform any setup stuff that might need to happen before execution.voidExecute the supplied object.voidsetClassname(String value) sets the classname of the class to generate the Javadoc forvoidsetOptions(String[] options) Parses a given list of options.
-
Constructor Details
-
ListOptions
public ListOptions()
-
-
Method Details
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options.- Specified by:
setOptionsin interfaceOptionHandler- Parameters:
options- the list of options as an array of strings- Throws:
Exception- if an option is not supported
-
getOptions
Gets the current settings of this object.- Specified by:
getOptionsin interfaceOptionHandler- Returns:
- an array of strings suitable for passing to setOptions
-
setClassname
sets the classname of the class to generate the Javadoc for- Parameters:
value- the new classname
-
getClassname
returns the current classname- Returns:
- the current classname
-
generateHelp
generates a string to print as help on the console- Returns:
- the generated help
-
generate
generates the options string.- Returns:
- the options string
- Throws:
Exception- in case the generation fails
-
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Returns:
- the revision
-
main
runs the javadoc producer with the given commandline options- Parameters:
options- the commandline options
-
preExecution
Description copied from interface:CommandlineRunnablePerform any setup stuff that might need to happen before execution.- Specified by:
preExecutionin interfaceCommandlineRunnable- Throws:
Exception- if a problem occurs during setup
-
run
Description copied from interface:CommandlineRunnableExecute the supplied object.- Specified by:
runin interfaceCommandlineRunnable- Parameters:
toRun- the object to executeoptions- any options to pass to the object- Throws:
Exception- if a problem occurs.
-
postExecution
Description copied from interface:CommandlineRunnablePerform any teardown stuff that might need to happen after execution.- Specified by:
postExecutionin interfaceCommandlineRunnable- Throws:
Exception- if a problem occurs during teardown
-