← All recipes
Open source

Change XML tag value

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

Alters the value of XML tags matching the provided expression. When regex is enabled the replacement happens only for text nodes provided the pattern matches.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.xml.ChangeTagValue --recipe-option "elementName=/settings/servers/server/username" --recipe-option "newValue=user"

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 value is to be changed. Interpreted as an XPath Expression.
e.g. /settings/servers/server/username
oldValueStringThe old value of the tag. Interpreted as pattern if regex is enabled.
e.g. user
newValuerequiredStringThe new value for the tag. Supports capture groups when regex is enabled. If literal $,\ characters are needed in newValue, with regex true, then it should be escaped.
e.g. user
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