org.codehaus.gmavenplus.mojo.AbstractToolsMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gmavenplus-plugin Show documentation
Integrates Groovy into Maven projects.
There is a newer version: 4.1.1
/*
 * Copyright 2014 the original author or authors.
 *
 * 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.gmavenplus.mojo;

import java.util.Properties;


/**
 * The base tools mojo, which all tool mojos extend.
 *
 * @author Keegan Witt
 * @since 1.1
 */
public abstract class AbstractToolsMojo extends AbstractGroovyMojo {

    /**
     * Properties to make available in scripts.  By default it will include
     * 
     *   settings
     *     a org.apache.maven.settings.Settings object of the current Maven settings
     *   project
     *     a org.apache.maven.project.Project object of the current Maven project
     *   session
     *     a org.apache.maven.execution.MavenSession object of the current Maven session
     *   pluginArtifacts
     *     a list of org.apache.maven.artifact.Artifact objects of this plugin's artifacts
     *   localRepository
     *     a org.apache.maven.artifact.repository.ArtifactRepository object of Maven's local repository
     *   reactorProjects
     *     a list of org.apache.maven.project.MavenProject objects currently loaded by the reactor
     * 
     * These can be overridden.
     * @since 1.0-beta-3
     *
     * @parameter
     */
    protected Properties properties = new Properties();

    protected void initializeProperties() {
        if (settings != null && !properties.containsKey("settings")) {
            properties.put("settings", settings);
        }
        if (project != null && !properties.containsKey("project")) {
            properties.put("project", project);
        }
        if (session != null && !properties.containsKey("session")) {
            properties.put("session", session);
        }
        if (pluginArtifacts != null && !properties.containsKey("pluginArtifacts")) {
            properties.put("pluginArtifacts", pluginArtifacts);
        }
        if (localRepository != null && !properties.containsKey("localRepository")) {
            properties.put("localRepository", localRepository);
        }
        if (reactorProjects != null && !properties.containsKey("reactorProjects")) {
            properties.put("reactorProjects", reactorProjects);
        }
    }

}