Links

Replace constant with literal value

org.openrewrite.java.ReplaceConstant
Replace a named constant with a literal value when you wish to remove the old constant. A String literal must include escaped quotes.

Recipe source

  • groupId: org.openrewrite
  • artifactId: rewrite-java
  • version: 8.17.1

Options

Type
Name
Description
Example
String
owningType
The target type in which the constant to be replaced is defined.
com.google.common.base.Charsets
String
constantName
The name of the constant field to replace.
UTF_8
String
literalValue
The literal value to replace.
UTF_8

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.ReplaceConstantExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ReplaceConstantExample
displayName: Replace constant with literal value example
recipeList:
- org.openrewrite.java.ReplaceConstant:
owningType: com.google.common.base.Charsets
constantName: UTF_8
literalValue: UTF_8
Now that com.yourorg.ReplaceConstantExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.8.4")
}
rewrite {
activeRecipe("com.yourorg.ReplaceConstantExample")
}
repositories {
mavenCentral()
}
  1. 2.
    Run gradle rewriteRun to run the recipe.
  1. 1.
    Add the following to your pom.xml file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.23.1</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ReplaceConstantExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe ReplaceConstantExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Contributors