org.codehaus.cargo.maven3.AbstractCommonMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cargo-maven3-plugin Show documentation

Cargo Maven 3 Plugin

The newest version!

/*
 * ========================================================================
 *
 * Codehaus Cargo, copyright 2004-2011 Vincent Massol, 2012-2024 Ali Tokmen.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * ========================================================================
 */
package org.codehaus.cargo.maven3;

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

/**
 * Common MOJO providing an accessor to the Maven Project object (this is the object containing all
 * information contained in the POM on which the MOJO is called).
 */
public abstract class AbstractCommonMojo extends AbstractMojo
{
    /**
     * The Maven project.
     * @see #getProject()
     */
    @Parameter(property = "project", readonly = true, required = true)
    private MavenProject project;

    /**
     * @return the Maven project object (this is the object containing all information contained in
     * the POM on which the MOJO is called).
     */
    public MavenProject getProject()
    {
        return this.project;
    }
}