resources.report.rules.pmd.GuardDebugLogging.html 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.

The newest version!



GuardDebugLogging

GuardDebugLogging



        When log messages are composed by concatenating strings, the whole section should be guarded
        by a isDebugEnabled() check to avoid performance and memory issues.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.logging.GuardDebugLoggingRule
Example(s):


            
public class Test {
    private static final Log __log = LogFactory.getLog(Test.class);
    public void test() {
        // okay:
        __log.debug("log something");

        // okay:
        __log.debug("log something with exception", e);

        // bad:
        __log.debug("log something" + " and " + "concat strings");

        // bad:
        __log.debug("log something" + " and " + "concat strings", e);

        // good:
        if (__log.isDebugEnabled()) {
        __log.debug("bla" + "",e );
        }
    }
}