Skip to main content

Replace annotation

org.openrewrite.java.ReplaceAnnotation

Replace an Annotation with another one if the annotation pattern matches. Only fixed parameters can be set in the replacement.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringannotationPatternToReplaceAn annotation matcher, expressed as a method pattern to replace.@org.jetbrains.annotations.NotNull("Test")
StringannotationTemplateToInsertAn annotation template to add instead of original one, will be parsed with JavaTemplate.@org.jetbrains.annotations.NotNull("Null not permitted")
StringclasspathResourceNameOptional. If the annotation's type is defined by a jar within the META-INF/rewrite/classpath directory provide its name here so that it can be loaded. When this parameter is not passed the runtime classpath of the recipe is provided to the parser producing the new annotation. This is necessary when the annotation is not on the runtime classpath of the recipe and isn't in the Java standard library.annotations

Example​

Parameters​
ParameterValue
annotationPatternToReplace@org.jetbrains.annotations.NotNull("Test")
annotationTemplateToInsert@lombok.NonNull
classpathResourceNamenull
Before​
import org.jetbrains.annotations.NotNull;

class A {
    @NotNull("Test")
    String testMethod() {}
}
After​
import lombok.NonNull;

class A {
    @NonNull
    String testMethod() {}
}

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.ReplaceAnnotationExample. 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.ReplaceAnnotationExample
displayName: Replace annotation example
recipeList:
  - org.openrewrite.java.ReplaceAnnotation:
      annotationPatternToReplace: '@org.jetbrains.annotations.NotNull("Test")'
      annotationTemplateToInsert: '@org.jetbrains.annotations.NotNull("Null not permitted")'
      classpathResourceName: annotations

Now that com.yourorg.ReplaceAnnotationExample has been defined, activate it in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.2")
}

rewrite {
    activeRecipe("com.yourorg.ReplaceAnnotationExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Merlin Bögershausen, Sam Snyder, Tim te Beek, Knut Wannheden, Jonathan Schnéider