Replace getDisplayName() and getDescription() methods with fields

timtebeek · TeamModerne · app · commit ba0b31108a07 · 2026-01-13T10:58:37.000Z
Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.java.recipes.UseDisplayNameAndDescriptionFields?organizationId=QUxML01vZGVybmUvTW9kZXJuZSArIE9wZW5SZXdyaXRl Co-authored-by: Moderne <team@moderne.io>
diff --git a/src/main/java/org/openrewrite/gradle/spring/AddSpringDependencyManagementPlugin.java b/src/main/java/org/openrewrite/gradle/spring/AddSpringDependencyManagementPlugin.java
@@ -34,17 +34,11 @@
 @EqualsAndHashCode(callSuper = false)
 @Value
 public class AddSpringDependencyManagementPlugin extends Recipe {
-    @Override
-    public String getDisplayName() {
-        return "Add `io.spring.dependency-management` plugin, if in use";
-    }
+    String displayName = "Add `io.spring.dependency-management` plugin, if in use";
 
-    @Override
-    public String getDescription() {
-        return "Prior to Spring Boot 2.0 the dependency management plugin was applied automatically as part of the overall spring boot plugin. " +
+    String description = "Prior to Spring Boot 2.0 the dependency management plugin was applied automatically as part of the overall spring boot plugin. " +
                "Afterwards the dependency-management plugin must be applied explicitly, or Gradle's `platform()` feature may be used instead. " +
                "This recipe makes usage of io-spring.dependency-management explicit in anticipation of upgrade to Spring Boot 2.0 or later.";
-    }
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/AddSpringProperty.java b/src/main/java/org/openrewrite/java/spring/AddSpringProperty.java
@@ -68,15 +68,9 @@ public class AddSpringProperty extends Recipe {
     @Nullable
     List<String> pathExpressions;
 
-    @Override
-    public String getDisplayName() {
-        return "Add a spring configuration property";
-    }
+    String displayName = "Add a spring configuration property";
 
-    @Override
-    public String getDescription() {
-        return "Add a spring configuration property to a configuration file if it does not already exist in that file.";
-    }
+    String description = "Add a spring configuration property to a configuration file if it does not already exist in that file.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/ChangeMethodParameter.java b/src/main/java/org/openrewrite/java/spring/ChangeMethodParameter.java
@@ -68,15 +68,9 @@ public String getInstanceNameSuffix() {
         return String.format("`%s` in methods `%s`", parameterType, methodPattern);
     }
 
-    @Override
-    public String getDisplayName() {
-        return "Change parameter type for a method declaration";
-    }
+    String displayName = "Change parameter type for a method declaration";
 
-    @Override
-    public String getDescription() {
-        return "Change parameter type for a method declaration, identified by a method pattern.";
-    }
+    String description = "Change parameter type for a method declaration, identified by a method pattern.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/ChangeSpringPropertyKey.java b/src/main/java/org/openrewrite/java/spring/ChangeSpringPropertyKey.java
@@ -46,15 +46,9 @@
 @Value
 public class ChangeSpringPropertyKey extends Recipe {
 
-    @Override
-    public String getDisplayName() {
-        return "Change the key of a Spring application property";
-    }
+    String displayName = "Change the key of a Spring application property";
 
-    @Override
-    public String getDescription() {
-        return "Change Spring application property keys existing in either Properties or YAML files, and in `@Value`, `@ConditionalOnProperty` or `@SpringBootTest` annotations.";
-    }
+    String description = "Change Spring application property keys existing in either Properties or YAML files, and in `@Value`, `@ConditionalOnProperty` or `@SpringBootTest` annotations.";
 
     @Option(displayName = "Old property key",
             description = "The property key to rename.",
diff --git a/src/main/java/org/openrewrite/java/spring/ChangeSpringPropertyValue.java b/src/main/java/org/openrewrite/java/spring/ChangeSpringPropertyValue.java
@@ -29,15 +29,9 @@
 @Value
 public class ChangeSpringPropertyValue extends Recipe {
 
-    @Override
-    public String getDisplayName() {
-        return "Change the value of a spring application property";
-    }
+    String displayName = "Change the value of a spring application property";
 
-    @Override
-    public String getDescription() {
-        return "Change spring application property values existing in either Properties or Yaml files.";
-    }
+    String description = "Change spring application property values existing in either Properties or Yaml files.";
 
     @Option(displayName = "Property key",
             description = "The name of the property key whose value is to be changed.",
diff --git a/src/main/java/org/openrewrite/java/spring/CommentOutSpringPropertyKey.java b/src/main/java/org/openrewrite/java/spring/CommentOutSpringPropertyKey.java
@@ -27,15 +27,9 @@
 @Value
 public class CommentOutSpringPropertyKey extends Recipe {
 
-    @Override
-    public String getDisplayName() {
-        return "Comment out Spring properties";
-    }
+    String displayName = "Comment out Spring properties";
 
-    @Override
-    public String getDescription() {
-        return "Add comment to specified Spring properties, and comment out the property.";
-    }
+    String description = "Add comment to specified Spring properties, and comment out the property.";
 
     @Option(displayName = "Property key",
             description = "The name of the property key to comment out.",
diff --git a/src/main/java/org/openrewrite/java/spring/DeleteSpringProperty.java b/src/main/java/org/openrewrite/java/spring/DeleteSpringProperty.java
@@ -36,15 +36,9 @@ public class DeleteSpringProperty extends Recipe {
         example = "management.endpoint.configprops.*")
     String propertyKey;
 
-    @Override
-    public String getDisplayName() {
-        return "Delete a spring configuration property";
-    }
+    String displayName = "Delete a spring configuration property";
 
-    @Override
-    public String getDescription() {
-        return "Delete a spring configuration property from any configuration file that contains a matching key.";
-    }
+    String description = "Delete a spring configuration property from any configuration file that contains a matching key.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/ExpandProperties.java b/src/main/java/org/openrewrite/java/spring/ExpandProperties.java
@@ -43,15 +43,9 @@ public class ExpandProperties extends Recipe {
     @Nullable
     private String sourceFileMask;
 
-    @Override
-    public String getDisplayName() {
-        return "Expand Spring YAML properties";
-    }
+    String displayName = "Expand Spring YAML properties";
 
-    @Override
-    public String getDescription() {
-        return "Expand YAML properties to not use the dot syntax shortcut.";
-    }
+    String description = "Expand YAML properties to not use the dot syntax shortcut.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/RenameBean.java b/src/main/java/org/openrewrite/java/spring/RenameBean.java
@@ -69,15 +69,9 @@ public class RenameBean extends ScanningRecipe<List<TreeVisitor<?, ExecutionCont
         add(FQN_COMPONENT);
     }};
 
-    @Override
-    public String getDisplayName() {
-        return "Rename bean";
-    }
+    String displayName = "Rename bean";
 
-    @Override
-    public String getDescription() {
-        return "Renames a Spring bean, both declaration and references.";
-    }
+    String description = "Renames a Spring bean, both declaration and references.";
 
     @Override
     public List<TreeVisitor<?, ExecutionContext>> getInitialValue(ExecutionContext ctx) {
diff --git a/src/main/java/org/openrewrite/java/spring/SeparateApplicationPropertiesByProfile.java b/src/main/java/org/openrewrite/java/spring/SeparateApplicationPropertiesByProfile.java
@@ -39,15 +39,9 @@
 @EqualsAndHashCode(callSuper = false)
 public class SeparateApplicationPropertiesByProfile extends ScanningRecipe<SeparateApplicationPropertiesByProfile.Accumulator> {
 
-    @Override
-    public String getDisplayName() {
-        return "Separate `application.properties` by profile";
-    }
+    String displayName = "Separate `application.properties` by profile";
 
-    @Override
-    public String getDescription() {
-        return "Separating `application.properties` into separate files based on profiles.";
-    }
+    String description = "Separating `application.properties` into separate files based on profiles.";
 
     @Override
     public Accumulator getInitialValue(ExecutionContext ctx) {
diff --git a/src/main/java/org/openrewrite/java/spring/amqp/UseTlsAmqpConnectionString.java b/src/main/java/org/openrewrite/java/spring/amqp/UseTlsAmqpConnectionString.java
@@ -85,15 +85,9 @@ public class UseTlsAmqpConnectionString extends Recipe {
     @Nullable
     List<String> pathExpressions;
 
-    @Override
-    public String getDisplayName() {
-        return "Use TLS for AMQP connection strings";
-    }
+    String displayName = "Use TLS for AMQP connection strings";
 
-    @Override
-    public String getDescription() {
-        return "Use TLS for AMQP connection strings.";
-    }
+    String description = "Use TLS for AMQP connection strings.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/batch/ReplaceSupportClassWithItsInterface.java b/src/main/java/org/openrewrite/java/spring/batch/ReplaceSupportClassWithItsInterface.java
@@ -32,16 +32,10 @@
 @Value
 public class ReplaceSupportClassWithItsInterface extends Recipe {
 
-    @Override
-    public String getDisplayName() {
-        return "Transform classes that extend a given Class to implement the given Interface instead";
-    }
+    String displayName = "Transform classes that extend a given Class to implement the given Interface instead";
 
-    @Override
-    public String getDescription() {
-        return "As of spring-batch 5.x Listeners has default methods (made possible by a Java 8 baseline) and can be " +
+    String description = "As of spring-batch 5.x Listeners has default methods (made possible by a Java 8 baseline) and can be " +
                "implemented directly without the need for this adapter.";
-    }
 
     @Option(displayName = "Fully qualified class name",
             description = "A fully-qualified class name to be replaced.",
diff --git a/src/main/java/org/openrewrite/java/spring/boot2/MoveAutoConfigurationToImportsFile.java b/src/main/java/org/openrewrite/java/spring/boot2/MoveAutoConfigurationToImportsFile.java
@@ -51,17 +51,11 @@ public class MoveAutoConfigurationToImportsFile extends ScanningRecipe<MoveAutoC
     @Nullable
     Boolean preserveFactoriesFile;
 
-    @Override
-    public String getDisplayName() {
-        return "Use `AutoConfiguration#imports`";
-    }
+    String displayName = "Use `AutoConfiguration#imports`";
 
-    @Override
-    public String getDescription() {
-        return "Use `AutoConfiguration#imports` instead of the deprecated entry " +
+    String description = "Use `AutoConfiguration#imports` instead of the deprecated entry " +
                "`EnableAutoConfiguration` in `spring.factories` when defining " +
                "autoconfiguration classes.";
-    }
 
     @Override
     public Accumulator getInitialValue(ExecutionContext ctx) {
diff --git a/src/main/java/org/openrewrite/java/spring/boot3/ConfigurationOverEnableSecurity.java b/src/main/java/org/openrewrite/java/spring/boot3/ConfigurationOverEnableSecurity.java
@@ -50,17 +50,11 @@ public class ConfigurationOverEnableSecurity extends Recipe {
 
     private static final AnnotationMatcher SECURITY_ANNOTATION_MATCHER = new AnnotationMatcher(ENABLE_SECURITY_ANNOTATION_PATTERN, true);
 
-    @Override
-    public String getDisplayName() {
-        return "Add `@Configuration` to classes with `@EnableXXXSecurity` annotations";
-    }
+    String displayName = "Add `@Configuration` to classes with `@EnableXXXSecurity` annotations";
 
-    @Override
-    public String getDescription() {
-        return "Prior to Spring Security 6, `@EnableXXXSecurity` implicitly had `@Configuration`. " +
+    String description = "Prior to Spring Security 6, `@EnableXXXSecurity` implicitly had `@Configuration`. " +
                 "`Configuration` was removed from the definitions of the `@EnableSecurity` definitions in Spring Security 6. " +
                 "Consequently classes annotated with `@EnableXXXSecurity` coming from pre-Boot 3 should have `@Configuration` annotation added.";
-    }
 
     private JavaVisitor<ExecutionContext> precondition() {
         return new JavaVisitor<ExecutionContext>() {
diff --git a/src/main/java/org/openrewrite/java/spring/data/UseTlsJdbcConnectionString.java b/src/main/java/org/openrewrite/java/spring/data/UseTlsJdbcConnectionString.java
@@ -70,18 +70,12 @@ public class UseTlsJdbcConnectionString extends Recipe {
     @Nullable
     String attribute;
 
-    @Override
-    public String getDisplayName() {
-        return "Use TLS for JDBC connection strings";
-    }
+    String displayName = "Use TLS for JDBC connection strings";
 
-    @Override
-    public String getDescription() {
-        return "Increasingly, for compliance reasons (e.g. [NACHA](https://www.nacha.org/sites/default/files/2022-06/End_User_Briefing_Supplementing_Data_Security_UPDATED_FINAL.pdf)), JDBC connection strings " +
+    String description = "Increasingly, for compliance reasons (e.g. [NACHA](https://www.nacha.org/sites/default/files/2022-06/End_User_Briefing_Supplementing_Data_Security_UPDATED_FINAL.pdf)), JDBC connection strings " +
                 "should be TLS-enabled. This recipe will update the port and " +
                 "optionally add a connection attribute to indicate that the " +
                 "connection is TLS-enabled.";
-    }
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/search/FindApiCalls.java b/src/main/java/org/openrewrite/java/spring/search/FindApiCalls.java
@@ -33,16 +33,9 @@
 public class FindApiCalls extends Recipe {
     transient ApiCalls calls = new ApiCalls(this);
 
-    @Override
-    public String getDisplayName() {
-        return "Find HTTP API calls via `RestTemplate`";
-    }
+    String displayName = "Find HTTP API calls via `RestTemplate`";
 
-    @Override
-    public String getDescription() {
-        //language=markdown
-        return "Find outbound HTTP API calls made via Spring's `RestTemplate` class.";
-    }
+    String description = "Find outbound HTTP API calls made via Spring's `RestTemplate` class.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/search/FindApiEndpoints.java b/src/main/java/org/openrewrite/java/spring/search/FindApiEndpoints.java
@@ -35,18 +35,11 @@ public class FindApiEndpoints extends Recipe {
 
     transient ApiEndpoints apis = new ApiEndpoints(this);
 
-    @Override
-    public String getDisplayName() {
-        return "Find Spring API endpoints";
-    }
+    String displayName = "Find Spring API endpoints";
 
-    @Override
-    public String getDescription() {
-        //language=markdown
-        return "Find all HTTP API endpoints exposed by Spring applications. " +
+    String description = "Find all HTTP API endpoints exposed by Spring applications. " +
                 "More specifically, this marks method declarations annotated with `@RequestMapping`, `@GetMapping`, " +
                 "`@PostMapping`, `@PutMapping`, `@DeleteMapping`, and `@PatchMapping` as search results.";
-    }
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/search/FindConfigurationProperties.java b/src/main/java/org/openrewrite/java/spring/search/FindConfigurationProperties.java
@@ -37,17 +37,10 @@ public class FindConfigurationProperties extends Recipe {
 
     transient ConfigurationPropertiesTable configProperties = new ConfigurationPropertiesTable(this);
 
-    @Override
-    public String getDisplayName() {
-        return "Find Spring `@ConfigurationProperties`";
-    }
+    String displayName = "Find Spring `@ConfigurationProperties`";
 
-    @Override
-    public String getDescription() {
-        //language=markdown
-        return "Find all classes annotated with `@ConfigurationProperties` and extract their prefix values. " +
+    String description = "Find all classes annotated with `@ConfigurationProperties` and extract their prefix values. " +
                 "This is useful for discovering all externalized configuration properties in Spring Boot applications.";
-    }
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/security5/UpdateArgon2PasswordEncoder.java b/src/main/java/org/openrewrite/java/spring/security5/UpdateArgon2PasswordEncoder.java
@@ -56,16 +56,10 @@ public class UpdateArgon2PasswordEncoder extends Recipe {
     private static final Integer DEFAULT_V52_MEMORY = 4_096;
     private static final Integer DEFAULT_V52_ITERATIONS = 3;
 
-    @Override
-    public String getDisplayName() {
-        return "Use new `Argon2PasswordEncoder` factory methods";
-    }
+    String displayName = "Use new `Argon2PasswordEncoder` factory methods";
 
-    @Override
-    public String getDescription() {
-        return "In Spring Security 5.8 some `Argon2PasswordEncoder` constructors have been deprecated in favor of factory methods. " +
+    String description = "In Spring Security 5.8 some `Argon2PasswordEncoder` constructors have been deprecated in favor of factory methods. " +
                 "Refer to the [ Spring Security migration docs](https://docs.spring.io/spring-security/reference/5.8/migration/index.html#_update_argon2passwordencoder) for more information.";
-    }
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/security5/UpdatePbkdf2PasswordEncoder.java b/src/main/java/org/openrewrite/java/spring/security5/UpdatePbkdf2PasswordEncoder.java
@@ -65,16 +65,10 @@ public class UpdatePbkdf2PasswordEncoder extends Recipe {
         HASH_WIDTH_TO_ALGORITHM_MAP = unmodifiableMap(map);
     }
 
-    @Override
-    public String getDisplayName() {
-        return "Use new `Pbkdf2PasswordEncoder` factory methods";
-    }
+    String displayName = "Use new `Pbkdf2PasswordEncoder` factory methods";
 
-    @Override
-    public String getDescription() {
-        return "In Spring Security 5.8 some `Pbkdf2PasswordEncoder` constructors have been deprecated in favor of factory methods. " +
+    String description = "In Spring Security 5.8 some `Pbkdf2PasswordEncoder` constructors have been deprecated in favor of factory methods. " +
                 "Refer to the [ Spring Security migration docs](https://docs.spring.io/spring-security/reference/5.8/migration/index.html#_update_pbkdf2passwordencoder) for more information.";
-    }
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/security5/UpdateSCryptPasswordEncoder.java b/src/main/java/org/openrewrite/java/spring/security5/UpdateSCryptPasswordEncoder.java
@@ -56,16 +56,10 @@ public class UpdateSCryptPasswordEncoder extends Recipe {
     private static final Integer DEFAULT_V41_KEY_LENGTH = 32;
     private static final Integer DEFAULT_V41_SALT_LENGTH = 64;
 
-    @Override
-    public String getDisplayName() {
-        return "Use new `SCryptPasswordEncoder` factory methods";
-    }
+    String displayName = "Use new `SCryptPasswordEncoder` factory methods";
 
-    @Override
-    public String getDescription() {
-        return "In Spring Security 5.8 some `SCryptPasswordEncoder` constructors have been deprecated in favor of factory methods. " +
+    String description = "In Spring Security 5.8 some `SCryptPasswordEncoder` constructors have been deprecated in favor of factory methods. " +
                 "Refer to the [ Spring Security migration docs](https://docs.spring.io/spring-security/reference/5.8/migration/index.html#_update_scryptpasswordencoder) for more information.";
-    }
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
diff --git a/src/main/java/org/openrewrite/java/spring/security5/UseNewRequestMatchers.java b/src/main/java/org/openrewrite/java/spring/security5/UseNewRequestMatchers.java
diff --git a/src/main/java/org/openrewrite/java/spring/security5/UseNewSecurityMatchers.java b/src/main/java/org/openrewrite/java/spring/security5/UseNewSecurityMatchers.java
diff --git a/src/main/java/org/openrewrite/java/spring/security6/oauth2/client/OAuth2ClientLambdaDsl.java b/src/main/java/org/openrewrite/java/spring/security6/oauth2/client/OAuth2ClientLambdaDsl.java
diff --git a/src/main/java/org/openrewrite/java/spring/security6/oauth2/client/OAuth2LoginLambdaDsl.java b/src/main/java/org/openrewrite/java/spring/security6/oauth2/client/OAuth2LoginLambdaDsl.java
diff --git a/src/main/java/org/openrewrite/java/spring/security6/oauth2/server/resource/OAuth2ResourceServerLambdaDsl.java b/src/main/java/org/openrewrite/java/spring/security6/oauth2/server/resource/OAuth2ResourceServerLambdaDsl.java
diff --git a/src/main/java/org/openrewrite/maven/spring/UpgradeExplicitSpringBootDependencies.java b/src/main/java/org/openrewrite/maven/spring/UpgradeExplicitSpringBootDependencies.java
