JAXXEngineTask (JAXX :: Compiler 3.0.21 API)

java.lang.Object
- org.nuiton.jaxx.compiler.tasks.JAXXEngineTask

Direct Known Subclasses:

CompileFirstPassTask, CompileSecondPassTask, FinalizeTask, GenerateConstructorsTask, GenerateMissingRulesTask, GenerateTask, InitTask, ProfileTask, StyleSheetTask
```
public abstract class JAXXEngineTask
extends Object
```
Base class to implement a task to be launched by a JAXXEngine. The perform(JAXXEngine) method contains the logic of the task.

Since:

2.0.2

Author:

Tony Chemit - dev@tchemit.fr

Constructor Summary

Constructors
Constructor Description

JAXXEngineTask(String name)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addEndProfileTime(JAXXEngine engine, JAXXCompiler compiler)`
`protected void`	`addStartProfileTime(JAXXEngine engine, JAXXCompiler compiler)`
`protected void`	`checkAllFilesCompiled(JAXXEngine engine)`	Checks the engine does not have any more files to discover.
`String`	`getName()`
`abstract boolean`	`perform(JAXXEngine engine)`	Performs the task on the given `engine`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- JAXXEngineTask
```
public JAXXEngineTask(String name)
```

Method Detail

perform
```
public abstract boolean perform(JAXXEngine engine)
                         throws Exception
```
Performs the task on the given engine.

Parameters:

engine - the engine to use

Returns:

false if task failed (with no exception), true otherwise.

Throws:

Exception - if any error

getName
```
public String getName()
```

checkAllFilesCompiled
```
protected void checkAllFilesCompiled(JAXXEngine engine)
                              throws IllegalStateException
```
Checks the engine does not have any more files to discover.

Parameters:

engine - the engine to test

Throws:

IllegalStateException - if there is still some files to discover.

addStartProfileTime

protected void addStartProfileTime(JAXXEngine engine,
                                   JAXXCompiler compiler)

addEndProfileTime

protected void addEndProfileTime(JAXXEngine engine,
                                 JAXXCompiler compiler)