Open source

Replace annotation

Recipe IDorg.openrewrite.java.ReplaceAnnotation

Artifactorg.openrewrite:rewrite-java

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

Single recipeJavaApache License Version 2.0

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

3 parameters

2 required1 optional

Parameter	Example	Type	Required
annotationPatternToReplace	@org.jetbrains.annotations.NotNull("Test")	String	Required
An annotation matcher, expressed as a method pattern to replace.
annotationTemplateToInsert	@org.jetbrains.annotations.NotNull("Null not permitted")	String	Required
An annotation template to add instead of original one, will be parsed with JavaTemplate.
classpathResourceName	annotations	String	Optional
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.

Examples

java

Parameter	Value
annotationPatternToReplace	@org.jetbrains.annotations.NotNull("Test")
annotationTemplateToInsert	@lombok.NonNull
classpathResourceName	null

java

Before

import org.jetbrains.annotations.NotNull;

class A {
    @NotNull("Test")
    String testMethod() {}
}

After

import lombok.NonNull;

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

Diff

@@ -1,1 +1,1 @@
-import org.jetbrains.annotations.NotNull;
+import lombok.NonNull;

@@ -4,1 +4,1 @@

class A {
-   @NotNull("Test")
+   @NonNull
    String testMethod() {}

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe ReplaceAnnotation --recipe-option "annotationPatternToReplace='@org.jetbrains.annotations.NotNull("Test")'" --recipe-option "annotationTemplateToInsert='@org.jetbrains.annotations.NotNull("Null not permitted")'" --recipe-option "classpathResourceName=annotations"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-java:8.85.6

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A 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 changes	In 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 changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.