AbstractAjcCompiler (Mojo's AspectJ Maven Plugin 1.8 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.codehaus.mojo.aspectj.AbstractAjcMojo
  - - org.codehaus.mojo.aspectj.AbstractAjcCompiler

All Implemented Interfaces:

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

Direct Known Subclasses:

AjcCompileMojo, AjcTestCompileMojo
```
public abstract class AbstractAjcCompiler
extends AbstractAjcMojo
```
Base class for the two aspectJ compiletime weaving mojos.
For all available options see http://www.eclipse.org/aspectj/doc/released/devguide/ajc-ref.html

Author:

Kaare Nilsen

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`ajcOptions` Holder for ajc compiler options
`protected String`	`ajdtBuildDefFile` Where to find the ajdt build definition file.
`protected String`	`argumentFileName` The filename holding AJC build arguments.
`protected String`	`aspectDirectory` The source directory for the aspects.
`protected String`	`bootclasspath` Override location of VM's bootclasspath for purposes of evaluating types when compiling.
`protected String`	`complianceLevel` Specify compiler compliance setting.
`protected boolean`	`crossrefs` generate .ajsym file into the output directory
`protected boolean`	`deprecation` Toggle warning messages on deprecations
`protected boolean`	`emacssym` Generate .ajesym symbol files for emacs support.
`protected String`	`encoding` Specify default source encoding format.
`protected String[]`	`excludes` List of ant-style patterns used to specify the aspects that should be excluded when compiling.
`protected boolean`	`forceAjcCompile` Forces re-compilation, regardless of whether the compiler arguments or the sources have changed.
`protected String[]`	`includes` List of ant-style patterns used to specify the aspects that should be included when compiling.
`protected boolean`	`noImportError` Emit no errors for unresolved imports;
`protected boolean`	`outxml` Generate aop.xml file for load-time weaving with default name (/META-INF/aop.xml).
`protected String`	`outxmlfile` Generate aop.xml file for load-time weaving with custom name.
`protected boolean`	`preserveAllLocals` Preserve all local variables during code generation (to facilitate debugging).
`protected String`	`proc` Set the compiler "proc" argument.
`protected boolean`	`proceedOnError` Keep compiling after error, dumping class files with problem methods
`protected boolean`	`referenceInfo` Compute reference information.
`protected int`	`repeat` Repeat compilation process N times (typically to do performance analysis).
`protected Set<String>`	`resolvedIncludes` Holds all files found using the includes, excludes parameters.
`protected boolean`	`showWeaveInfo` Emit messages about weaving
`protected String`	`source` Toggle assertions (1.3, 1.4, 1.5, 1.6, 1.7 or 1.8 - default is 1.4).
`protected String`	`target` Specify classfile target setting (1.1 to 1.8) default is 1.2
`protected String`	`testAspectDirectory` The source directory for the test aspects.
`protected boolean`	`verbose` Emit messages about accessed/processed compilation units
`protected String`	`warn` Emit warnings for any instances of the comma-delimited list of questionable code.
`protected boolean`	`XaddSerialVersionUID` Causes the compiler to calculate and add the SerialVersionUID field to any type implementing `Serializable` that is affected by an aspect.
`protected String`	`Xajruntimetarget` (Experimental) Allows code to be generated that targets a 1.2 or a 1.5 level AspectJ runtime (default 1.5)
`static List<String>`	`XAJRUNTIMETARGET_SUPPORTED_VALUES` List holding all accepted values for the `Xajruntimetarget` parameter.
`protected boolean`	`XhasMember` Enables the compiler to support hasmethod(method_pattern) and hasfield(field_pattern) type patterns, but only within declare statements.
`protected String`	`Xjoinpoints` supply a comma separated list of new joinpoints that can be identified by pointcuts.
`protected String`	`Xlint` Set default level for messages about potential programming mistakes in crosscutting code.
`protected File`	`Xlintfile` Specify properties file to set levels for specific crosscutting messages.
`protected boolean`	`XnoInline` (Experimental) do not inline around advice
`protected boolean`	`XnotReweavable` (Experimental) Create class files that can't be subsequently rewoven by AspectJ.
`protected boolean`	`Xreweavable` (Experimental) runs weaver in reweavable mode which causes it to create woven classes that can be rewoven, subject to the restriction that on attempting a reweave all the types that advised the woven type must be accessible.
`protected boolean`	`XserializableAspects` (Experimental) Normally it is an error to declare aspects `Serializable`.
`protected Map<String,String>`	`Xset` Allows the caller to provide additional arguments in a Map format.
`protected boolean`	`XterminateAfterCompilation` Causes compiler to terminate before weaving

Fields inherited from class org.codehaus.mojo.aspectj.AbstractAjcMojo
aspectLibraries, basedir, project, weaveDependencies, weaveDirectories, xmlConfigured

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

Constructor Summary

Constructors
Constructor and Description

AbstractAjcCompiler()

Constructors
Constructor and Description
`AbstractAjcCompiler()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`assembleArguments()` Assembles a complete ajc compiler arguments list.
`void`	`execute()` Do the AspectJ compiling.
`protected abstract String`	`getAdditionalAspectPaths()` Abstract method used by child classes to specify additional aspect paths.
`protected abstract List<String>`	`getClasspathDirectories()` Abstract method used by child classes to specify the correct output directory for compiled classes.
`protected Set<String>`	`getIncludedSources()`
`protected abstract org.codehaus.plexus.util.Scanner[]`	`getJavaSources()`
`protected abstract File`	`getOutputDirectory()` The directory where compiled classes go.
`protected abstract List<String>`	`getSourceDirectories()` Abstract method used by child classes to specify the correct source directory for classes.
`protected boolean`	`isBuildNeeded()` Checks modifications that would make us need a build
`void`	`setArgumentFileName(String argumentFileName)`
`void`	`setBootClassPath(String bootclasspath)`
`void`	`setComplianceLevel(String complianceLevel)` Setters which when called sets compiler arguments
`void`	`setCrossrefs(boolean crossrefs)`
`void`	`setDeprecation(boolean deprecation)`
`void`	`setEmacssym(boolean emacssym)`
`void`	`setEncoding(String encoding)`
`void`	`setNoImportError(boolean noImportError)`
`void`	`setOutxml(boolean outxml)`
`void`	`setOutxmlfile(String outxmlfile)`
`void`	`setPreserveAllLocals(boolean preserveAllLocals)`
`void`	`setProceedOnError(boolean proceedOnError)`
`void`	`setReferenceInfo(boolean referenceInfo)`
`void`	`setRepeat(int repeat)`
`void`	`setShowWeaveInfo(boolean showWeaveInfo)`
`void`	`setSource(String source)`
`void`	`setTarget(String target)`
`void`	`setVerbose(boolean verbose)`
`void`	`setWarn(String warn)`
`void`	`setXaddSerialVersionUID(boolean xaddSerialVersionUID)`
`void`	`setXajruntimetarget(String xajruntimetarget)`
`void`	`setXhasMember(boolean xhasMember)`
`void`	`setXjoinpoints(String xjoinpoints)`
`void`	`setXlint(String xlint)`
`void`	`setXlintfile(File xlintfile)`
`void`	`setXnoInline(boolean xnoInline)`
`void`	`setXnotReweavable(boolean xnotReweavable)`
`void`	`setXreweavable(boolean xreweavable)`
`void`	`setXserializableAspects(boolean xserializableAspects)`
`void`	`setXset(Map<String,String> xset)`
`void`	`setXterminateAfterCompilation(boolean xterminateAfterCompilation)`

Methods inherited from class org.codehaus.mojo.aspectj.AbstractAjcMojo
isSkip, setXmlConfigured

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
  - XAJRUNTIMETARGET_SUPPORTED_VALUES
```
public static final List<String> XAJRUNTIMETARGET_SUPPORTED_VALUES
```
    List holding all accepted values for the Xajruntimetarget parameter.
  - aspectDirectory
```
@Parameter(defaultValue="src/main/aspect")
protected String aspectDirectory
```
    The source directory for the aspects.
  - testAspectDirectory
```
@Parameter(defaultValue="src/test/aspect")
protected String testAspectDirectory
```
    The source directory for the test aspects.
  - includes
```
@Parameter
protected String[] includes
```
    List of ant-style patterns used to specify the aspects that should be included when compiling. When none specified all .java and .aj files in the project source directories, or directories specified by the ajdtDefFile property are included.
  - excludes
```
@Parameter
protected String[] excludes
```
    List of ant-style patterns used to specify the aspects that should be excluded when compiling. When none specified all .java and .aj files in the project source directories, or directories specified by the ajdtDefFile property are included.
  - ajdtBuildDefFile
```
@Parameter
protected String ajdtBuildDefFile
```
    Where to find the ajdt build definition file. If set this will override the use of project sourcedirs.
  - outxml
```
@Parameter
protected boolean outxml
```
    Generate aop.xml file for load-time weaving with default name (/META-INF/aop.xml).
  - outxmlfile
```
@Parameter
protected String outxmlfile
```
    Generate aop.xml file for load-time weaving with custom name.
  - emacssym
```
@Parameter
protected boolean emacssym
```
    Generate .ajesym symbol files for emacs support.
  - proc
```
@Parameter
protected String proc
```
    Set the compiler "proc" argument. Aspectj supports Annotation processing since 1.8.2, it can been disabled by proc:none.
    
    See Also:
    AspectJ 1.8.2 Release notes, Annotation Processing
  - Xset
```
@Parameter
protected Map<String,String> Xset
```
    Allows the caller to provide additional arguments in a Map format. For example:
```
 <configuration>
   <Xset>
     <overWeaving>true</overWeaving>
     <avoidFinal>false</avoidFinal>
   </Xset>
 </configuration>
 
```
    Since:
    
    1.5
  - crossrefs
```
@Parameter
protected boolean crossrefs
```
    generate .ajsym file into the output directory
  - Xlint
```
@Parameter
protected String Xlint
```
    Set default level for messages about potential programming mistakes in crosscutting code. {level} may be ignore, warning, or error. This overrides entries in org/aspectj/weaver/XlintDefault.properties from aspectjtools.jar.
  - Xlintfile
```
@Parameter
protected File Xlintfile
```
    Specify properties file to set levels for specific crosscutting messages. PropertyFile is a path to a Java .properties file that takes the same property names and values as org/aspectj/weaver/XlintDefault.properties from aspectjtools.jar, which it also overrides.
  - XhasMember
```
@Parameter
protected boolean XhasMember
```
    Enables the compiler to support hasmethod(method_pattern) and hasfield(field_pattern) type patterns, but only within declare statements. It's experimental and undocumented because it may change, and because it doesn't yet take into account ITDs.
    
    Since:
    
    1.3
  - target
```
@Parameter(defaultValue="${project.build.java.target}")
protected String target
```
    Specify classfile target setting (1.1 to 1.8) default is 1.2
  - source
```
@Parameter(defaultValue="${mojo.java.target}")
protected String source
```
    Toggle assertions (1.3, 1.4, 1.5, 1.6, 1.7 or 1.8 - default is 1.4). When using -source 1.3, an assert() statement valid under Java 1.4 will result in a compiler error. When using -source 1.4, treat assert as a keyword and implement assertions according to the 1.4 language spec. When using -source 1.5 or higher, Java 5 language features are permitted. With --source 1.7 or higher Java 7 features are supported.
  - complianceLevel
```
@Parameter(defaultValue="1.4")
protected String complianceLevel
```
    Specify compiler compliance setting. Defaults to 1.4, with permitted values ("1.3", "1.4", "1.5", "1.6" and "1.7", "1.8").
    
    See Also:
    AjcHelper.ACCEPTED_COMPLIANCE_LEVEL_VALUES
  - deprecation
```
@Parameter
protected boolean deprecation
```
    Toggle warning messages on deprecations
  - noImportError
```
@Parameter
protected boolean noImportError
```
    Emit no errors for unresolved imports;
  - proceedOnError
```
@Parameter
protected boolean proceedOnError
```
    Keep compiling after error, dumping class files with problem methods
  - preserveAllLocals
```
@Parameter
protected boolean preserveAllLocals
```
    Preserve all local variables during code generation (to facilitate debugging).
  - referenceInfo
```
@Parameter
protected boolean referenceInfo
```
    Compute reference information.
  - encoding
```
@Parameter(property="project.build.sourceEncoding")
protected String encoding
```
    Specify default source encoding format.
  - verbose
```
@Parameter
protected boolean verbose
```
    Emit messages about accessed/processed compilation units
  - showWeaveInfo
```
@Parameter
protected boolean showWeaveInfo
```
    Emit messages about weaving
  - repeat
```
@Parameter
protected int repeat
```
    Repeat compilation process N times (typically to do performance analysis).
  - Xreweavable
```
@Parameter
protected boolean Xreweavable
```
    (Experimental) runs weaver in reweavable mode which causes it to create woven classes that can be rewoven, subject to the restriction that on attempting a reweave all the types that advised the woven type must be accessible.
  - XnotReweavable
```
@Parameter
protected boolean XnotReweavable
```
    (Experimental) Create class files that can't be subsequently rewoven by AspectJ.
  - XnoInline
```
@Parameter
protected boolean XnoInline
```
    (Experimental) do not inline around advice
  - XserializableAspects
```
@Parameter
protected boolean XserializableAspects
```
    (Experimental) Normally it is an error to declare aspects Serializable. This option removes that restriction.
  - XaddSerialVersionUID
```
@Parameter
protected boolean XaddSerialVersionUID
```
    Causes the compiler to calculate and add the SerialVersionUID field to any type implementing Serializable that is affected by an aspect. The field is calculated based on the class before weaving has taken place.
  - XterminateAfterCompilation
```
@Parameter
protected boolean XterminateAfterCompilation
```
    Causes compiler to terminate before weaving
  - Xajruntimetarget
```
@Parameter(defaultValue="1.5")
protected String Xajruntimetarget
```
    (Experimental) Allows code to be generated that targets a 1.2 or a 1.5 level AspectJ runtime (default 1.5)
  - Xjoinpoints
```
@Parameter
protected String Xjoinpoints
```
    supply a comma separated list of new joinpoints that can be identified by pointcuts. Values are: arrayconstruction, synchronization
  - bootclasspath
```
@Parameter
protected String bootclasspath
```
    Override location of VM's bootclasspath for purposes of evaluating types when compiling. Path is a single argument containing a list of paths to zip files or directories, delimited by the platform-specific path delimiter.
  - warn
```
@Parameter
protected String warn
```
    Emit warnings for any instances of the comma-delimited list of questionable code. Supported values are shown in the list below, with their respective explanations - as copied directly from the AJC reference.
    
    constructorName
    
    method with constructor name
    
    packageDefaultMethod
    
    attempt to override package-default method
    
    deprecation
    
    usage of deprecated type or member
    
    maskedCatchBlocks
    
    hidden catch block
    
    unusedLocals
    
    local variable never read
    
    unusedArguments
    
    method argument never read
    
    unusedImports
    
    import statement not used by code in file
    
    none
    
    suppress all compiler warnings
    
    See Also:
    Eclipse AJC reference
  - argumentFileName
```
@Parameter(defaultValue="builddef.lst")
protected String argumentFileName
```
    The filename holding AJC build arguments. The file will be placed in the project build output directory, and will contain all the arguments passed to the AJC compiler in the last run, and also all the files included in the AJC build.
    Sample content shown below to illustrate typical content within the builddef.lst file:
```
     
 -1.6
 -encoding
 UTF-8
 -classpath
 /Users/lj/Development/Projects/Nazgul/nazgul_tools/validation/validation-api/target/nazgul-tools-validation-api-2.0.10-SNAPSHOT.jar:/Users/lj/.m2/repository/org/slf4j/slf4j-api/1.7.5/slf4j-api-1.7.5.jar:/Users/lj/.m2/repository/org/aspectj/aspectjrt/1.7.3/aspectjrt-1.7.3.jar:/Users/lj/.m2/repository/junit/junit/4.11/junit-4.11.jar:/Users/lj/.m2/repository/ch/qos/logback/logback-classic/1.0.13/logback-classic-1.0.13.jar:/Users/lj/.m2/repository/org/apache/commons/commons-lang3/3.1/commons-lang3-3.1.jar:/Users/lj/Development/Projects/Nazgul/nazgul_tools/validation/validation-aspect/target/classes
 -d
 /Users/lj/Development/Projects/Nazgul/nazgul_tools/validation/validation-aspect/target/classes
 /Users/lj/Development/Projects/Nazgul/nazgul_tools/validation/validation-aspect/src/main/java/se/jguru/nazgul/tools/validation/aspect/ValidationAspect.java
     
 
```
  - forceAjcCompile
```
@Parameter(defaultValue="false")
protected boolean forceAjcCompile
```
    Forces re-compilation, regardless of whether the compiler arguments or the sources have changed.
  - ajcOptions
```
protected List<String> ajcOptions
```
    Holder for ajc compiler options
  - resolvedIncludes
```
protected Set<String> resolvedIncludes
```
    Holds all files found using the includes, excludes parameters.
- Constructor Detail
  - AbstractAjcCompiler
```
public AbstractAjcCompiler()
```
- Method Detail
  - getClasspathDirectories
```
protected abstract List<String> getClasspathDirectories()
```
    Abstract method used by child classes to specify the correct output directory for compiled classes.
    
    Returns:
    the directories containing compiled classes.
  - getOutputDirectory
```
protected abstract File getOutputDirectory()
```
    The directory where compiled classes go.
    
    Returns:
    the outputDirectory
  - getSourceDirectories
```
protected abstract List<String> getSourceDirectories()
```
    Abstract method used by child classes to specify the correct source directory for classes.
    
    Returns:
    where sources may be found.
  - getJavaSources
```
protected abstract org.codehaus.plexus.util.Scanner[] getJavaSources()
```
  - getAdditionalAspectPaths
```
protected abstract String getAdditionalAspectPaths()
```
    Abstract method used by child classes to specify additional aspect paths.
    
    Returns:
    the additional aspect paths
  - execute
```
public void execute()
             throws org.apache.maven.plugin.MojoExecutionException
```
    Do the AspectJ compiling.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
  - assembleArguments
```
protected void assembleArguments()
                          throws org.apache.maven.plugin.MojoExecutionException
```
    Assembles a complete ajc compiler arguments list.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - error in configuration
  - getIncludedSources
```
protected Set<String> getIncludedSources()
                                  throws org.apache.maven.plugin.MojoExecutionException
```
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
  - isBuildNeeded
```
protected boolean isBuildNeeded()
                         throws org.apache.maven.plugin.MojoExecutionException
```
    Checks modifications that would make us need a build
    
    Returns:
    true if build is needed, otherwise false
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
  - setComplianceLevel
```
public void setComplianceLevel(String complianceLevel)
```
    Setters which when called sets compiler arguments
    
    Parameters:
    complianceLevel - the complianceLevel
  - setDeprecation
```
public void setDeprecation(boolean deprecation)
```
  - setEmacssym
```
public void setEmacssym(boolean emacssym)
```
  - setCrossrefs
```
public void setCrossrefs(boolean crossrefs)
```
  - setEncoding
```
public void setEncoding(String encoding)
```
  - setNoImportError
```
public void setNoImportError(boolean noImportError)
```
  - setOutxml
```
public void setOutxml(boolean outxml)
```
  - setOutxmlfile
```
public void setOutxmlfile(String outxmlfile)
```
  - setPreserveAllLocals
```
public void setPreserveAllLocals(boolean preserveAllLocals)
```
  - setProceedOnError
```
public void setProceedOnError(boolean proceedOnError)
```
  - setReferenceInfo
```
public void setReferenceInfo(boolean referenceInfo)
```
  - setRepeat
```
public void setRepeat(int repeat)
```
  - setShowWeaveInfo
```
public void setShowWeaveInfo(boolean showWeaveInfo)
```
  - setTarget
```
public void setTarget(String target)
```
  - setSource
```
public void setSource(String source)
```
  - setVerbose
```
public void setVerbose(boolean verbose)
```
  - setXhasMember
```
public void setXhasMember(boolean xhasMember)
```
  - setXlint
```
public void setXlint(String xlint)
```
  - setXset
```
public void setXset(Map<String,String> xset)
```
  - setXlintfile
```
public void setXlintfile(File xlintfile)
```
  - setXnoInline
```
public void setXnoInline(boolean xnoInline)
```
  - setXreweavable
```
public void setXreweavable(boolean xreweavable)
```
  - setXnotReweavable
```
public void setXnotReweavable(boolean xnotReweavable)
```
  - setXserializableAspects
```
public void setXserializableAspects(boolean xserializableAspects)
```
  - setXaddSerialVersionUID
```
public void setXaddSerialVersionUID(boolean xaddSerialVersionUID)
```
  - setXterminateAfterCompilation
```
public void setXterminateAfterCompilation(boolean xterminateAfterCompilation)
```
  - setXajruntimetarget
```
public void setXajruntimetarget(String xajruntimetarget)
```
  - setBootClassPath
```
public void setBootClassPath(String bootclasspath)
```
  - setXjoinpoints
```
public void setXjoinpoints(String xjoinpoints)
```
  - setWarn
```
public void setWarn(String warn)
```
  - setArgumentFileName
```
public void setArgumentFileName(String argumentFileName)
```

Class AbstractAjcCompiler

Field Summary

Fields inherited from class org.codehaus.mojo.aspectj.AbstractAjcMojo

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

Constructor Summary

Method Summary

Methods inherited from class org.codehaus.mojo.aspectj.AbstractAjcMojo

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

Methods inherited from class java.lang.Object

Field Detail

XAJRUNTIMETARGET_SUPPORTED_VALUES

aspectDirectory

testAspectDirectory

includes

excludes

ajdtBuildDefFile

outxml

outxmlfile

emacssym

proc

Xset

crossrefs

Xlint

Xlintfile

XhasMember

target

source

complianceLevel

deprecation

noImportError

proceedOnError

preserveAllLocals

referenceInfo

encoding

verbose

showWeaveInfo

repeat

Xreweavable

XnotReweavable

XnoInline

XserializableAspects

XaddSerialVersionUID

XterminateAfterCompilation

Xajruntimetarget

Xjoinpoints

bootclasspath

warn

argumentFileName

forceAjcCompile

ajcOptions

resolvedIncludes

Constructor Detail

AbstractAjcCompiler

Method Detail

getClasspathDirectories

getOutputDirectory

getSourceDirectories

getJavaSources

getAdditionalAspectPaths

execute

assembleArguments

getIncludedSources

isBuildNeeded

setComplianceLevel

setDeprecation

setEmacssym

setCrossrefs

setEncoding

setNoImportError

setOutxml

setOutxmlfile

setPreserveAllLocals

setProceedOnError

setReferenceInfo

setRepeat

setShowWeaveInfo

setTarget

setSource

setVerbose

setXhasMember