echo.EchoMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of echo-maven-plugin Show documentation
A maven plugin that outputs text during Maven build
There is a newer version: 1.0.0
package echo;

import echo.exception.ExceptionHandler;
import echo.exception.FailureException;
import echo.output.MavenEchoOutput;
import echo.output.MavenLogger;
import echo.parameter.PluginParameters;
import echo.parameter.PluginParametersBuilder;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;

import java.io.File;

/**
 * Mojo (Maven plugin) that outputs messages during Maven build.
 *
 * @author Bjorn Ekryd
 */
@Mojo(
        name = "echo",
        threadSafe = true,
        defaultPhase = LifecyclePhase.INITIALIZE,
        requiresProject = false,
        inheritByDefault = false)
@SuppressWarnings({"UnusedDeclaration"})
class EchoMojo extends AbstractMojo {
    /** The message text that should be echoed */
    @Parameter(property = "echo.message")
    private String message;

    /** If the message fetched from a file instead of message tag */
    @Parameter(property = "echo.fromFile")
    private String fromFile;

    /** The default output path for toFile. The toFile will be created relative to this path. READ-ONLY */
    @Parameter(defaultValue = "${basedir}", readonly = true)
    private File defaultOutputPath;

    /** If the message should be sent to a file instead of standard output */
    @Parameter(property = "echo.toFile")
    private String toFile;

    /** If the message should be appended to the toFile instead of opening a new file/overwrite an existing file */
    @Parameter(property = "echo.append", defaultValue = "false")
    private boolean append;

    /** Overwrite read-only destination files */
    @Parameter(property = "echo.force", defaultValue = "false")
    private boolean force;

    /** Which output level the message should have. The following values are available 'ERROR',  'WARNING', 'INFO', 'VERBOSE' and 'DEBUG' */
    @Parameter(property = "echo.level", defaultValue = "INFO")
    private String level;

    /** Encoding for the messages. */
    @Parameter(property = "echo.encoding", defaultValue = "UTF-8")
    private String encoding;

    /** Line separator messages. Can be either \n, \r or \r\n */
    @Parameter(property = "echo.lineSeparator", defaultValue = "${line.separator}")
    private String lineSeparator;


    /** Debug flag that outputs the message as a character list */
    @Parameter(property = "echo.characterOutput", defaultValue = "false")
    private boolean characterOutput;


    private EchoPlugin echoPlugin;
    private final MavenLogger mavenLogger = new MavenLogger(getLog());
    private final MavenEchoOutput echoOutput = new MavenEchoOutput(getLog());

    public EchoMojo() {
    }

    /**
     * Execute plugin.
     *
     * @throws org.apache.maven.plugin.MojoFailureException exception that will be handled by plugin framework
     * @see org.apache.maven.plugin.Mojo#execute()
     */
    @Override
    public void execute() throws MojoFailureException {
        setup();
        echo();
    }

    void setup() throws MojoFailureException {
        try {
            PluginParameters pluginParameters = new PluginParametersBuilder()
                    .setMessage(message, fromFile)
                    .setFile(defaultOutputPath, toFile, append, force)
                    .setLevel(level)
                    .setFormatting(encoding, lineSeparator)
                    .setDebug(characterOutput)
                    .createPluginParameters();

            echoPlugin = new EchoPlugin(mavenLogger, pluginParameters, echoOutput);
        } catch (FailureException fex) {
            new ExceptionHandler(fex).throwMojoFailureException();
        }
    }

    void echo() throws MojoFailureException {
        try {
            echoPlugin.echo();
        } catch (FailureException fex) {
            new ExceptionHandler(fex).throwMojoFailureException();
        }
    }

}