org.richfaces.builder.mojo

Class GenerateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.richfaces.builder.mojo.GenerateMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate",
      defaultPhase=GENERATE_SOURCES,
      requiresDependencyResolution=COMPILE)
public class GenerateMojo
extends org.apache.maven.plugin.AbstractMojo

Author:

asmirnov@exadel.com

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cacheEagerly Turns off library generation and verification in case when no change was detected in sources which supports Cacheable (it does not have to mean no change was done).
protected String	charset
protected List<String>	classpathElements Project classpath.
protected List<String>	compileSourceRoots The source directories containing the sources to be compiled.
protected org.apache.maven.model.FileSet[]	facesConfigs The list of JSF configuration files that will be processed by CDK.
protected boolean	forceRecompile Forces compiler to do not use cache and re-compile all sources from scratch
protected Library	library
protected String	locale
protected Map<String,String>	options
protected File	outputDirectory The directory for compiled classes.
protected File	outputJavaDirectory Directory where the output Java Files will be located.
protected File	outputLibraryCache Directory where serialized library will be cached
protected File	outputResourcesDirectory Directory where the output Java Files will be located.
protected File	outputTestDirectory
protected File	outputTestResourcesDirectory Directory where the output Java Files will be located.
protected org.apache.maven.project.MavenProject	project Top maven project.
protected String[]	sourceExcludes List of filename patterns that will be excluded from process by annotations processor.
protected String[]	sourceIncludes List of filename patterns that will be included to process by annotations processor.
protected org.apache.maven.model.FileSet[]	templates The list of JsfRenderer template files that will be processed by CDK.
protected Map<String,String>	workers

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 CdkClassLoader	createProjectClassLoader(org.apache.maven.project.MavenProject project)
protected Collection<File>	doScan(org.apache.maven.model.FileSet[] filesets) Skan Array of filesets for selected resources.
protected String[]	doScan(String[] includes, String[] excludes, File rootFolder)
void	execute()

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, toString, wait, wait, wait

Field Detail

classpathElements

@Parameter(property="project.compileClasspathElements",
           readonly=true,
           required=true)
protected List<String> classpathElements

Project classpath.

compileSourceRoots

@Parameter(property="project.compileSourceRoots",
           readonly=true,
           required=true)
protected List<String> compileSourceRoots

The source directories containing the sources to be compiled.

facesConfigs

@Parameter
protected org.apache.maven.model.FileSet[] facesConfigs

The list of JSF configuration files that will be processed by CDK. By default, CDK looks for all files in the src/main/config folder with "xml" extension.

options

@Parameter
protected Map<String,String> options

library

@Parameter
protected Library library

outputDirectory

@Parameter(property="project.build.outputDirectory",
           readonly=true,
           required=true)
protected File outputDirectory

The directory for compiled classes.

outputJavaDirectory

@Parameter(defaultValue="${project.build.directory}/generated-sources/main/java")
protected File outputJavaDirectory

Directory where the output Java Files will be located.

outputResourcesDirectory

@Parameter(defaultValue="${project.build.directory}/generated-sources/main/resources")
protected File outputResourcesDirectory

Directory where the output Java Files will be located.

outputTestDirectory

@Parameter(defaultValue="${project.build.directory}/generated-sources/test/java")
protected File outputTestDirectory

outputTestResourcesDirectory

@Parameter(defaultValue="${project.build.directory}/generated-sources/test/resources")
protected File outputTestResourcesDirectory

Directory where the output Java Files will be located.

outputLibraryCache

@Parameter(defaultValue="${project.build.directory}/library-cache")
protected File outputLibraryCache

Directory where serialized library will be cached

forceRecompile

@Parameter(property="cdk.recompile",
           defaultValue="false")
protected boolean forceRecompile

Forces compiler to do not use cache and re-compile all sources from scratch

cacheEagerly

@Parameter(property="cdk.cache.eagerly",
           defaultValue="false")
protected boolean cacheEagerly

Turns off library generation and verification in case when no change was detected in sources which supports Cacheable (it does not have to mean no change was done). Warning: when getting undesired results, try to turn off this option.

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

Top maven project.

sourceExcludes

@Parameter
protected String[] sourceExcludes

List of filename patterns that will be excluded from process by annotations processor. By default, all *.java files will be processed.

sourceIncludes

@Parameter
protected String[] sourceIncludes

List of filename patterns that will be included to process by annotations processor. By default, all *.java files will be processed.

templates

@Parameter
protected org.apache.maven.model.FileSet[] templates

The list of JsfRenderer template files that will be processed by CDK. By default, CDK looks for all files in the src/main/templates folder with "xml" extension.

workers

@Parameter
protected Map<String,String> workers

locale

@Parameter
protected String locale

charset

@Parameter
protected String charset

Constructor Detail

GenerateMojo

public GenerateMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

createProjectClassLoader

protected CdkClassLoader createProjectClassLoader(org.apache.maven.project.MavenProject project)

doScan

protected String[] doScan(String[] includes,
              String[] excludes,
              File rootFolder)
                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

doScan

protected Collection<File> doScan(org.apache.maven.model.FileSet[] filesets)
                           throws org.apache.maven.plugin.MojoExecutionException

Skan Array of filesets for selected resources.

Parameters:

filesets -

Returns:

Throws:

org.apache.maven.plugin.MojoExecutionException