com.lhkbob.entreri.task

Class SimpleTask

java.lang.Object

com.lhkbob.entreri.task.SimpleTask

All Implemented Interfaces:

Task

public abstract class SimpleTask
extends Object
implements Task

SimpleTask extends Task adds logic to simplify the creation of tasks that perform the same operations on each entity that matches a specific component configuration. Subclasses of SimpleTask should define a single method named 'processEntity' that takes as its only parameters, any number of Component instances of specific types. An example might be:

 public class ExampleTask extends SimpleTask {
     // c1 and c2 are required types
     // c3 is an optional component type
     protected void processEntities(TypeA c1, TypeB c2, @Optional TypeC c3) {
         // perform operations on c1 and c2
         if (c3 != null) {
             // perform additional operations on c3
         }
     }

     public Task process(EntitySystem system, Job job) {
         // this will invoke processEntities() for each entity in the system
         // that has a TypeA and TypeB component. If the entity also has
         // a TypeC component, it is passed in too, otherwise it's null
         processEntities(system);
         return null;
     }
 }
 

In the task's process(EntitySystem, Job) method, it can then invoke processEntities(EntitySystem) to perform the automated iteration over matching entities within the system. SimpleTask will call the identified 'processEntity' method for each matched entity.

Author:

Michael Ludwig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SimpleTask.Optional

Constructor Summary

Constructors

Constructor and Description
SimpleTask()

Method Summary

Methods

Modifier and Type	Method and Description
Task	process(EntitySystem system, Job job) The default implementation of process() just invokes processEntities(com.lhkbob.entreri.EntitySystem) immediately and returns no future task.
protected void	processEntities(EntitySystem system) Process all entities that fit the component profile mandated by the defined 'processEntity()' method in the subclass.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.lhkbob.entreri.task.Task

reset

Constructor Detail

SimpleTask

public SimpleTask()

Method Detail

process

public Task process(EntitySystem system,
           Job job)

The default implementation of process() just invokes processEntities(com.lhkbob.entreri.EntitySystem) immediately and returns no future task.

Specified by:

process in interface Task

Parameters:

system - The EntitySystem being processed, which will always be the same for a given Task instance

job - The Job this task belongs to

Returns:

Will return null unless overridden

processEntities

protected void processEntities(EntitySystem system)

Process all entities that fit the component profile mandated by the defined 'processEntity()' method in the subclass.

Parameters:

system - The system to process