From: Javen O'Neal <onealj@apache.org>
Date: Wed, 21 Sep 2016 02:12:54 +0000 (+0000)
Subject: bug 59933: demote accessibility of NullLogger methods to the same level as POILogger
X-Git-Tag: REL_3_16_BETA1~166
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c7cf4cbeb019e4d3cb211ca4b8a40caa3e10d3a7;p=poi.git

bug 59933: demote accessibility of NullLogger methods to the same level as POILogger

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1761662 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/src/java/org/apache/poi/util/NullLogger.java b/src/java/org/apache/poi/util/NullLogger.java
index d4fc574426..8a50cffba4 100644
--- a/src/java/org/apache/poi/util/NullLogger.java
+++ b/src/java/org/apache/poi/util/NullLogger.java
@@ -23,6 +23,7 @@ package org.apache.poi.util;
  * calls as cheap as possible by performing lazy evaluation of the log
  * message.<p>
  */
+@Internal
 public class NullLogger extends POILogger {
     @Override
     public void initialize(final String cat) {
@@ -37,7 +38,7 @@ public class NullLogger extends POILogger {
      */
 
     @Override
-    public void log(final int level, final Object obj1) {
+    protected void log(final int level, final Object obj1) {
         // do nothing
     }
 
@@ -49,7 +50,7 @@ public class NullLogger extends POILogger {
      * @param exception An exception to be logged
      */
     @Override
-    public void log(int level, Object obj1, final Throwable exception) {
+    protected void log(int level, Object obj1, final Throwable exception) {
         // do nothing
     }
 
diff --git a/src/java/org/apache/poi/util/POILogger.java b/src/java/org/apache/poi/util/POILogger.java
index 04198bfbab..9238de01cc 100644
--- a/src/java/org/apache/poi/util/POILogger.java
+++ b/src/java/org/apache/poi/util/POILogger.java
@@ -68,6 +68,15 @@ public abstract class POILogger {
 
     /**
      * Check if a logger is enabled to log at the specified level
+     * This allows code to avoid building strings or evaluating functions in
+     * the arguments to log.
+     * 
+     * An example:
+     * <code><pre>
+     * if (logger.check(POILogger.INFO)) {
+     *     logger.log(POILogger.INFO, "Avoid concatenating " + " strings and evaluating " + functions());
+     * }
+     * </pre></code>
      *
      * @param level One of DEBUG, INFO, WARN, ERROR, FATAL
      */