org.nuiton.plugin.Plugin Maven / Gradle / Ivy

Go to download

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

Plugin d'aide pour les projets nuiton

The newest version!

/*
 * #%L
 * Maven helper plugin
 * 
 * $Id: Plugin.java 814 2011-05-10 22:07:16Z tchemit $
 * $HeadURL: http://svn.nuiton.org/svn/maven-helper-plugin/tags/maven-helper-plugin-1.3/src/main/java/org/nuiton/plugin/Plugin.java $
 * %%
 * Copyright (C) 2009 - 2010 Tony Chemit, CodeLutin
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */

package org.nuiton.plugin;

import org.apache.maven.plugin.Mojo;
import org.apache.maven.project.MavenProject;

/**
 * A common contract to be implements by our mojo and reports.
 * 
 * Just expose a {@link #isVerbose()} flag and the maven project {@link #getProject()}.
 *
 * @author tchemit 
 * @since 1.0.3
 */
public interface Plugin extends Mojo {

    /** An enumeration to qualify the init result of a plugin */
    enum InitState {

        /** when something is wrong and should throw an error */
        failed,

        /** when the plugin execution should be skipped */
        skip,

        /** when plugin can be executed */
        ok
    }

    /** An enumeration to qualify a maven module packaging */
    enum Packaging {

        pom,
        jar,
        plugin,
        war,
        ear
    }

    MavenProject getProject();

    void setProject(MavenProject project);

    boolean isVerbose();

    void setVerbose(boolean verbose);
}