org.nuiton.jaxx.plugin

Class GenerateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.jaxx.plugin.AbstractJaxxMojo

org.nuiton.jaxx.plugin.GenerateMojo

All Implemented Interfaces:

CompilerConfiguration, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.nuiton.plugin.Plugin, org.nuiton.plugin.PluginWithEncoding

@Mojo(name="generate",
      defaultPhase=PROCESS_SOURCES,
      requiresDependencyResolution=COMPILE,
      requiresProject=true)
public class GenerateMojo
extends AbstractJaxxMojo
implements CompilerConfiguration

Generates some java code from jaxx files.

Author:

tchemit

Nested Class Summary

Nested classes/interfaces inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo

AbstractJaxxMojo.JaxxFileUpdater

Nested classes/interfaces inherited from interface org.nuiton.plugin.Plugin

org.nuiton.plugin.Plugin.InitState, org.nuiton.plugin.Plugin.Packaging

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addCompileClassPath Flag to include in compiler classpath the compile class-path (can only be used in a test phase).
protected boolean	addLogger Flag to add logger to each generated jaxx file.
protected boolean	addProjectClassPath Flag to include in compiler classpath the project compile classpath.
protected boolean	addResourcesToClassPath Flag to include in compiler classpath the java resources directories (src and outJava).
protected boolean	addSourcesToClassPath Flag to include in compiler classpath the java sources directories (src and outJava).
protected boolean	autoImportCss To auto import css files for a jaxx file.
protected boolean	autoRecurseInCss To let jaxx recurses in css when a JAXX Object auto import css files for a jaxx file.
protected String[]	beanInfoSearchPath Extra path to be added in Introspector.setBeanInfoSearchPath(String[]).
protected ClassLoader	cl customized classloader to use in engine
protected String	compilerFQN FQN of compiler to use (by default swing one).
protected Map<String,CompiledObjectDecorator>	decorators Decorators available in engine.
protected String	defaultDecoratorFQN The FQN of the ui to use for error notification.
protected String	defaultErrorUIFQN The FQN of the ui to use for error notification.
protected String[]	excludes To filter files to NOt treat.
protected String	extraImportList List of fqn of class toimport for all generated jaxx files.
protected String[]	files detected jaxx files in init() method
protected Map<String,JAXXCompilerFinalizer>	finalizers Finalizers available in engine.
protected String	helpBrokerFQN the FQN of help broker By default, use the JAXX implementation JAXXHelpBroker.
protected boolean	i18nable To make compiler i18nable, says add the I18n._(String, Object...) method invocation on I18nHelper.I18N_ATTRIBUTES attributes.
protected String[]	includes To filter file to treat.
protected Map<String,Initializer>	initializers Initializers available to init engine.
protected String	jaxxContextFQN The name of implementation of JAXXContextto be used on JAXXObject.
protected boolean	optimize To optimize generated code.
protected File	outJava Where to generate java files.
protected boolean	profile flag to activate profile mode.
protected boolean	resetAfterCompile Flag to keep compilers after the generate operation (usefull for tests.
protected boolean	showBinding To show detected bindings.
protected File	src Directory where jaxx files are located.
protected boolean	testPhase A flag to mark the mojo to be used in a test phase.
protected org.nuiton.io.MirroredFileUpdater	updater file updater used to detect jaxx files.
protected boolean	useUIManagerForIcon A flag to use UIManager to retreave icons.

Fields inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo

generateHelp

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkSkip()
void	doAction()
protected void	fixCompileSourceRoots()
ClassLoader	getClassLoader()
Class<? extends JAXXCompiler>	getCompilerClass()
Map<String,CompiledObjectDecorator>	getDecorators()
Class<? extends CompiledObjectDecorator>	getDefaultDecoratorClass()
Class<?>	getDefaultErrorUI()
JAXXEngine	getEngine()
String[]	getExtraImports()
Map<String,JAXXCompilerFinalizer>	getFinalizers()
String	getHelpBrokerFQN()
Map<String,Initializer>	getInitializers()
Class<? extends JAXXContext>	getJaxxContextClass()
boolean	getOptimize()
File	getTargetDirectory()
void	init()
boolean	isAddLogger()
boolean	isAutoImportCss()
boolean	isAutoRecurseInCss()
boolean	isGenerateHelp()
boolean	isI18nable()
boolean	isOptimize()
boolean	isProfile()
boolean	isResetAfterCompile()
boolean	isShowClassDescriptorLoading()
boolean	isUseUIManagerForIcon()
protected void	report(JAXXEngine engine)
void	setTargetDirectory(File targetDirectory)
String	toString()

Methods inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo

checkPackaging, getEncoding, getLastModified, getProject, isForce, isVerbose, setEncoding, setForce, setProject, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, afterExecute, backupFile, checkEncoding, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getRootProject, getTemplate, hasClassPath, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, renameFile, writeFile

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface jaxx.compiler.CompilerConfiguration

getEncoding, isVerbose

Methods inherited from interface org.apache.maven.plugin.Mojo

execute, getLog, setLog

Field Detail

src

@Parameter(property="jaxx.src",
           defaultValue="${basedir}/src/main/java")
protected File src

Directory where jaxx files are located.

outJava

@Parameter(property="jaxx.outJava",
           defaultValue="${basedir}/target/generated-sources/java")
protected File outJava

Where to generate java files.

includes

@Parameter(property="jaxx.includes")
protected String[] includes

To filter file to treat.

excludes

@Parameter(property="jaxx.excludes")
protected String[] excludes

To filter files to NOt treat.

compilerFQN

@Parameter(property="jaxx.compilerFQN",
           defaultValue="jaxx.compiler.JAXXCompiler",
           required=true)
protected String compilerFQN

FQN of compiler to use (by default swing one).

jaxxContextFQN

@Parameter(property="jaxx.jaxxContextFQN",
           defaultValue="jaxx.runtime.context.DefaultJAXXContext",
           required=true)
protected String jaxxContextFQN

The name of implementation of JAXXContextto be used on JAXXObject.

Must not be abstract.

defaultErrorUIFQN

@Parameter(property="jaxx.defaultErrorUIFQN")
protected String defaultErrorUIFQN

The FQN of the ui to use for error notification.

If not given, will use the one defined in validator

defaultDecoratorFQN

@Parameter(property="jaxx.defaultDecoratorFQN",
           defaultValue="jaxx.compiler.decorators.DefaultCompiledObjectDecorator")
protected String defaultDecoratorFQN

The FQN of the ui to use for error notification.

If not given, will use the one defined in validator

See Also:

CompiledObjectDecorator

addSourcesToClassPath

@Parameter(property="jaxx.addSourcesToClassPath",
           defaultValue="false")
protected boolean addSourcesToClassPath

Flag to include in compiler classpath the java sources directories (src and outJava).

By default, false.

addResourcesToClassPath

@Parameter(property="jaxx.addResourcesToClassPath",
           defaultValue="false")
protected boolean addResourcesToClassPath

Flag to include in compiler classpath the java resources directories (src and outJava).

By default, false.

Since:

1.6.0

addCompileClassPath

@Parameter(property="jaxx.addCompileClassPath",
           defaultValue="false")
protected boolean addCompileClassPath

Flag to include in compiler classpath the compile class-path (can only be used in a test phase).

By default, false.

Since:

1.6.0

addProjectClassPath

@Parameter(property="jaxx.addProjectClassPath",
           defaultValue="false")
protected boolean addProjectClassPath

Flag to include in compiler classpath the project compile classpath.

By default, false.

testPhase

@Parameter(property="jaxx.testPhase",
           defaultValue="false")
protected boolean testPhase

A flag to mark the mojo to be used in a test phase. This will permits to add generated sources in test compile roots.

Since:

1.6.0

i18nable

@Parameter(property="jaxx.i18nable",
           defaultValue="true")
protected boolean i18nable

To make compiler i18nable, says add the I18n._(String, Object...) method invocation on I18nHelper.I18N_ATTRIBUTES attributes.

See Also:

I18nHelper

optimize

@Parameter(property="jaxx.optimize",
           defaultValue="false")
protected boolean optimize

To optimize generated code.

autoImportCss

@Parameter(property="jaxx.autoImportCss",
           defaultValue="false")
protected boolean autoImportCss

To auto import css files for a jaxx file.

Since:

2.0.2

autoRecurseInCss

@Parameter(property="jaxx.autoRecurseInCss",
           defaultValue="true")
protected boolean autoRecurseInCss

To let jaxx recurses in css when a JAXX Object auto import css files for a jaxx file.

Warning: This option will be removed in version 3.0 or at least default value will become false.

Since:

2.0.2

addLogger

@Parameter(property="jaxx.addLogger",
           defaultValue="true")
protected boolean addLogger

Flag to add logger to each generated jaxx file.

By default, always add it.

resetAfterCompile

@Parameter(property="jaxx.resetAfterCompile",
           defaultValue="true")
protected boolean resetAfterCompile

Flag to keep compilers after the generate operation (usefull for tests.

By default, always reset.

beanInfoSearchPath

@Parameter(property="jaxx.beanInfoSearchPath")
protected String[] beanInfoSearchPath

Extra path to be added in Introspector.setBeanInfoSearchPath(String[]).

add beanInfoSearchPath to be registred by BeanInfoUtil.addJaxxBeanInfoPath(String...)

and then will be use by DefaultInitializer.initialize().

This permit to use real beanInfo of imported graphic libraries.

extraImportList

@Parameter(property="jaxx.extraImportList")
protected String extraImportList

List of fqn of class toimport for all generated jaxx files.

useUIManagerForIcon

@Parameter(property="jaxx.useUIManagerForIcon",
           defaultValue="false")
protected boolean useUIManagerForIcon

A flag to use UIManager to retreave icons.

profile

@Parameter(property="jaxx.profile",
           defaultValue="false")
protected boolean profile

flag to activate profile mode.

By default, not active.

showBinding

@Parameter(property="jaxx.showBinding",
           defaultValue="false")
protected boolean showBinding

To show detected bindings.

By default, do not show them.

Since:

2.0.0

helpBrokerFQN

@Parameter(property="jaxx.helpBrokerFQN",
           defaultValue="jaxx.runtime.swing.help.JAXXHelpBroker")
protected String helpBrokerFQN

the FQN of help broker

By default, use the JAXX implementation JAXXHelpBroker.

Since:

1.3

decorators

@Component(role=jaxx.compiler.CompiledObjectDecorator.class)
protected Map<String,CompiledObjectDecorator> decorators

Decorators available in engine.

Since:

2.0.2

finalizers

@Component(role=jaxx.compiler.finalizers.JAXXCompilerFinalizer.class)
protected Map<String,JAXXCompilerFinalizer> finalizers

Finalizers available in engine.

Since:

2.0.2

initializers

@Component(role=jaxx.compiler.spi.Initializer.class)
protected Map<String,Initializer> initializers

Initializers available to init engine.

Since:

2.0.2

files

protected String[] files

detected jaxx files in init() method

updater

protected org.nuiton.io.MirroredFileUpdater updater

file updater used to detect jaxx files.

Note: if AbstractJaxxMojo.verbose flag is on, will ne be used

cl

protected ClassLoader cl

customized classloader to use in engine

Constructor Detail

GenerateMojo

public GenerateMojo()

Method Detail

init

public void init()
          throws Exception

Specified by:

init in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

checkSkip

protected boolean checkSkip()

Overrides:

checkSkip in class org.nuiton.plugin.AbstractPlugin

doAction

public void doAction()
              throws Exception

Specified by:

doAction in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

getTargetDirectory

public File getTargetDirectory()

Specified by:

getTargetDirectory in interface CompilerConfiguration

Specified by:

getTargetDirectory in class AbstractJaxxMojo

setTargetDirectory

public void setTargetDirectory(File targetDirectory)

Specified by:

setTargetDirectory in class AbstractJaxxMojo

getOptimize

public boolean getOptimize()

Specified by:

getOptimize in interface CompilerConfiguration

isAutoImportCss

public boolean isAutoImportCss()

Specified by:

isAutoImportCss in interface CompilerConfiguration

isAutoRecurseInCss

public boolean isAutoRecurseInCss()

Specified by:

isAutoRecurseInCss in interface CompilerConfiguration

isI18nable

public boolean isI18nable()

Specified by:

isI18nable in interface CompilerConfiguration

isUseUIManagerForIcon

public boolean isUseUIManagerForIcon()

Specified by:

isUseUIManagerForIcon in interface CompilerConfiguration

isAddLogger

public boolean isAddLogger()

Specified by:

isAddLogger in interface CompilerConfiguration

isShowClassDescriptorLoading

public boolean isShowClassDescriptorLoading()

Specified by:

isShowClassDescriptorLoading in interface CompilerConfiguration

getJaxxContextClass

public Class<? extends JAXXContext> getJaxxContextClass()

Specified by:

getJaxxContextClass in interface CompilerConfiguration

getExtraImports

public String[] getExtraImports()

Specified by:

getExtraImports in interface CompilerConfiguration

isResetAfterCompile

public boolean isResetAfterCompile()

Specified by:

isResetAfterCompile in interface CompilerConfiguration

isOptimize

public boolean isOptimize()

Specified by:

isOptimize in interface CompilerConfiguration

getDefaultErrorUI

public Class<?> getDefaultErrorUI()

Specified by:

getDefaultErrorUI in interface CompilerConfiguration

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface CompilerConfiguration

getCompilerClass

public Class<? extends JAXXCompiler> getCompilerClass()

Specified by:

getCompilerClass in interface CompilerConfiguration

getDefaultDecoratorClass

public Class<? extends CompiledObjectDecorator> getDefaultDecoratorClass()

Specified by:

getDefaultDecoratorClass in interface CompilerConfiguration

isProfile

public boolean isProfile()

Specified by:

isProfile in interface CompilerConfiguration

isGenerateHelp

public boolean isGenerateHelp()

Specified by:

isGenerateHelp in interface CompilerConfiguration

getHelpBrokerFQN

public String getHelpBrokerFQN()

Specified by:

getHelpBrokerFQN in interface CompilerConfiguration

getDecorators

public Map<String,CompiledObjectDecorator> getDecorators()

Specified by:

getDecorators in interface CompilerConfiguration

getFinalizers

public Map<String,JAXXCompilerFinalizer> getFinalizers()

Specified by:

getFinalizers in interface CompilerConfiguration

getInitializers

public Map<String,Initializer> getInitializers()

Specified by:

getInitializers in interface CompilerConfiguration

getEngine

public JAXXEngine getEngine()

toString

public String toString()

Overrides:

toString in class Object

fixCompileSourceRoots

protected void fixCompileSourceRoots()

report

protected void report(JAXXEngine engine)