Package org.eclipse.steady.tasks

Class AbstractTask

java.lang.Object

org.eclipse.steady.tasks.AbstractTask

All Implemented Interfaces:

Task

Direct Known Subclasses:

AbstractBomTask

public abstract class AbstractTask
extends Object
implements Task

Abstract AbstractTask class.

Field Summary

Fields

Modifier and Type	Field	Description
protected VulasConfiguration	vulasConfiguration

Constructor Summary

Constructors

Constructor	Description
AbstractTask()

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Called after Task.execute().
void	configure(VulasConfiguration _cfg)	Called prior to Task.execute().
Application	getApplication()	Getter for the field application.
Map<Path,Dependency>	getKnownDependencies()	Getter for the field knownDependencies.
List<Path>	getSearchPath()	getSearchPath.
boolean	hasSearchPath()	hasSearchPath.
boolean	isGoalClient(GoalClient _client)	Returns true if the GoalClient of this task is equal to the given client, false otherwise.
boolean	isOneOfGoalClients(List<GoalClient> clients)	isOneOfGoalClients.
void	setApplication(Application _app)	Sets the Application in whose context the task is executed.
void	setGoalClient(GoalClient _client)	Sets the GoalClient in whose context the task is executed.
void	setKnownDependencies(Map<Path,Dependency> _dependencies)	Provides the task with application Dependencys that are already known before task execution.
void	setSearchPaths(List<Path> _paths)	Sets one or more file systems Paths that contain application code and/or dependencies.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.steady.tasks.Task

execute, getLanguage

Field Detail

vulasConfiguration

protected VulasConfiguration vulasConfiguration

Constructor Detail

AbstractTask

public AbstractTask()

Method Detail

getSearchPath

public final List<Path> getSearchPath()

getSearchPath.

Returns:

a List object.

hasSearchPath

public final boolean hasSearchPath()

hasSearchPath.

Returns:

a boolean.

setSearchPaths

public final void setSearchPaths(List<Path> _paths)

Sets one or more file systems Paths that contain application code and/or dependencies.

Specified by:

setSearchPaths in interface Task

Parameters:

_paths - a List object.

isGoalClient

public final boolean isGoalClient(GoalClient _client)

Returns true if the GoalClient of this task is equal to the given client, false otherwise.

Parameters:

_client - a GoalClient object.

Returns:

a boolean.

isOneOfGoalClients

public final boolean isOneOfGoalClients(List<GoalClient> clients)

isOneOfGoalClients.

Parameters:

clients - a List object.

Returns:

a boolean.

setGoalClient

public final void setGoalClient(GoalClient _client)

Sets the GoalClient in whose context the task is executed.

Specified by:

setGoalClient in interface Task

Parameters:

_client - a GoalClient object.

getApplication

public final Application getApplication()

Getter for the field application.

Returns:

a Application object.

setApplication

public final void setApplication(Application _app)

Sets the Application in whose context the task is executed.

Specified by:

setApplication in interface Task

Parameters:

_app - a Application object.

getKnownDependencies

public Map<Path,Dependency> getKnownDependencies()

Getter for the field knownDependencies.

Returns:

a Map object.

setKnownDependencies

public void setKnownDependencies(Map<Path,Dependency> _dependencies)

Provides the task with application Dependencys that are already known before task execution. This information may come from build systems or the like, and typically facilitates the task execution.

Specified by:

setKnownDependencies in interface Task

Parameters:

_dependencies - a Map object.

configure

public void configure(VulasConfiguration _cfg)
               throws GoalConfigurationException

Called prior to Task.execute(). Checks the search Path and GoalClient.

Specified by:

configure in interface Task

Parameters:

_cfg - a VulasConfiguration object.

Throws:

GoalConfigurationException

cleanUp

public void cleanUp()

Called after Task.execute().

Specified by:

cleanUp in interface Task