com.buschmais.jqassistant.commandline.task

Class AbstractAnalyzeTask

java.lang.Object

com.buschmais.jqassistant.commandline.task.AbstractTask

com.buschmais.jqassistant.commandline.task.AbstractAnalyzeTask

All Implemented Interfaces:

OptionsConsumer, OptionsProvider, Task

Direct Known Subclasses:

AnalyzeTask, AvailableRulesTask, AvailableScopesTask, EffectiveRulesTask

public abstract class AbstractAnalyzeTask
extends AbstractTask

Abstract base class for all tasks working with rules.

Field Summary

Fields inherited from class com.buschmais.jqassistant.commandline.task.AbstractTask

CMDLINE_OPTION_REPORTDIR, CMDLINE_OPTION_S, CMDLINE_OPTION_STOREDIRECTORY, pluginProperties, pluginRepository, reportHelper, ruleHelper, storeDirectory

Fields inherited from interface com.buschmais.jqassistant.commandline.Task

DEFAULT_REPORT_DIRECTORY, DEFAULT_RULE_DIRECTORY, DEFAULT_STORE_DIRECTORY, REPORT_FILE_XML

Constructor Summary

Constructors

Constructor and Description
AbstractAnalyzeTask()

Method Summary

Modifier and Type	Method and Description
protected void	addTaskOptions(List<org.apache.commons.cli.Option> options)
protected com.buschmais.jqassistant.core.analysis.api.rule.RuleSet	getAvailableRules()
protected com.buschmais.jqassistant.core.analysis.api.RuleSelection	getRuleSelection(com.buschmais.jqassistant.core.analysis.api.rule.RuleSet ruleSet) Return the selection of rules.
void	withOptions(org.apache.commons.cli.CommandLine options)

Methods inherited from class com.buschmais.jqassistant.commandline.task.AbstractTask

executeTask, getOptions, getOptionValue, getOptionValues, getStore, initialize, run, withStandardOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAnalyzeTask

public AbstractAnalyzeTask()

Method Detail

getAvailableRules

protected com.buschmais.jqassistant.core.analysis.api.rule.RuleSet getAvailableRules()
                                                                              throws CliExecutionException

Throws:

CliExecutionException

getRuleSelection

protected com.buschmais.jqassistant.core.analysis.api.RuleSelection getRuleSelection(com.buschmais.jqassistant.core.analysis.api.rule.RuleSet ruleSet)
                                                                              throws CliExecutionException

Return the selection of rules.

Parameters:

ruleSet - The rule set.

Returns:

The selection of rules.

Throws:

CliExecutionException

withOptions

public void withOptions(org.apache.commons.cli.CommandLine options)
                 throws CliConfigurationException

Throws:

CliConfigurationException

addTaskOptions

protected void addTaskOptions(List<org.apache.commons.cli.Option> options)

Overrides:

addTaskOptions in class AbstractTask