Add or update annotation attribute

org.openrewrite.java.AddOrUpdateAnnotationAttribute
Some annotations accept arguments. This recipe sets an existing argument to the specified value, or adds the argument if it is not already set.
Source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-java
version: 8.6.0
Options
Type
Name
Description
String
annotationType
The fully qualified name of the annotation.
String
attributeName
Optional. The name of attribute to change. If omitted defaults to 'value'.
String
attributeValue
The value to set the attribute to. Set to null to remove the attribute.
Boolean
addOnly
When set to true will not change existing annotation attribute values.
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.AddOrUpdateAnnotationAttributeExample. 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.AddOrUpdateAnnotationAttributeExample
displayName: Add or update annotation attribute example
recipeList:
  - org.openrewrite.java.AddOrUpdateAnnotationAttribute:
      annotationType: org.junit.Test
      attributeName: timeout
      attributeValue: 500
      addOnly: null
Now that com.yourorg.AddOrUpdateAnnotationAttributeExample has been defined activate it in your build file:
Gradle
Maven
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.3.11")
}
​
rewrite {
    activeRecipe("com.yourorg.AddOrUpdateAnnotationAttributeExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
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.5.2</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AddOrUpdateAnnotationAttributeExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
Contributors
​Sam Snyder​
​Jonathan Schnéider​
​Kun Li​
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.

Type	Name	Description
`String`	annotationType	The fully qualified name of the annotation.
`String`	attributeName	Optional. The name of attribute to change. If omitted defaults to 'value'.
`String`	attributeValue	The value to set the attribute to. Set to `null` to remove the attribute.
`Boolean`	addOnly	When set to `true` will not change existing annotation attribute values.

Add license header

Change method access level

Last modified 5d ago