Replace String literal

org.openrewrite.java.migrate.ReplaceStringLiteralValue

Replace the value of a complete String literal.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite.recipe

  • artifactId: rewrite-migrate-java

  • version: 2.12.0

Options

TypeNameDescriptionExample

String

oldLiteralValue

The String value to replace.

apple

String

newLiteralValue

The String value to replace with.

orange

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.ReplaceStringLiteralValueExample. 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.ReplaceStringLiteralValueExample
displayName: Replace `String` literal example
recipeList:
  - org.openrewrite.java.migrate.ReplaceStringLiteralValue:
      oldLiteralValue: apple
      newLiteralValue: orange

Now that com.yourorg.ReplaceStringLiteralValueExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-migrate-java:2.12.0 in your build file:

  1. Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.12.0")
}

rewrite {
    activeRecipe("com.yourorg.ReplaceStringLiteralValueExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.12.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories

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

Chuka Obinabo, Jonathan Schnéider, Tim te Beek

Last updated