net.sf.sanity4j.util.QaLoggerMavenImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sanity4j Show documentation

Sanity4J was created to simplify running multiple static code analysis tools on the Java projects. It provides a single entry point to run all the selected tools and produce a consolidated report, which presents all findings in an easily accessible manner.

There is a newer version: 1.1.1

Show newest version

package net.sf.sanity4j.util; 

import net.sf.sanity4j.maven.plugin.RunQAMojo;

/**
 * This class acts as wrapper for a Maven QA Mojo, so that the bulk 
 * of the classes can avoid a direct dependence on Maven. 
 * 
 * @author Darian Bridge
 * @since Sanity4J 1.0
 */
public class QaLoggerMavenImpl extends QaLogger
{
    /** The current Maven QA mojo, whose project is used for the logging. */
    private final RunQAMojo qaMojo;

    /** 
     * Creates a QaLoggerMavenImpl. The constructor is hidden, as
     * instances must be obtained using getInstance.
     *
     * @param qaMojo the current Maven QA mojo
     */
    public QaLoggerMavenImpl(final RunQAMojo qaMojo)
    {
        this.qaMojo = qaMojo;
    }
    
    /**
     * Write a message to the log with the log level of DEBUG .
     * @param message The text to log. Should not be null.
     */
    public void debug(final String message)
    {
        qaMojo.getLog().debug(message);
    }
    
    /**
     * Write a message to the log with the log level of DEBUG .
     * @param message The text to log. Should not be null.
     * @param throwable the throwable, presumably caught in a catch block.
     */
    public void debug(final String message, final Throwable throwable)
    {
        //String messageWithStrackTrace = stackTraceToString(message, throwable);        
        qaMojo.getLog().debug(message, throwable);
    }

    /**
     * Write a message to the log with the log level of INFO .
     * @param message The text to log. Should not be null.
     */
    public void info(final String message)
    {
        qaMojo.getLog().info(message);
    }

    /**
     * Write a message to the log with the log level of WARN .
     * @param message The text to log. Should not be null.
     */
    public void warn(final String message)
    {
        qaMojo.getLog().warn(message);
    }
    
    /**
     * Write a message to the log with the log level of WARN .
     * @param message The text to log. Should not be null.
     * @param throwable the throwable, presumably caught in a catch block.
     */
    public void warn(final String message, final Throwable throwable)
    {
        //String messageWithStrackTrace = stackTraceToString(message, throwable);        
        qaMojo.getLog().warn(message, throwable);
    }

    /**
     * Write a message to the log with the log level of ERROR .
     * @param message The text to log. Should not be null.
     */
    public void error(final String message)
    {
        qaMojo.getLog().error(message);
    }
    
    /**
     * Write a message to the log with the log level of ERROR .
     * @param message The text to log. Should not be null.
     * @param throwable the throwable, presumably caught in a catch block.
     */
    public void error(final String message, final Throwable throwable)
    {
        //String messageWithStrackTrace = stackTraceToString(message, throwable);        
        qaMojo.getLog().error(message, throwable);
    }
}