fmrisc.ProgramExplorer.Tasks

Class TaskBase

java.lang.Object

fmrisc.ProgramExplorer.Tasks.TaskBase

All Implemented Interfaces:

Task

Direct Known Subclasses:

FailedTask, FrameTask, ProofNavigatorTaskBase, TaskFolder

public class TaskBase
extends java.lang.Object
implements Task

The base class of a verification task

Nested Class Summary

Nested classes/interfaces inherited from interface fmrisc.ProgramExplorer.Tasks.Task

Task.Observer, Task.Status

Method Summary

Modifier and Type	Method and Description
java.io.File	getDirectory() Get directory to be used for writing persistent data
java.lang.String	getEvidence() Get evidence for task status.
java.lang.Object	getInfo() Get additional information for task status.
java.lang.String	getName() Get name of task.
TaskFolder	getParent() Get parent folder
java.io.File	getParentDirectory() Get parent directory
SourcePosition	getPosition() Get source code position linked to this task (null, if none)
Task.Status	getStatus() Get status of task.
boolean	isFinal() Determine whether task status is final.
boolean	isOptional() Determine whether task is optional.
void	print(java.io.PrintWriter out) Print linear representation of task.
void	reset() Reset the task to its initial (new) state.
Task.Status	resume() Resume task.
boolean	resumeOnNew() Determine whether new task is to be resumed.
void	setDirectory(java.io.File dir) Set directory to be used for writing persistent data.
void	setObserver(Task.Observer observer) Set observer for this task.
void	setParent(TaskFolder parent) Set parent folder
void	setStatus(Task.Status status, java.lang.String evidence, java.lang.Object info) Set task status.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Get name of task.

Specified by:

getName in interface Task

Returns:

the task name.

resumeOnNew

public boolean resumeOnNew()

Determine whether new task is to be resumed.

Specified by:

resumeOnNew in interface Task

Returns:

true if new task is to be resumed.

isOptional

public boolean isOptional()

Determine whether task is optional.

Specified by:

isOptional in interface Task

Returns:

true if task is optional.

getStatus

public Task.Status getStatus()

Get status of task.

Specified by:

getStatus in interface Task

Returns:

the task status.

resume

public Task.Status resume()

Resume task.

Specified by:

resume in interface Task

Returns:

the new status

getPosition

public SourcePosition getPosition()

Get source code position linked to this task (null, if none)

Specified by:

getPosition in interface Task

Returns:

the position.

setParent

public void setParent(TaskFolder parent)

Set parent folder

Specified by:

setParent in interface Task

Parameters:

parent - the parent folder (may be null)

getParent

public TaskFolder getParent()

Get parent folder

Specified by:

getParent in interface Task

Returns:

the parent (null, if root)

getParentDirectory

public java.io.File getParentDirectory()

Get parent directory

Returns:

the parent of the directory of this task

getDirectory

public java.io.File getDirectory()

Get directory to be used for writing persistent data

Specified by:

getDirectory in interface Task

Returns:

the directory.

setDirectory

public void setDirectory(java.io.File dir)

Set directory to be used for writing persistent data.

Parameters:

dir - the directory.

print

public void print(java.io.PrintWriter out)

Print linear representation of task.

Specified by:

print in interface Task

Parameters:

out - the writer.

setStatus

public void setStatus(Task.Status status,
                      java.lang.String evidence,
                      java.lang.Object info)

Set task status.

Specified by:

setStatus in interface Task

Parameters:

evidence - the evidence for the status (may be null).

info - any additional information about the evidence (may be null).

status - the task status.

getEvidence

public java.lang.String getEvidence()

Get evidence for task status.

Specified by:

getEvidence in interface Task

Returns:

the evidence (may be null)

getInfo

public java.lang.Object getInfo()

Get additional information for task status.

Specified by:

getInfo in interface Task

Returns:

the information (may be null)

isFinal

public boolean isFinal()

Determine whether task status is final.

Specified by:

isFinal in interface Task

Returns:

true iff task status is DONE or FAILED.

setObserver

public void setObserver(Task.Observer observer)

Set observer for this task.

Specified by:

setObserver in interface Task

Parameters:

observer - a task observer

reset

public void reset()

Reset the task to its initial (new) state.