PluginLogger.java

package hudson.plugins.analysis.util;

import java.io.PrintStream;

import org.apache.commons.lang.StringUtils;

/**
 * A simple logger that prefixes each message with the plug-in name.
 *
 * @author Ulli Hafner
 */
public class PluginLogger {
    /** The plug-in name. */
    private final String pluginName;
    /** The actual print stream to log to. */
    private PrintStream logger;

    /**
     * Creates a new instance of {@link PluginLogger}.
     *
     * @param logger
     *            the actual print stream to log to
     * @param pluginName
     *            the plug-in name
     */
    public PluginLogger(final PrintStream logger, final String pluginName) {
        this.logger = logger;
        this.pluginName = pluginName;
    }

    /**
     * Creates a new instance of {@link PluginLogger}. Note that the logger
     * needs to be set afterwards to avoid throwing a {@link NullPointerException}.
     *
     * @param pluginName
     *            the plug-in name
     */
    // CHECKSTYLE:CONSTANTS-OFF
    protected PluginLogger(final String pluginName) {
        if (pluginName.contains("[")) {
            this.pluginName = pluginName;
        }
        else {
            this.pluginName = "[" + pluginName + "] ";
        }
    }
    // CHECKSTYLE:CONSTANTS-ON

    /**
     * Sets the logger to the specified value.
     *
     * @param logger the value to set
     */
    protected void setLogger(final PrintStream logger) {
        this.logger = logger;
    }

    /**
     * Logs the specified message.
     *
     * @param message the message
     */
    public void log(final String message) {
        logger.println(StringUtils.defaultString(pluginName) + message);
    }


    /**
     * Logs the specified throwable.
     *
     * @param throwable
     *            the throwable
     */
    public void log(final Throwable throwable) {
        logger.println(StringUtils.defaultString(pluginName) + throwable.getMessage());
    }

    /**
     * Logs the stack trace of the throwable.
     *
     * @param throwable the throwable
     */
    public void printStackTrace(final Throwable throwable) {
        throwable.printStackTrace(logger);
    }

    /**
     * Logs several lines that already contain a prefix.
     *
     * @param lines the lines to log
     */
    public void logLines(final String lines) {
        logger.print(lines);
    }
}