← All recipes
Open source

Add or update annotation attribute

Recipe IDorg.openrewrite.java.AddOrUpdateAnnotationAttribute
Artifactorg.openrewrite:rewrite-java

Some annotations accept arguments. This recipe sets an existing argument to the specified value, or adds the argument if it is not already set.

Single recipeApache 2.0

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.AddOrUpdateAnnotationAttribute --recipe-option "annotationType=org.junit.Test"

If the recipe isn’t available locally, install it with:

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

Options

NameTypeDescription
annotationTyperequiredStringThe fully qualified name of the annotation.
e.g. org.junit.Test
attributeNameStringThe name of attribute to change. If omitted defaults to 'value'.
e.g. timeout
attributeValueStringThe value to set the attribute to. If the attribute is an array, provide values separated by comma to add multiple attributes at once. Set to null to remove the attribute.
e.g. 500
oldAttributeValueStringThe current value of the attribute, this can be used to filter where the change is applied. Set to null for wildcard behavior.
e.g. 400
addOnlyBooleanIf true, disables upgrading existing annotation attribute values, thus the recipe will only add the attribute if it does not already exist. If omitted or false, the recipe adds the attribute if missing or updates its value if present.
appendArrayBooleanIf the attribute is an array and attribute is present, setting this option to true will append the value(s). Duplicate values will not be added. If omitted or false, the recipe will replace the existing value(s) with the new value(s).

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats