← All recipes
Open source

Change XML attribute

Recipe IDorg.openrewrite.xml.ChangeTagAttribute
Artifactorg.openrewrite:rewrite-xml

Alters XML attribute value on a specified element.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.xml.ChangeTagAttribute --recipe-option "elementName=property" --recipe-option "attributeName=name" --recipe-option "newValue=newfoo.bar.attribute.value.string"

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

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

Options

NameTypeDescription
elementNamerequiredStringThe name of the element whose attribute's value is to be changed. Interpreted as an XPath expression.
e.g. property
attributeNamerequiredStringThe name of the attribute whose value is to be changed.
e.g. name
newValuerequiredStringThe new value to be used for key specified by attributeName, Set to null if you want to remove the attribute.
e.g. newfoo.bar.attribute.value.string
oldValueStringOnly change the property value if it matches the configured oldValue.
e.g. foo.bar.attribute.value.string
regexBooleanDefault false. If true, oldValue will be interpreted as a Regular Expression, and capture group contents will be available in newValue.

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