Skip to main content

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.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringannotationTypeThe fully qualified name of the annotation.org.junit.Test
StringattributeNameOptional. The name of attribute to change. If omitted defaults to 'value'.timeout
StringattributeValueOptional. The value to set the attribute to. Set to null to remove the attribute.500
StringoldAttributeValueOptional. The current value of the attribute, this can be used to filter where the change is applied. Set to null for wildcard behavior.400
BooleanaddOnlyOptional. When set to true will not change existing annotation attribute values.
BooleanappendArrayOptional. If the attribute is an array, setting this option to true will append the value(s). In conjunction with addOnly, it is possible to control duplicates: addOnly=true, always append. addOnly=false, only append if the value is not already present.

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.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
      oldAttributeValue: 400

Now that com.yourorg.AddOrUpdateAnnotationAttributeExample 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.AddOrUpdateAnnotationAttributeExample")
    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, Niels de Bruin, Marcel Reiter, Filipe Roque, SiBorea, Jonathan Schnéider, Kun Li, Knut Wannheden, Tim te Beek, Daniel Shamis