com.buschmais.jqassistant.commandline.task

Class AbstractTask

java.lang.Object

com.buschmais.jqassistant.commandline.task.AbstractTask

All Implemented Interfaces:

OptionsConsumer, OptionsProvider, Task

Direct Known Subclasses:

AbstractAnalyzeTask, ReportTask, ResetTask, ScanTask, ServerTask

public abstract class AbstractTask
extends Object
implements Task

Author:

jn4, Kontext E GmbH, 24.01.14

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CMDLINE_OPTION_REPORTDIR
protected static String	CMDLINE_OPTION_S
protected static String	CMDLINE_OPTION_STOREDIRECTORY
protected Map<String,Object>	pluginProperties
protected com.buschmais.jqassistant.core.plugin.api.PluginRepository	pluginRepository
protected com.buschmais.jqassistant.core.report.api.ReportHelper	reportHelper
protected com.buschmais.jqassistant.core.splittingsupport.scm.RuleHelper	ruleHelper
protected String	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
AbstractTask()

Method Summary

Modifier and Type	Method and Description
protected void	addTaskOptions(List<org.apache.commons.cli.Option> options)
protected abstract void	executeTask(com.buschmais.jqassistant.core.store.api.Store store)
List<org.apache.commons.cli.Option>	getOptions()
protected String	getOptionValue(org.apache.commons.cli.CommandLine options, String option, String defaultValue)
protected List<String>	getOptionValues(org.apache.commons.cli.CommandLine options, String option, List<String> defaultValues)
protected com.buschmais.jqassistant.core.store.api.Store	getStore() Return the Store instance.
void	initialize(com.buschmais.jqassistant.core.plugin.api.PluginRepository pluginRepository, Map<String,Object> pluginProperties)
void	run()
void	withStandardOptions(org.apache.commons.cli.CommandLine options)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.buschmais.jqassistant.commandline.OptionsConsumer

withOptions

Field Detail

CMDLINE_OPTION_S

protected static final String CMDLINE_OPTION_S

See Also:

Constant Field Values

CMDLINE_OPTION_STOREDIRECTORY

protected static final String CMDLINE_OPTION_STOREDIRECTORY

See Also:

Constant Field Values

CMDLINE_OPTION_REPORTDIR

protected static final String CMDLINE_OPTION_REPORTDIR

See Also:

Constant Field Values

storeDirectory

protected String storeDirectory

pluginRepository

protected com.buschmais.jqassistant.core.plugin.api.PluginRepository pluginRepository

ruleHelper

protected com.buschmais.jqassistant.core.splittingsupport.scm.RuleHelper ruleHelper

reportHelper

protected com.buschmais.jqassistant.core.report.api.ReportHelper reportHelper

pluginProperties

protected Map<String,Object> pluginProperties

Constructor Detail

AbstractTask

public AbstractTask()

Method Detail

initialize

public void initialize(com.buschmais.jqassistant.core.plugin.api.PluginRepository pluginRepository,
                       Map<String,Object> pluginProperties)
                throws CliExecutionException

Specified by:

initialize in interface Task

Throws:

CliExecutionException

run

public void run()
         throws CliExecutionException

Specified by:

run in interface Task

Throws:

CliExecutionException

withStandardOptions

public void withStandardOptions(org.apache.commons.cli.CommandLine options)

Specified by:

withStandardOptions in interface Task

getOptions

public List<org.apache.commons.cli.Option> getOptions()

Specified by:

getOptions in interface OptionsProvider

getOptionValues

protected List<String> getOptionValues(org.apache.commons.cli.CommandLine options,
                                       String option,
                                       List<String> defaultValues)

getOptionValue

protected String getOptionValue(org.apache.commons.cli.CommandLine options,
                                String option,
                                String defaultValue)

addTaskOptions

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

getStore

protected com.buschmais.jqassistant.core.store.api.Store getStore()

Return the Store instance.

Returns:

The store.

executeTask

protected abstract void executeTask(com.buschmais.jqassistant.core.store.api.Store store)
                             throws CliExecutionException

Throws:

CliExecutionException