Fork me on GitHub
Built by Maven

xml:transform

Full name:

org.codehaus.mojo:xml-maven-plugin:1.4.0:transform

Description:

The TransformMojo is used for transforming a set of files using a common stylesheet.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: generate-resources.

Optional Parameters

Name Type Since Description
<catalogHandling> AbstractXmlMojo$CatalogHandling 1.0.2 How to handle entities which cannot be found in any catalog. See Common Goal Properties.
Default: passThrough
User Property: xml.catalogHandling
<catalogs> String[] 1.0 An XML catalog file, or URL, which is being used to resolve entities. See Catalog files.
<enableSchemaCaching> boolean 1.4.0 Whether to keep the DTDs, schemas and other resources read from http, https and ftp URLs in memory, so each is downloaded once per execution and not once for every file that refers to it. The cache lives as long as the execution; resources that are not remote are never cached.
Default: false
User Property: xml.enableSchemaCaching
<forceCreation> boolean 1.0 Whether creating the transformed files should be forced.
Default: false
User Property: xml.forceCreation
<jaxpConfigFile> File - Path to a JAXP Configuration (jaxp.properties) File. See Configuration File.
User Property: xml.jaxpConfigFile
<skip> boolean 1.0.1 Whether to skip execution.
Default: false
User Property: xml.skip
<skipIfMissingBaseDirectory> boolean 1.4.0 Whether to skip a validation set or transformation set whose dir does not exist, instead of failing the build. A message is logged at info level for each set that is skipped. This allows a parent POM to configure the goals for the children that have such a directory.
Default: false
User Property: xml.skipIfMissingBaseDirectory
<transformationSets> TransformationSet[] 1.0 Specifies one or more sets of files, which are being transformed. See Transforming XML Files
<transformerFactory> String 1.0 Transformer factory use. By default, the systems default transformer factory is used. If you use this feature you must use at least jdk 1.6
User Property: xml.transformerFactory

Parameter Details

<catalogHandling>

How to handle entities which cannot be found in any catalog. See Common Goal Properties.
  • Type: org.codehaus.mojo.xml.AbstractXmlMojo$CatalogHandling
  • Since: 1.0.2
  • Required: No
  • User Property: xml.catalogHandling
  • Default: passThrough

<catalogs>

An XML catalog file, or URL, which is being used to resolve entities. See Catalog files.
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

<enableSchemaCaching>

Whether to keep the DTDs, schemas and other resources read from http, https and ftp URLs in memory, so each is downloaded once per execution and not once for every file that refers to it. The cache lives as long as the execution; resources that are not remote are never cached.
  • Type: boolean
  • Since: 1.4.0
  • Required: No
  • User Property: xml.enableSchemaCaching
  • Default: false

<forceCreation>

Whether creating the transformed files should be forced.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: xml.forceCreation
  • Default: false

<jaxpConfigFile>

Path to a JAXP Configuration (jaxp.properties) File. See Configuration File.
  • Type: java.io.File
  • Required: No
  • User Property: xml.jaxpConfigFile

<skip>

Whether to skip execution.
  • Type: boolean
  • Since: 1.0.1
  • Required: No
  • User Property: xml.skip
  • Default: false

<skipIfMissingBaseDirectory>

Whether to skip a validation set or transformation set whose dir does not exist, instead of failing the build. A message is logged at info level for each set that is skipped. This allows a parent POM to configure the goals for the children that have such a directory.
  • Type: boolean
  • Since: 1.4.0
  • Required: No
  • User Property: xml.skipIfMissingBaseDirectory
  • Default: false

<transformationSets>

Specifies one or more sets of files, which are being transformed. See Transforming XML Files
  • Type: org.codehaus.mojo.xml.transformer.TransformationSet[]
  • Since: 1.0
  • Required: No

<transformerFactory>

Transformer factory use. By default, the systems default transformer factory is used. If you use this feature you must use at least jdk 1.6
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: xml.transformerFactory