Package org.nuiton.jaxx.compiler

Class JAXXEngine

java.lang.Object

org.nuiton.jaxx.compiler.JAXXEngine

public class JAXXEngine
extends Object

The engine to compile jaxx files.

The method run() launch the compilation of files.

Since:

2.0.0 was previously JAXXCompilerLaunchor

Author:

Tony Chemit - dev@tchemit.fr

Field Summary

Fields

Modifier and Type	Field	Description
protected List<JAXXCompilerFile>	compilingFiles	Files to compile
protected CompilerConfiguration	configuration	configuration of the launchor and underlines compilers
protected JAXXEngineTask	currentTask	current pass of the engine
protected List<String>	errors	Errors detected while running.
protected JAXXCompilerFile[]	incomingFiles	original list of files to compile (says the detected modfied files)
protected JAXXProfile	profiler	profile attached to the engine (can be null)
protected JAXXEngineTask[]	tasks	tasks to launch
protected List<String>	warnings	Warnings detected while running.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JAXXEngine(CompilerConfiguration configuration, File base, String... relativePaths)

Method Summary

Modifier and Type	Method	Description
void	addError(String error)	Add an error to the engine.
void	addFileToCompile(File jaxxFile, String jaxxClassName)	Adds a JAXXCompilerFile given the jaxx file and the corresponding class fully qualified name.
void	addFileToCompile(JAXXCompilerFile file)	Adds a file to be compiled.
void	addProfileTime(JAXXCompiler compiler, String key)	Add a profile time for the given compiler and key.
void	addWarning(String warning)	Add a warning to the engine.
void	clearReports()
boolean	containsJaxxFileClassName(String className)
void	flushI18nGetterFile()
JAXXCompilerFile[]	getCompiledFiles()
CompilerConfiguration	getConfiguration()
CompiledObjectDecorator	getDecorator(Class<?> type)	Obtain the decorator of the given type.
CompiledObjectDecorator	getDecorator(String name)	Obtain the decorator of the given name.
List<String>	getErrors()
JAXXCompilerFile[]	getFilesToCompile()
I18nKeysFileModel	getI18nKeysFileModel(String fqn, boolean loadIfNotFound)
JAXXCompiler	getJAXXCompiler(String className)	Obtain the jaxx compiler of the given class name.
JAXXCompilerFile	getJAXXCompilerFile(String className)	Obtain the jaxx compiler of the given class name.
JAXXProfile	getProfiler()
JAXXEngineTask[]	getTasks()
Class<?>	getValidatorFactory()
ClassDescriptor	getValidatorFactoryClass()
String	getVersion()
List<String>	getWarnings()
boolean	isCompileFirstPassTask()
boolean	isVerbose()
JAXXCompiler	newCompiler(JAXXCompilerFile jaxxFile)	Create a new compiler and attach it to the given jaxxFile.
void	registerI18nKey(String key)
protected void	reset(boolean cleanReports)	Resets all state in preparation for a new compilation session.
int	run()	Compiled a set of files.

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected final CompilerConfiguration configuration

configuration of the launchor and underlines compilers

incomingFiles

protected final JAXXCompilerFile[] incomingFiles

original list of files to compile (says the detected modfied files)

compilingFiles

protected final List<JAXXCompilerFile> compilingFiles

Files to compile

warnings

protected final List<String> warnings

Warnings detected while running.

errors

protected final List<String> errors

Errors detected while running.

tasks

protected JAXXEngineTask[] tasks

tasks to launch

currentTask

protected JAXXEngineTask currentTask

current pass of the engine

profiler

protected JAXXProfile profiler

profile attached to the engine (can be null)

Constructor Detail

JAXXEngine

protected JAXXEngine(CompilerConfiguration configuration,
                     File base,
                     String... relativePaths)

Method Detail

getTasks

public JAXXEngineTask[] getTasks()

getErrors

public List<String> getErrors()

Returns:

the errors of the engine

getWarnings

public List<String> getWarnings()

Returns:

the warnings of the engine

getProfiler

public JAXXProfile getProfiler()

getConfiguration

public CompilerConfiguration getConfiguration()

getFilesToCompile

public JAXXCompilerFile[] getFilesToCompile()

getCompiledFiles

public JAXXCompilerFile[] getCompiledFiles()

containsJaxxFileClassName

public boolean containsJaxxFileClassName(String className)

isCompileFirstPassTask

public boolean isCompileFirstPassTask()

reset

protected void reset(boolean cleanReports)

Resets all state in preparation for a new compilation session.

Parameters:

cleanReports - should we also clean reports ?

clearReports

public void clearReports()

getVersion

public String getVersion()

getJAXXCompilerFile

public JAXXCompilerFile getJAXXCompilerFile(String className)

Obtain the jaxx compiler of the given class name.

Parameters:

className - the name of the class to use

Returns:

the compiler instance which is processing the specified JAXX class. Each class is compiled by a different compiler instance.

getJAXXCompiler

public JAXXCompiler getJAXXCompiler(String className)

Obtain the jaxx compiler of the given class name.

Parameters:

className - the name of the class to use

Returns:

the compiler instance which is processing the specified JAXX class. Each class is compiled by a different compiler instance.

getDecorator

public CompiledObjectDecorator getDecorator(String name)
                                     throws IllegalArgumentException

Obtain the decorator of the given name.

Parameters:

name - the name of the decorator

Returns:

the decorator found.

Throws:

IllegalArgumentException - if decorator not found for the given name.

getDecorator

public CompiledObjectDecorator getDecorator(Class<?> type)

Obtain the decorator of the given type.

Parameters:

type - the type of the decorator (syas his fqn)

Returns:

the decorator found

addWarning

public void addWarning(String warning)

Add a warning to the engine.

Parameters:

warning - the warning to add

addError

public void addError(String error)

Add an error to the engine.

Parameters:

error - the error to add

run

public int run()

Compiled a set of files.

Returns:

-1 if errors appears, the number of generated files otherwise.

addFileToCompile

public void addFileToCompile(JAXXCompilerFile file)

Adds a file to be compiled.

Parameters:

file - the JAXXCompilerFile to add.

addFileToCompile

public void addFileToCompile(File jaxxFile,
                             String jaxxClassName)

Adds a JAXXCompilerFile given the jaxx file and the corresponding class fully qualified name.

Parameters:

jaxxFile - the jaxx file location

jaxxClassName - the fully qualified name of the jaxx class

newCompiler

public JAXXCompiler newCompiler(JAXXCompilerFile jaxxFile)
                         throws Exception

Create a new compiler and attach it to the given jaxxFile.

Parameters:

jaxxFile - the definition of jaxx file to compile

Returns:

the new compiler

Throws:

Exception - if any pb while creating of compiler

isVerbose

public boolean isVerbose()

addProfileTime

public void addProfileTime(JAXXCompiler compiler,
                           String key)

Add a profile time for the given compiler and key.

Note: if profiler is null, do nothing

Parameters:

compiler - the compiler to profile

key - the key of profiling

registerI18nKey

public void registerI18nKey(String key)

flushI18nGetterFile

public void flushI18nGetterFile()
                         throws IOException

Throws:

IOException

getValidatorFactory

public Class<?> getValidatorFactory()

getValidatorFactoryClass

public ClassDescriptor getValidatorFactoryClass()

getI18nKeysFileModel

public I18nKeysFileModel getI18nKeysFileModel(String fqn,
                                              boolean loadIfNotFound)