Replace getDisplayName() and getDescription() methods with fields

Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.java.recipes.UseDisplayNameAndDescriptionFields?organizationId=QUxML01vZGVybmUvTW9kZXJuZSArIE9wZW5SZXdyaXRl

Co-authored-by: Moderne <[email protected]>

Author: timtebeek

src/main/java/org/openrewrite/java/logging/ArgumentArrayToVarargs.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.java.logging;
 
+import lombok.Getter;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Preconditions;
 import org.openrewrite.Recipe;
@@ -32,15 +33,11 @@ public class ArgumentArrayToVarargs extends Recipe {
     // Match logger methods that end with Object[] - but we'll verify if it's varargs later
     private static final MethodMatcher LOGGER_METHOD = new MethodMatcher("*..Log* *(.., Object[])");
 
-    @Override
-    public String getDisplayName() {
-        return "Unpack Logger method `new Object[] {...}` into varargs";
-    }
+    @Getter
+    final String displayName = "Unpack Logger method `new Object[] {...}` into varargs";
 
-    @Override
-    public String getDescription() {
-        return "For Logger methods that support varargs, convert any final explicit `Object[]` arguments into their unpacked values.";
-    }
+    @Getter
+    final String description = "For Logger methods that support varargs, convert any final explicit `Object[]` arguments into their unpacked values.";
 
     @Override
     public Duration getEstimatedEffortPerOccurrence() {

src/main/java/org/openrewrite/java/logging/ChangeLombokLogAnnotation.java

@@ -16,6 +16,7 @@
 package org.openrewrite.java.logging;
 
 import lombok.AllArgsConstructor;
+import lombok.Getter;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.Option;
 import org.openrewrite.Recipe;
@@ -29,15 +30,11 @@
 @AllArgsConstructor
 public class ChangeLombokLogAnnotation extends Recipe {
 
-    @Override
-    public String getDisplayName() {
-        return "Replace any Lombok log annotations with target logging framework annotation";
-    }
+    @Getter
+    final String displayName = "Replace any Lombok log annotations with target logging framework annotation";
 
-    @Override
-    public String getDescription() {
-        return "Replace Lombok annotations such as `@CommonsLog` and `@Log4j` with the target logging framework annotation, or `@Sl4fj` if not provided.";
-    }
+    @Getter
+    final String description = "Replace Lombok annotations such as `@CommonsLog` and `@Log4j` with the target logging framework annotation, or `@Sl4fj` if not provided.";
 
     @Option(displayName = "Logging framework",
             description = "The logging framework to use.",

src/main/java/org/openrewrite/java/logging/jboss/LoggerLevelArgumentToMethod.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.java.logging.jboss;
 
+import lombok.Getter;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Preconditions;
@@ -39,15 +40,11 @@ public class LoggerLevelArgumentToMethod extends Recipe {
     private static final MethodMatcher LOGF_MATCHER = new MethodMatcher("org.jboss.logging.Logger logf(*,*,..)", true);
     private static final MethodMatcher LOGV_MATCHER = new MethodMatcher("org.jboss.logging.Logger logv(*,*,..)", true);
 
-    @Override
-    public String getDisplayName() {
-        return "Replace JBoss Logging Level arguments with the corresponding eponymous level method calls";
-    }
+    @Getter
+    final String displayName = "Replace JBoss Logging Level arguments with the corresponding eponymous level method calls";
 
-    @Override
-    public String getDescription() {
-        return "Replace calls to `Logger.log(Level, ...)` with the corresponding eponymous level method calls. For example `Logger.log(Level.INFO, ...)` to `Logger.info(...)`.";
-    }
+    @Getter
+    final String description = "Replace calls to `Logger.log(Level, ...)` with the corresponding eponymous level method calls. For example `Logger.log(Level.INFO, ...)` to `Logger.info(...)`.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {

src/main/java/org/openrewrite/java/logging/log4j/PrependRandomName.java

@@ -16,6 +16,7 @@
 package org.openrewrite.java.logging.log4j;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import lombok.Getter;
 import org.kohsuke.randname.RandomNameGenerator;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Preconditions;
@@ -40,15 +41,11 @@ public PrependRandomName(int seed) {
         randomName = new RandomNameGenerator(seed);
     }
 
-    @Override
-    public String getDisplayName() {
-        return "Prepend a random name to each Log4J statement";
-    }
+    @Getter
+    final String displayName = "Prepend a random name to each Log4J statement";
 
-    @Override
-    public String getDescription() {
-        return "To make finding the callsite of a logging statement easier in code search.";
-    }
+    @Getter
+    final String description = "To make finding the callsite of a logging statement easier in code search.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {

src/main/java/org/openrewrite/java/logging/logback/Log4jAppenderToLogback.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.java.logging.logback;
 
+import lombok.Getter;
 import org.openrewrite.*;
 import org.openrewrite.internal.ListUtils;
 import org.openrewrite.java.*;
@@ -24,19 +25,15 @@
 import org.openrewrite.java.tree.TypeUtils;
 
 public class Log4jAppenderToLogback extends Recipe {
-    @Override
-    public String getDisplayName() {
-        return "Migrate Log4j 2.x Appender to logback-classic equivalents";
-    }
+    @Getter
+    final String displayName = "Migrate Log4j 2.x Appender to logback-classic equivalents";
 
-    @Override
-    public String getDescription() {
-        return "Migrates custom Log4j 2.x Appender components to `logback-classic`. This recipe operates on the following assumptions: " +
-               "1.) The contents of the `append()` method remains unchanged. " +
-               "2.) The `requiresLayout()` method is not used in logback and can be removed. " +
-               "3.) In logback, the `stop()` method is the equivalent of log4j's close() method. " +
-               "For more details, see this page from logback: [`Migration from log4j`](http://logback.qos.ch/manual/migrationFromLog4j.html).";
-    }
+    @Getter
+    final String description = "Migrates custom Log4j 2.x Appender components to `logback-classic`. This recipe operates on the following assumptions: " +
+            "1.) The contents of the `append()` method remains unchanged. " +
+            "2.) The `requiresLayout()` method is not used in logback and can be removed. " +
+            "3.) In logback, the `stop()` method is the equivalent of log4j's close() method. " +
+            "For more details, see this page from logback: [`Migration from log4j`](http://logback.qos.ch/manual/migrationFromLog4j.html).";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {

src/main/java/org/openrewrite/java/logging/logback/Log4jLayoutToLogback.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.java.logging.logback;
 
+import lombok.Getter;
 import org.openrewrite.*;
 import org.openrewrite.internal.ListUtils;
 import org.openrewrite.java.*;
@@ -28,22 +29,18 @@
 import static java.util.Objects.requireNonNull;
 
 public class Log4jLayoutToLogback extends Recipe {
-    @Override
-    public String getDisplayName() {
-        return "Migrate Log4j 2.x Layout to logback-classic equivalents";
-    }
-
-    @Override
-    public String getDescription() {
-        return "Migrates custom Log4j 2.x Layout components to `logback-classic`. This recipe operates on the following assumptions: " +
-               "1. A logback-classic layout must extend the `LayoutBase<ILoggingEvent>` class. " +
-               "2. log4j's `format()` is renamed to `doLayout()` in a logback-classic layout. " +
-               "3. LoggingEvent `getRenderedMessage()` is converted to LoggingEvent `getMessage()`. " +
-               "4. The log4j ignoresThrowable() method is not needed and has no equivalent in logback-classic. " +
-               "5. The activateOptions() method merits further discussion. In log4j, a layout will have its activateOptions() method invoked by log4j configurators, that is PropertyConfigurator or DOMConfigurator just after all the options of the layout have been set. Thus, the layout will have an opportunity to check that its options are coherent and if so, proceed to fully initialize itself. " +
-               "6. In logback-classic, layouts must implement the LifeCycle interface which includes a method called start(). The start() method is the equivalent of log4j's activateOptions() method. " +
-               "For more details, see this page from logback: [`Migration from log4j`](http://logback.qos.ch/manual/migrationFromLog4j.html).";
-    }
+    @Getter
+    final String displayName = "Migrate Log4j 2.x Layout to logback-classic equivalents";
+
+    @Getter
+    final String description = "Migrates custom Log4j 2.x Layout components to `logback-classic`. This recipe operates on the following assumptions: " +
+            "1. A logback-classic layout must extend the `LayoutBase<ILoggingEvent>` class. " +
+            "2. log4j's `format()` is renamed to `doLayout()` in a logback-classic layout. " +
+            "3. LoggingEvent `getRenderedMessage()` is converted to LoggingEvent `getMessage()`. " +
+            "4. The log4j ignoresThrowable() method is not needed and has no equivalent in logback-classic. " +
+            "5. The activateOptions() method merits further discussion. In log4j, a layout will have its activateOptions() method invoked by log4j configurators, that is PropertyConfigurator or DOMConfigurator just after all the options of the layout have been set. Thus, the layout will have an opportunity to check that its options are coherent and if so, proceed to fully initialize itself. " +
+            "6. In logback-classic, layouts must implement the LifeCycle interface which includes a method called start(). The start() method is the equivalent of log4j's activateOptions() method. " +
+            "For more details, see this page from logback: [`Migration from log4j`](http://logback.qos.ch/manual/migrationFromLog4j.html).";
 
     @Override
     public Duration getEstimatedEffortPerOccurrence() {

src/main/java/org/openrewrite/java/logging/slf4j/CompleteExceptionLogging.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.java.logging.slf4j;
 
+import lombok.Getter;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Preconditions;
@@ -44,22 +45,18 @@ public class CompleteExceptionLogging extends Recipe {
     private static final MethodMatcher THROWABLE_GET_LOCALIZED_MESSAGE = new MethodMatcher("java.lang.Throwable getLocalizedMessage()");
 
 
-    @Override
-    public String getDisplayName() {
-        return "Enhances logging of exceptions by including the full stack trace in addition to the exception message";
-    }
+    @Getter
+    final String displayName = "Enhances logging of exceptions by including the full stack trace in addition to the exception message";
 
-    @Override
-    public String getDescription() {
-        return "It is a common mistake to call `Exception.getMessage()` when passing an exception into a log method. " +
-               "Not all exception types have useful messages, and even if the message is useful this omits the stack " +
-               "trace. Including a complete stack trace of the error along with the exception message in the log " +
-               "allows developers to better understand the context of the exception and identify the source of the " +
-               "error more quickly and accurately. \n" +
-               "If the method invocation includes any call to `Exception.getMessage()` or `Exception.getLocalizedMessage()` " +
-               "and not an exception is already passed as the last parameter to the log method, then we will append " +
-               "the exception as the last parameter in the log method.";
-    }
+    @Getter
+    final String description = "It is a common mistake to call `Exception.getMessage()` when passing an exception into a log method. " +
+            "Not all exception types have useful messages, and even if the message is useful this omits the stack " +
+            "trace. Including a complete stack trace of the error along with the exception message in the log " +
+            "allows developers to better understand the context of the exception and identify the source of the " +
+            "error more quickly and accurately. \n" +
+            "If the method invocation includes any call to `Exception.getMessage()` or `Exception.getLocalizedMessage()` " +
+            "and not an exception is already passed as the last parameter to the log method, then we will append " +
+            "the exception as the last parameter in the log method.";
 
     @Override
     public Set<String> getTags() {

src/main/java/org/openrewrite/java/logging/slf4j/JulParameterizedArguments.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.java.logging.slf4j;
 
+import lombok.Getter;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Preconditions;
@@ -44,15 +45,11 @@ public class JulParameterizedArguments extends Recipe {
     private static final MethodMatcher METHOD_MATCHER_PARAM = new MethodMatcher("java.util.logging.Logger log(java.util.logging.Level, java.lang.String, java.lang.Object)");
     private static final MethodMatcher METHOD_MATCHER_ARRAY = new MethodMatcher("java.util.logging.Logger log(java.util.logging.Level, java.lang.String, java.lang.Object[])");
 
-    @Override
-    public String getDisplayName() {
-        return "Replace parameterized JUL level call with corresponding SLF4J method calls";
-    }
+    @Getter
+    final String displayName = "Replace parameterized JUL level call with corresponding SLF4J method calls";
 
-    @Override
-    public String getDescription() {
-        return "Replace calls to parameterized `Logger.log(Level,String,…)` call with the corresponding slf4j method calls transforming the formatter and parameter lists.";
-    }
+    @Getter
+    final String description = "Replace calls to parameterized `Logger.log(Level,String,…)` call with the corresponding slf4j method calls transforming the formatter and parameter lists.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {

src/main/java/org/openrewrite/java/logging/slf4j/LoggersNamedForEnclosingClass.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.java.logging.slf4j;
 
+import lombok.Getter;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Preconditions;
 import org.openrewrite.Recipe;
@@ -39,15 +40,11 @@ public class LoggersNamedForEnclosingClass extends Recipe {
     private static final MethodMatcher LOGGERFACTORY_GETLOGGER = new MethodMatcher(
             "org.slf4j.LoggerFactory getLogger(Class)");
 
-    @Override
-    public String getDisplayName() {
-        return "Loggers should be named for their enclosing classes";
-    }
+    @Getter
+    final String displayName = "Loggers should be named for their enclosing classes";
 
-    @Override
-    public String getDescription() {
-        return "Ensure `LoggerFactory#getLogger(Class)` is called with the enclosing class as argument.";
-    }
+    @Getter
+    final String description = "Ensure `LoggerFactory#getLogger(Class)` is called with the enclosing class as argument.";
 
     @Override
     public Duration getEstimatedEffortPerOccurrence() {

src/main/java/org/openrewrite/java/logging/slf4j/MatchIsLogLevelEnabledWithLogStatements.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.java.logging.slf4j;
 
+import lombok.Getter;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Preconditions;
@@ -39,17 +40,13 @@ public class MatchIsLogLevelEnabledWithLogStatements extends Recipe {
     private static final MethodMatcher ENABLED_MATCHER = new MethodMatcher("org.slf4j.Logger is*Enabled()");
     private static final MethodMatcher LOG_MATCHER = new MethodMatcher("org.slf4j.Logger *(..)");
 
-    @Override
-    public String getDisplayName() {
-        return "Match `if (is*Enabled())` with logging statements";
-    }
+    @Getter
+    final String displayName = "Match `if (is*Enabled())` with logging statements";
 
-    @Override
-    public String getDescription() {
-        return "Change any `if (is*Enabled())` statements that do not match the maximum log level used in the `then` " +
-                "part to use the matching `is*Enabled()` method for that log level. " +
-                "This ensures that the logging condition is consistent with the actual logging statements.";
-    }
+    @Getter
+    final String description = "Change any `if (is*Enabled())` statements that do not match the maximum log level used in the `then` " +
+            "part to use the matching `is*Enabled()` method for that log level. " +
+            "This ensures that the logging condition is consistent with the actual logging statements.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {