io.takari.maven.plugins.compile

Class AbstractCompileMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.takari.maven.plugins.compile.AbstractCompileMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CompileMojo, TestCompileMojo

public abstract class AbstractCompileMojo
extends org.apache.maven.plugin.AbstractMojo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractCompileMojo.AccessRulesViolation
static class	AbstractCompileMojo.Debug
static class	AbstractCompileMojo.Proc
static class	AbstractCompileMojo.Sourcepath

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	annotationProcessors Names of annotation processors to run.
protected String	compilerId The compiler id of the compiler to use, one of javac, forked-javac or jdt.
protected AbstractCompileMojo.Proc	proc Sets whether annotation processing is performed or not.
protected org.apache.maven.project.MavenProject	project
protected AbstractCompileMojo.Sourcepath	sourcepath Controls compilation sourcepath.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractCompileMojo()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addGeneratedSources(org.apache.maven.project.MavenProject project)
void	execute()
protected abstract List<org.apache.maven.artifact.Artifact>	getClasspathArtifacts()
protected Set<File>	getDirectDependencies()
protected abstract Set<String>	getExcludes()
protected abstract File	getGeneratedSourcesDirectory()
protected abstract Set<String>	getIncludes()
protected abstract File	getMainOutputDirectory()
protected abstract Set<String>	getMainSourceRoots()
protected abstract File	getOutputDirectory()
protected List<File>	getProcessorpath()
Charset	getSourceEncoding()
protected abstract Set<String>	getSourceRoots()
protected abstract boolean	isSkip()

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

compilerId

@Parameter(property="maven.compiler.compilerId",
           defaultValue="javac")
protected String compilerId

The compiler id of the compiler to use, one of javac, forked-javac or jdt.

proc

@Parameter
protected AbstractCompileMojo.Proc proc

Sets whether annotation processing is performed or not. This parameter is required if annotation processors are present on compile classpath.

Allowed values are:

• proc - both compilation and annotation processing are performed at the same time.
• none - no annotation processing is performed.
• only - only annotation processing is done, no compilation.

annotationProcessors

@Parameter
protected String[] annotationProcessors

Names of annotation processors to run. If not set, the default annotation processors discovery process applies.

sourcepath

@Parameter
protected AbstractCompileMojo.Sourcepath sourcepath

Controls compilation sourcepath. If set to disable, compilation sourcepath will be empty. If set to reactorProjects, compilation sourcepath will be set to compile source roots (or test compile source roots) of dependency projects of the same reactor build. The default is reactorProjects if proc=only, otherwise the default is disable.

The main usecase is proc:only annotation processing bound to generate-sources build phase. During mvn clean generate-sources execution, the reactor dependencies classes are not available and referenced types can only be resolved from java sources.

Since:

1.12

See Also:

http://docs.oracle.com/javase/8/docs/technotes/tools/unix/javac.html#BHCJJJAJ

project

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

Constructor Detail

AbstractCompileMojo

public AbstractCompileMojo()

Method Detail

getSourceEncoding

public Charset getSourceEncoding()

getDirectDependencies

protected Set<File> getDirectDependencies()

getSourceRoots

protected abstract Set<String> getSourceRoots()

getIncludes

protected abstract Set<String> getIncludes()

getExcludes

protected abstract Set<String> getExcludes()

getOutputDirectory

protected abstract File getOutputDirectory()

getClasspathArtifacts

protected abstract List<org.apache.maven.artifact.Artifact> getClasspathArtifacts()

getGeneratedSourcesDirectory

protected abstract File getGeneratedSourcesDirectory()

isSkip

protected abstract boolean isSkip()

getMainOutputDirectory

protected abstract File getMainOutputDirectory()

getMainSourceRoots

protected abstract Set<String> getMainSourceRoots()

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

getProcessorpath

protected List<File> getProcessorpath()

addGeneratedSources

protected abstract void addGeneratedSources(org.apache.maven.project.MavenProject project)