Package org.opt4j.config

Class Task

java.lang.Object

org.opt4j.config.Task

All Implemented Interfaces:

Callable<Void>

Direct Known Subclasses:

Opt4JTask

public abstract class Task
extends Object
implements Callable<Void>

The Task is an abstract class for optimization tasks.

See Also:

• ExecutionEnvironment

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Task.State	The Task.State of a task.

Field Summary

Fields

Modifier and Type	Field	Description
protected Exception	e
protected boolean	isInit
protected final Set<TaskStateListener>	listeners
protected final List<com.google.inject.Module>	modules
protected Task.State	state

Constructor Summary

Constructors

Constructor	Description
Task()

Method Summary

Modifier and Type	Method	Description
void	addStateListener(TaskStateListener listener)	Adds a TaskStateListener.
Void	call()
abstract void	execute()	Executes the Task.
Exception	getException()	Returns the Exception that was thrown during the Task execution if an error occurred.
Collection<com.google.inject.Module>	getModules()	Returns a copy of the Modules of this Task.
Task.State	getState()	Returns the state of the Task.
void	init(com.google.inject.Module... modules)	Initializes the Task with modules.
void	init(Collection<com.google.inject.Module> modules)	Initializes the Task with modules.
void	removeStateListener(TaskStateListener listener)	Removes a TaskStateListener.
protected void	setState(Task.State state)	Sets the state of the Task.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

state

protected Task.State state

e

protected Exception e

modules

protected final List<com.google.inject.Module> modules

isInit

protected boolean isInit

listeners

protected final Set<TaskStateListener> listeners

Constructor Details

Task

public Task()

Method Details

init

public void init(com.google.inject.Module... modules)

Initializes the Task with modules.

Parameters:

modules - the modules for the task

See Also:

• init(Collection)

init

public void init(Collection<com.google.inject.Module> modules)

Initializes the Task with modules. Note that if a module is a PropertyModule, a copy is made with the PropertyModule.clone() method. If the Module is not a PropertyModule, the module is copied as a reference, i.e., it can be changed until the execute() is called.

Parameters:

modules - the modules for the task

execute

public abstract void execute()
                      throws Exception

Executes the Task.

Throws:

Exception

call

public Void call()
          throws Exception

Specified by:

call in interface Callable<Void>

Throws:

Exception

getException

public Exception getException()

Returns the Exception that was thrown during the Task execution if an error occurred.

Returns:

the occurred exception

getState

public Task.State getState()

Returns the state of the Task.

Returns:

the state of the task

setState

protected void setState(Task.State state)

Sets the state of the Task.

Parameters:

state - the state of the task to be set

toString

public String toString()

Overrides:

toString in class Object

addStateListener

public void addStateListener(TaskStateListener listener)

Adds a TaskStateListener.

Parameters:

listener - the listener to be added

See Also:

• removeStateListener(org.opt4j.config.TaskStateListener)

removeStateListener

public void removeStateListener(TaskStateListener listener)

Removes a TaskStateListener.

Parameters:

listener - the listener to be removed

See Also:

• addStateListener(org.opt4j.config.TaskStateListener)

getModules

public Collection<com.google.inject.Module> getModules()

Returns a copy of the Modules of this Task.

Returns:

a set of modules