com.lhkbob.entreri.task

Class Job

java.lang.Object

com.lhkbob.entreri.task.Job

All Implemented Interfaces:

Runnable

public class Job
extends Object
implements Runnable

Job represents a list of tasks that must be executed in a particular order so that they produce a meaningful computation over an entity system. Examples of a job might be to render a frame, which could then be decomposed into tasks for computing the visible objects, occluded objects, the optimal rendering order, and shadow computations, etc.

Jobs are created by first getting the Scheduler from a particular EntitySystem, and then calling Scheduler.createJob(String, Task...). The name of a job is primarily used to for informational purposes and does not affect its behavior.

Author:

Michael Ludwig

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
Scheduler	getScheduler()
void	report(Result r) Report the given result instance to all tasks yet to be executed by this job, that have declared a public method named 'report' that takes a Result sub-type that is compatible with r's type.
void	run() Invoke all tasks in this job.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns:

The designated name of this job

getScheduler

public Scheduler getScheduler()

Returns:

The Scheduler that created this job

run

public void run()

Invoke all tasks in this job. This method is thread-safe and will use its owning scheduler to coordinate the locks necessary to safely execute its tasks.

Although Scheduler has convenience methods to repeatedly invoke a job, this method can be called directly if a more controlled job execution scheme is required.

Specified by:

run in interface Runnable

report

public void report(Result r)

Report the given result instance to all tasks yet to be executed by this job, that have declared a public method named 'report' that takes a Result sub-type that is compatible with r's type.

Parameters:

r - The result to report

Throws:

NullPointerException - if r is null

IllegalStateException - if r is a singleton result whose type has already been reported by another task in this job, or if the job is not currently executing tasks

toString

public String toString()

Overrides:

toString in class Object