org.codehaus.mojo.aspectj.AbstractAjcMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aspectj-maven-plugin Show documentation

Handles AspectJ usage within Maven. Functionality provided is: weaving of aspects (or existing aspects from libraries) with the test and/or main classes, weaving of pre-existing jars and ajdoc reporting.

There is a newer version: 1.15.0

Show newest version

package org.codehaus.mojo.aspectj;

/**
 * The MIT License
 *
 * Copyright 2005-2006 The Codehaus.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;

import java.io.File;

/**
 * The base class.
 *
 * @author Juraj Burian
 * @version $Revision$ by $Author$
 */
public abstract class AbstractAjcMojo extends AbstractMojo
{

    /**
     * The maven project.
     *
     */
    @Parameter( required = true, readonly = true, defaultValue = "${project}" )
    protected MavenProject project;

    /**
     * The basedir of the project.
     *
     */
    @Parameter( required = true, readonly = true, defaultValue = "${basedir}" )
    protected File basedir;

    /**
     * List of of modules to weave (into target directory). Corresponds to ajc
     * -inpath option (or -injars for pre-1.2 (which is not supported)).
     *
     */
    @Parameter
    protected Module[] weaveDependencies;

    /**
     * List of of directories with .class files to weave (into target directory).
     * Corresponds to ajc -inpath option.
     *
     * @since 1.4
     */
    @Parameter
    protected String[] weaveDirectories;

    /**
     * Weave binary aspects from the jars.
     * The aspects should have been output by the same version of the compiler.
     * The modules must also be dependencies of the project.
     * Corresponds to ajc -aspectpath option
     *
     */
    @Parameter
    protected Module[] aspectLibraries;

    /**
     * Parameter which indicates an XML file containing AspectJ weaving instructions.
     * Assigning this plugin parameter adds the -xmlConfigured option to ajc.
     *
     * @see http://www.eclipse.org/aspectj/doc/next/devguide/ajc-ref.html
     */
    @Parameter
    protected File xmlConfigured;

    /**
     * Skip plugin execution.
     *
     */
    @Parameter( defaultValue = "false", property = "aspectj.skip" )
    private boolean skip;

    /**
     * @return true if execution should be skipped, otherwise false
     */
    protected final boolean isSkip()
    {
        return skip;
    }

    /**
     * Parameter which indicates an XML file containing AspectJ weaving instructions.
     * Assigning this plugin parameter adds the -xmlConfigured option to ajc.
     *
     * @param xmlConfigured an XML file containing AspectJ weaving instructions.
     */
    public void setXmlConfigured( final File xmlConfigured )
    {
        try
        {
            final String path = xmlConfigured.getCanonicalPath();
            if ( !xmlConfigured.exists() )
            {
                getLog().warn( "xmlConfigured parameter invalid. [" + path + "] does not exist." );
            }
            else if ( !path.trim().toLowerCase().endsWith( ".xml" ) )
            {
                getLog().warn( "xmlConfigured parameter invalid. XML file name must end in .xml" );
            }
            else
            {
                this.xmlConfigured = xmlConfigured;
            }
        }
        catch ( Exception e )
        {
            getLog().error( "Exception setting xmlConfigured option", e );
        }
    }
}