[MENFORCER-488] Add EnforcerLogger.is<Level>Enabled() (#279)

apache · Jul 6, 2023 · 22ff3c7 · 22ff3c7
1 parent 8c92bda
commit 22ff3c7
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 6 deletions.
diff --git a/enforcer-api/pom.xml b/enforcer-api/pom.xml
@@ -24,7 +24,7 @@
   <parent>
     <groupId>org.apache.maven.enforcer</groupId>
     <artifactId>enforcer</artifactId>
-    <version>3.3.1-SNAPSHOT</version>
+    <version>3.4.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>enforcer-api</artifactId>

diff --git a/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerLogger.java b/enforcer-api/src/main/java/org/apache/maven/enforcer/rule/api/EnforcerLogger.java
@@ -44,6 +44,14 @@ public interface EnforcerLogger {
      */
     void warnOrError(Supplier<CharSequence> messageSupplier);
 
+    /**
+     * Is the logger instance enabled for the DEBUG level?
+     *
+     * @return {@code true} if this Logger is enabled for the DEBUG level, {@code false} otherwise.
+     * @since 3.4.0
+     */
+    boolean isDebugEnabled();
+
     /**
      * Log message in {@code debug} level.
      *
@@ -60,6 +68,14 @@ public interface EnforcerLogger {
      */
     void debug(Supplier<CharSequence> messageSupplier);
 
+    /**
+     * Is the logger instance enabled for the INFO level?
+     *
+     * @return {@code true} if this Logger is enabled for the INFO level, {@code false} otherwise.
+     * @since 3.4.0
+     */
+    boolean isInfoEnabled();
+
     /**
      * Log message in {@code info} level.
      *
@@ -76,6 +92,14 @@ public interface EnforcerLogger {
      */
     void info(Supplier<CharSequence> messageSupplier);
 
+    /**
+     * Is the logger instance enabled for the WARN level?
+     *
+     * @return {@code true} if this Logger is enabled for the WARN level, {@code false} otherwise.
+     * @since 3.4.0
+     */
+    boolean isWarnEnabled();
+
     /**
      * Log message in {@code warn} level.
      *
@@ -92,6 +116,14 @@ public interface EnforcerLogger {
      */
     void warn(Supplier<CharSequence> messageSupplier);
 
+    /**
+     * Is the logger instance enabled for the ERROR level?
+     *
+     * @return {@code true} if this Logger is enabled for the ERROR level, {@code false} otherwise.
+     * @since 3.4.0
+     */
+    boolean isErrorEnabled();
+
     /**
      * Log message in {@code error} level.
      *

diff --git a/enforcer-rules/pom.xml b/enforcer-rules/pom.xml
@@ -24,7 +24,7 @@
   <parent>
     <groupId>org.apache.maven.enforcer</groupId>
     <artifactId>enforcer</artifactId>
-    <version>3.3.1-SNAPSHOT</version>
+    <version>3.4.0-SNAPSHOT</version>
   </parent>
 
   <artifactId>enforcer-rules</artifactId>

diff --git a/maven-enforcer-extension/pom.xml b/maven-enforcer-extension/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.maven.enforcer</groupId>
     <artifactId>enforcer</artifactId>
-    <version>3.3.1-SNAPSHOT</version>
+    <version>3.4.0-SNAPSHOT</version>
   </parent>
   <groupId>org.apache.maven.extensions</groupId>
   <artifactId>maven-enforcer-extension</artifactId>

diff --git a/maven-enforcer-plugin/pom.xml b/maven-enforcer-plugin/pom.xml
@@ -24,7 +24,7 @@
   <parent>
     <groupId>org.apache.maven.enforcer</groupId>
     <artifactId>enforcer</artifactId>
-    <version>3.3.1-SNAPSHOT</version>
+    <version>3.4.0-SNAPSHOT</version>
   </parent>
 
   <groupId>org.apache.maven.plugins</groupId>

diff --git a/...ugin/src/main/java/org/apache/maven/plugins/enforcer/internal/AbstractEnforcerLogger.java b/...ugin/src/main/java/org/apache/maven/plugins/enforcer/internal/AbstractEnforcerLogger.java
@@ -38,6 +38,11 @@ protected AbstractEnforcerLogger(Log log) {
         this.log = Objects.requireNonNull(log, "log must be not null");
     }
 
+    @Override
+    public boolean isDebugEnabled() {
+        return log.isDebugEnabled();
+    }
+
     @Override
     public void debug(CharSequence message) {
         log.debug(message);
@@ -50,6 +55,11 @@ public void debug(Supplier<CharSequence> messageSupplier) {
         }
     }
 
+    @Override
+    public boolean isInfoEnabled() {
+        return log.isInfoEnabled();
+    }
+
     @Override
     public void info(CharSequence message) {
         log.info(message);
@@ -62,6 +72,11 @@ public void info(Supplier<CharSequence> messageSupplier) {
         }
     }
 
+    @Override
+    public boolean isWarnEnabled() {
+        return log.isWarnEnabled();
+    }
+
     @Override
     public void warn(CharSequence message) {
         log.warn(message);
@@ -74,6 +89,11 @@ public void warn(Supplier<CharSequence> messageSupplier) {
         }
     }
 
+    @Override
+    public boolean isErrorEnabled() {
+        return log.isErrorEnabled();
+    }
+
     @Override
     public void error(CharSequence message) {
         log.error(message);

diff --git a/pom.xml b/pom.xml
@@ -28,7 +28,7 @@
   </parent>
   <groupId>org.apache.maven.enforcer</groupId>
   <artifactId>enforcer</artifactId>
-  <version>3.3.1-SNAPSHOT</version>
+  <version>3.4.0-SNAPSHOT</version>
   <packaging>pom</packaging>
 
   <name>Apache Maven Enforcer</name>
@@ -81,7 +81,7 @@
     <maven.site.path>enforcer-archives/enforcer-LATEST</maven.site.path>
     <javaVersion>8</javaVersion>
     <mockito.version>4.11.0</mockito.version>
-    <project.build.outputTimestamp>2023-04-01T21:03:41Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2023-07-04T18:27:24Z</project.build.outputTimestamp>
     <!-- the same as Maven 3.2.5 -->
     <aether.version>1.0.0.v20140518</aether.version>