Fork me on GitHub
Built by Maven

xml:check-format

Full name:

org.codehaus.mojo:xml-maven-plugin:1.4.0:check-format

Description:

An XML indentation check over a set of files.

Attributes:

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

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
<encoding> String 1.0.1 The encoding of files included in formatFileSets. Note that the encoding can be set also per FormatFileSet.
Default: ${project.build.sourceEncoding}
User Property: xml.encoding
<failOnFormatViolation> boolean 1.0.1 Tells the mojo what to do in case XML formatting violations are found. if true, all violations will be reported on the console as ERRORs and the build will fail. if false, all violations will be reported on the console as WARNs and the build will proceed further.
Default: true
User Property: xml.failOnFormatViolation
<formatFileSets> List<FormatFileSet> 1.0.1 File patterns to include. The patterns are relative to the current project's baseDir.
<indentSize> int 1.0.1 The number of spaces expected for indentation. Note that indentSize can be configuread also per org.codehaus.mojo.xml.format.FormatFileSet.
Default: 2
User Property: xml.indentSize
<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
<useDefaultFormatFileSet> boolean 1.0.1 If set to true, the result of FormatFileSet#getDefault(String, int) will be appended to formatFileSets before the processing.
Default: true
User Property: xml.useDefaultFormatFileSet

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

<encoding>

The encoding of files included in formatFileSets. Note that the encoding can be set also per FormatFileSet.
  • Type: java.lang.String
  • Since: 1.0.1
  • Required: No
  • User Property: xml.encoding
  • Default: ${project.build.sourceEncoding}

<failOnFormatViolation>

Tells the mojo what to do in case XML formatting violations are found. if true, all violations will be reported on the console as ERRORs and the build will fail. if false, all violations will be reported on the console as WARNs and the build will proceed further.
  • Type: boolean
  • Since: 1.0.1
  • Required: No
  • User Property: xml.failOnFormatViolation
  • Default: true

<formatFileSets>

File patterns to include. The patterns are relative to the current project's baseDir.
  • Type: java.util.List<org.codehaus.mojo.xml.format.FormatFileSet>
  • Since: 1.0.1
  • Required: No

<indentSize>

The number of spaces expected for indentation. Note that indentSize can be configuread also per org.codehaus.mojo.xml.format.FormatFileSet.
  • Type: int
  • Since: 1.0.1
  • Required: No
  • User Property: xml.indentSize
  • Default: 2

<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

<useDefaultFormatFileSet>

If set to true, the result of FormatFileSet#getDefault(String, int) will be appended to formatFileSets before the processing.
  • Type: boolean
  • Since: 1.0.1
  • Required: No
  • User Property: xml.useDefaultFormatFileSet
  • Default: true