Support nullable Throwables in the Logger (#726)

TechnicJelle · web-flow · commit 9f34af31510c · 2025-07-22T11:24:56.000+02:00
For if you just want to log an error message without a stacktrace
diff --git a/core/src/main/java/de/bluecolored/bluemap/core/logger/JavaLogger.java b/core/src/main/java/de/bluecolored/bluemap/core/logger/JavaLogger.java
@@ -24,6 +24,8 @@
  */
 package de.bluecolored.bluemap.core.logger;
 
+import org.jetbrains.annotations.Nullable;
+
 import java.util.logging.Handler;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -37,7 +39,7 @@ public JavaLogger(Logger out) {
     }
 
     @Override
-    public void logError(String message, Throwable throwable) {
+    public void logError(String message, @Nullable Throwable throwable) {
         out.log(Level.SEVERE, message, throwable);
     }
 
diff --git a/core/src/main/java/de/bluecolored/bluemap/core/logger/Logger.java b/core/src/main/java/de/bluecolored/bluemap/core/logger/Logger.java
@@ -24,6 +24,7 @@
  */
 package de.bluecolored.bluemap.core.logger;
 
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.io.IOException;
@@ -45,11 +46,11 @@ public abstract class Logger implements AutoCloseable {
         }));
     }
 
-    public void logError(Throwable throwable) {
+    public void logError(@NotNull Throwable throwable) {
         logError(throwable.getMessage(), throwable);
     }
 
-    public abstract void logError(String message, Throwable throwable);
+    public abstract void logError(String message, @Nullable Throwable throwable);
 
     public abstract void logWarning(String message);
 
@@ -60,7 +61,7 @@ public void logError(Throwable throwable) {
     /**
      * Only log the error if no message has been logged before with the same key.
      */
-    public abstract void noFloodError(String key, String message, Throwable throwable);
+    public abstract void noFloodError(String key, String message, @Nullable Throwable throwable);
 
     /**
      * Only log the warning if no message has been logged before with the same key.
@@ -80,14 +81,14 @@ public void logError(Throwable throwable) {
     /**
      * Only log the error if no message has been logged before with the same content.
      */
-    public void noFloodError(Throwable throwable){
+    public void noFloodError(@NotNull Throwable throwable){
         noFloodError(throwable.getMessage(), throwable);
     }
 
     /**
      * Only log the error if no message has been logged before with the same content.
      */
-    public void noFloodError(String message, Throwable throwable){
+    public void noFloodError(String message, @Nullable Throwable throwable){
         noFloodError(message, message, throwable);
     }
 
diff --git a/core/src/main/java/de/bluecolored/bluemap/core/logger/MultiLogger.java b/core/src/main/java/de/bluecolored/bluemap/core/logger/MultiLogger.java
@@ -24,6 +24,8 @@
  */
 package de.bluecolored.bluemap.core.logger;
 
+import org.jetbrains.annotations.Nullable;
+
 import java.util.HashMap;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -83,7 +85,7 @@ public void clear() {
     }
 
     @Override
-    public void logError(String message, Throwable throwable) {
+    public void logError(String message, @Nullable Throwable throwable) {
         lock.readLock().lock();
         try {
             for (Logger l : logger.values())
diff --git a/core/src/main/java/de/bluecolored/bluemap/core/logger/PrintStreamLogger.java b/core/src/main/java/de/bluecolored/bluemap/core/logger/PrintStreamLogger.java
@@ -24,6 +24,8 @@
  */
 package de.bluecolored.bluemap.core.logger;
 
+import org.jetbrains.annotations.Nullable;
+
 import java.io.PrintStream;
 import java.time.Instant;
 import java.time.ZoneId;
@@ -56,9 +58,9 @@ public void setDebug(boolean debug) {
     }
 
     @Override
-    public void logError(String message, Throwable throwable) {
+    public void logError(String message, @Nullable Throwable throwable) {
         log(err, "ERROR", message);
-        throwable.printStackTrace(err);
+        if (throwable != null) throwable.printStackTrace(err);
     }
 
     @Override
diff --git a/core/src/main/java/de/bluecolored/bluemap/core/logger/VoidLogger.java b/core/src/main/java/de/bluecolored/bluemap/core/logger/VoidLogger.java
@@ -24,10 +24,12 @@
  */
 package de.bluecolored.bluemap.core.logger;
 
+import org.jetbrains.annotations.Nullable;
+
 public class VoidLogger extends Logger {
 
     @Override
-    public void logError(String message, Throwable throwable) {}
+    public void logError(String message, @Nullable Throwable throwable) {}
 
     @Override
     public void logWarning(String message) {}
@@ -39,7 +41,7 @@ public void logInfo(String message) {}
     public void logDebug(String message) {}
 
     @Override
-    public void noFloodError(String key, String message, Throwable throwable) {}
+    public void noFloodError(String key, String message, @Nullable Throwable throwable) {}
 
     @Override
     public void noFloodWarning(String key, String message) {}
diff --git a/implementations/fabric/src/main/java/de/bluecolored/bluemap/fabric/Log4jLogger.java b/implementations/fabric/src/main/java/de/bluecolored/bluemap/fabric/Log4jLogger.java
@@ -27,6 +27,7 @@
 import org.apache.logging.log4j.Logger;
 
 import de.bluecolored.bluemap.core.logger.AbstractLogger;
+import org.jetbrains.annotations.Nullable;
 
 public class Log4jLogger extends AbstractLogger {
 
@@ -37,7 +38,7 @@ public Log4jLogger(Logger out) {
     }
 
     @Override
-    public void logError(String message, Throwable throwable) {
+    public void logError(String message, @Nullable Throwable throwable) {
         out.error(message, throwable);
     }
 
diff --git a/implementations/forge/src/main/java/de/bluecolored/bluemap/forge/Log4jLogger.java b/implementations/forge/src/main/java/de/bluecolored/bluemap/forge/Log4jLogger.java
@@ -27,6 +27,7 @@
 import org.apache.logging.log4j.Logger;
 
 import de.bluecolored.bluemap.core.logger.AbstractLogger;
+import org.jetbrains.annotations.Nullable;
 
 public class Log4jLogger extends AbstractLogger {
 
@@ -37,7 +38,7 @@ public Log4jLogger(Logger out) {
     }
 
     @Override
-    public void logError(String message, Throwable throwable) {
+    public void logError(String message, @Nullable Throwable throwable) {
         out.error(message, throwable);
     }
 
diff --git a/implementations/neoforge/src/main/java/de/bluecolored/bluemap/forge/Log4jLogger.java b/implementations/neoforge/src/main/java/de/bluecolored/bluemap/forge/Log4jLogger.java
@@ -26,6 +26,7 @@
 
 import de.bluecolored.bluemap.core.logger.AbstractLogger;
 import org.apache.logging.log4j.Logger;
+import org.jetbrains.annotations.Nullable;
 
 public class Log4jLogger extends AbstractLogger {
 
@@ -36,7 +37,7 @@ public Log4jLogger(Logger out) {
     }
 
     @Override
-    public void logError(String message, Throwable throwable) {
+    public void logError(String message, @Nullable Throwable throwable) {
         out.error(message, throwable);
     }
 
diff --git a/implementations/sponge/build.gradle.kts b/implementations/sponge/build.gradle.kts
@@ -19,6 +19,8 @@ dependencies {
     }
 
     api ( libs.bstats.sponge )
+
+    compileOnly ( libs.jetbrains.annotations )
 }
 
 sponge {
diff --git a/implementations/sponge/src/main/java/de/bluecolored/bluemap/sponge/Log4J2Logger.java b/implementations/sponge/src/main/java/de/bluecolored/bluemap/sponge/Log4J2Logger.java
@@ -26,6 +26,7 @@
 
 import de.bluecolored.bluemap.core.logger.AbstractLogger;
 import org.apache.logging.log4j.Logger;
+import org.jetbrains.annotations.Nullable;
 
 public class Log4J2Logger extends AbstractLogger {
 
@@ -36,7 +37,7 @@ public Log4J2Logger(Logger out) {
     }
 
     @Override
-    public void logError(String message, Throwable throwable) {
+    public void logError(String message, @Nullable Throwable throwable) {
         out.error(message, throwable);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,8 @@`
`24`	`24`	`*/`
`25`	`25`	`package de.bluecolored.bluemap.core.logger;`
`26`	`26`
	`27`	`+import org.jetbrains.annotations.Nullable;`
	`28`	`+`
`27`	`29`	`import java.util.logging.Handler;`
`28`	`30`	`import java.util.logging.Level;`
`29`	`31`	`import java.util.logging.Logger;`
`@@ -37,7 +39,7 @@ public JavaLogger(Logger out) {`
`37`	`39`	`}`
`38`	`40`
`39`	`41`	`@Override`
`40`		`- public void logError(String message, Throwable throwable) {`
	`42`	`+ public void logError(String message, @Nullable Throwable throwable) {`
`41`	`43`	`out.log(Level.SEVERE, message, throwable);`
`42`	`44`	`}`
`43`	`45`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@`
`27`	`27`	`import org.apache.logging.log4j.Logger;`
`28`	`28`
`29`	`29`	`import de.bluecolored.bluemap.core.logger.AbstractLogger;`
	`30`	`+import org.jetbrains.annotations.Nullable;`
`30`	`31`
`31`	`32`	`public class Log4jLogger extends AbstractLogger {`
`32`	`33`
`@@ -37,7 +38,7 @@ public Log4jLogger(Logger out) {`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`@Override`
`40`		`- public void logError(String message, Throwable throwable) {`
	`41`	`+ public void logError(String message, @Nullable Throwable throwable) {`
`41`	`42`	`out.error(message, throwable);`
`42`	`43`	`}`
`43`	`44`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@`
`26`	`26`
`27`	`27`	`import de.bluecolored.bluemap.core.logger.AbstractLogger;`
`28`	`28`	`import org.apache.logging.log4j.Logger;`
	`29`	`+import org.jetbrains.annotations.Nullable;`
`29`	`30`
`30`	`31`	`public class Log4jLogger extends AbstractLogger {`
`31`	`32`
`@@ -36,7 +37,7 @@ public Log4jLogger(Logger out) {`
`36`	`37`	`}`
`37`	`38`
`38`	`39`	`@Override`
`39`		`- public void logError(String message, Throwable throwable) {`
	`40`	`+ public void logError(String message, @Nullable Throwable throwable) {`
`40`	`41`	`out.error(message, throwable);`
`41`	`42`	`}`
`42`	`43`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@ dependencies {`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`api ( libs.bstats.sponge )`
	`22`	`+`
	`23`	`+ compileOnly ( libs.jetbrains.annotations )`
`22`	`24`	`}`
`23`	`25`
`24`	`26`	`sponge {`