XmlFormatPlugin (XML Format Maven Plugin 3.1.1 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - au.com.acegi.xmlformat.AbstractXmlPlugin
  - - au.com.acegi.xmlformat.XmlFormatPlugin

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="xml-format",
      defaultPhase=PREPARE_PACKAGE)
public final class XmlFormatPlugin
extends AbstractXmlPlugin
```
Finds the XML files in a project and automatically reformats them.

Field Summary
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Constructor Summary

Constructors
Constructor Description

XmlFormatPlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`afterAllProcessed(boolean neededFormatting)`	Invoked after all files in the project have been processed.
`protected boolean`	`processFile(File input, org.dom4j.io.OutputFormat fmt)`	Processes a single file found in the project.

Methods inherited from class au.com.acegi.xmlformat.AbstractXmlPlugin
execute

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XmlFormatPlugin
```
public XmlFormatPlugin()
```
- Method Detail
  - processFile
```
protected boolean processFile(File input,
                              org.dom4j.io.OutputFormat fmt)
                       throws org.dom4j.DocumentException,
                              IOException
```
    Description copied from class: AbstractXmlPlugin
    
    Processes a single file found in the project.
    
    Specified by:
    
    processFile in class AbstractXmlPlugin
    
    Parameters:
    
    input - the file to process
    
    fmt - the formatting options
    
    Returns:
    
    true if the file required changes to match the formatting style
    
    Throws:
    
    org.dom4j.DocumentException - if input XML could not be parsed
    
    IOException - if output XML stream could not be written
  - afterAllProcessed
```
protected void afterAllProcessed(boolean neededFormatting)
```
    Description copied from class: AbstractXmlPlugin
    
    Invoked after all files in the project have been processed.
    
    Specified by:
    
    afterAllProcessed in class AbstractXmlPlugin
    
    Parameters:
    
    neededFormatting - whether any processed file required changes to match the formatting style