]> source.dussan.org Git - poi.git/commitdiff
bug 59933: demote accessibility of POILogger implementations of log(int, Object)...
authorJaven O'Neal <onealj@apache.org>
Wed, 21 Sep 2016 02:45:39 +0000 (02:45 +0000)
committerJaven O'Neal <onealj@apache.org>
Wed, 21 Sep 2016 02:45:39 +0000 (02:45 +0000)
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1761665 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/poi/util/CommonsLogger.java
src/java/org/apache/poi/util/NullLogger.java
src/java/org/apache/poi/util/POILogger.java
src/java/org/apache/poi/util/SystemOutLogger.java
src/testcases/org/apache/poi/util/DummyPOILogger.java
src/testcases/org/apache/poi/util/TestPOILogger.java

index 1cbb9628ca4b2ae3cea805d7d876e00e8dc78464..bbb04af6d1960841350a8b50c4e26fdec61903ef 100644 (file)
@@ -30,7 +30,7 @@ import org.apache.commons.logging.LogFactory;
  */
 public class CommonsLogger extends POILogger
 {
-    private static LogFactory   _creator = LogFactory.getFactory();
+    private static final LogFactory   _creator = LogFactory.getFactory();
     private Log             log   = null;
 
     @Override
@@ -46,8 +46,10 @@ public class CommonsLogger extends POILogger
      * @param obj1 The object to log.
      */
     @Override
-    public void log(final int level, final Object obj1)
+    protected void log(final int level, final Object obj1)
     {
+        // FIXME: What happens if level is in between two levels (an even number)?
+        // Should this be `if (level >= FATAL) ...`?
         if(level==FATAL)
         {
           if(log.isFatalEnabled())
@@ -100,9 +102,11 @@ public class CommonsLogger extends POILogger
      * @param exception An exception to be logged
      */
     @Override
-    public void log(final int level, final Object obj1,
+    protected void log(final int level, final Object obj1,
                     final Throwable exception) 
     {
+        // FIXME: What happens if level is in between two levels (an even number)?
+        // Should this be `if (level >= FATAL) ...`?
         if(level==FATAL)
         {
           if(log.isFatalEnabled())
@@ -174,6 +178,8 @@ public class CommonsLogger extends POILogger
     @Override
     public boolean check(final int level)
     {
+        // FIXME: What happens if level is in between two levels (an even number)?
+        // Should this be `if (level >= FATAL) ...`?
         if(level==FATAL)
         {
           if(log.isFatalEnabled())
index 8a50cffba459aa950e19ae7a4b63579d79730a3f..e21adfaa7f46d91d6f92ecc47341e05016a44d6e 100644 (file)
@@ -38,7 +38,7 @@ public class NullLogger extends POILogger {
      */
 
     @Override
-    protected void log(final int level, final Object obj1) {
+    protected void _log(final int level, final Object obj1) {
         // do nothing
     }
 
@@ -50,7 +50,7 @@ public class NullLogger extends POILogger {
      * @param exception An exception to be logged
      */
     @Override
-    protected void log(int level, Object obj1, final Throwable exception) {
+    protected void _log(int level, Object obj1, final Throwable exception) {
         // do nothing
     }
 
index 9238de01cccd670cd8418d7281bb35b2b36fa1bb..c54c7542552e4951551720ebe6f335d466a7f71b 100644 (file)
@@ -54,7 +54,7 @@ public abstract class POILogger {
      * @param level One of DEBUG, INFO, WARN, ERROR, FATAL
      * @param obj1 The object to log.  This is converted to a string.
      */
-    abstract protected void log(int level, Object obj1);
+    abstract protected void _log(int level, Object obj1);
 
     /**
      * Log a message
@@ -63,7 +63,7 @@ public abstract class POILogger {
      * @param obj1 The object to log.  This is converted to a string.
      * @param exception An exception to be logged
      */
-    abstract protected void log(int level, Object obj1, final Throwable exception);
+    abstract protected void _log(int level, Object obj1, final Throwable exception);
 
 
     /**
@@ -107,9 +107,9 @@ public abstract class POILogger {
         // somehow this ambiguity works and doesn't lead to a loop,
         // but it's confusing ...
         if (lastEx == null) {
-            log(level, msg);
+            _log(level, msg);
         } else {
-            log(level, msg, lastEx);
+            _log(level, msg, lastEx);
         }
     }
 }
index 36d96ca038cc02883d6bb8a4fe729e99a7bb02bf..457f25410c9daa8a513f4e96ea1d9f73f3a83708 100644 (file)
@@ -42,9 +42,9 @@ public class SystemOutLogger extends POILogger
      * @param obj1 The object to log.
      */
     @Override
-    public void log(final int level, final Object obj1)
+    protected void _log(final int level, final Object obj1)
     {
-       log(level, obj1, null);
+       _log(level, obj1, null);
     }
 
     /**
@@ -56,7 +56,7 @@ public class SystemOutLogger extends POILogger
      */
     @Override
     @SuppressForbidden("uses printStackTrace")
-    public void log(final int level, final Object obj1,
+    protected void _log(final int level, final Object obj1,
                     final Throwable exception) {
         if (check(level)) {
             System.out.println("[" + _cat + "]" + LEVEL_STRINGS_SHORT[Math.min(LEVEL_STRINGS_SHORT.length-1, level)] + " " + obj1);
index c8566fe66301f76b7e1344bc2203fbe356601f1d..7da48ce269bf38466d2ea35f4936dada3e209465 100644 (file)
@@ -23,6 +23,7 @@ import java.util.List;
  * POILogger which logs into an ArrayList, so that 
  *  tests can see what got logged
  */
+@Internal
 public class DummyPOILogger extends POILogger {
        public List<String>logged = new ArrayList<String>(); 
 
@@ -39,12 +40,12 @@ public class DummyPOILogger extends POILogger {
        public void initialize(String cat) {}
 
     @Override
-       public void log(int level, Object obj1) {
+       protected void _log(int level, Object obj1) {
                logged.add(level + " - " + obj1);
        }
 
     @Override
-       public void log(int level, Object obj1, Throwable exception) {
+       protected void _log(int level, Object obj1, Throwable exception) {
                logged.add(level + " - " + obj1 + " - " + exception);
        }
 }
index 3914b764369398fa65d9b4b544f33fddec7d8057..6650ed9e6605aefbdc401b9b1440b4f7568dff6a 100644 (file)
@@ -65,13 +65,13 @@ public final class TestPOILogger extends POILogger {
     }
 
     @Override
-    public void log(int level, Object obj1) {
+    protected void _log(int level, Object obj1) {
         lastLog = (obj1 == null) ? "" : obj1.toString();
         lastEx = null;
     }
 
     @Override
-    public void log(int level, Object obj1, Throwable exception) {
+    protected void _log(int level, Object obj1, Throwable exception) {
         lastLog = (obj1 == null) ? "" : obj1.toString();
         lastEx = exception;
     }