Class CheckFormatMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.mojo.xml.AbstractXmlMojo

org.codehaus.mojo.xml.CheckFormatMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(defaultPhase=VALIDATE,
      name="check-format",
      threadSafe=true)
public class CheckFormatMojo
extends AbstractXmlMojo

An XML indentation check over a set of files.

Author:

Peter Palaga

Nested Class Summary

Nested classes/interfaces inherited from class AbstractXmlMojo

AbstractXmlMojo.CatalogHandling

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
CheckFormatMojo(org.codehaus.plexus.resource.ResourceManager locator)	Creates a new CheckFormatMojo instance.

Method Summary

Modifier and Type	Method	Description
protected void	executeXmlMojo()	The equivalent of AbstractXmlMojo.execute() for any subclasses.
void	setIndentSize(int indentSize)	Sets the number of spaces for indentation.

Methods inherited from class AbstractXmlMojo

activateProxy, asAbsoluteFile, asFiles, execute, getBasedir, getCatalogHandling, getExcludes, getFileNames, getFiles, getJaxpConfigFactory, getLocator, getProject, getResolver, getResource, isSkippedForMissingBaseDirectory, isSkipping, passivateProxy, setCatalogs, setJaxpConfigurationFile, unsetJaxpConfigurationFile

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CheckFormatMojo

@Inject
public CheckFormatMojo(org.codehaus.plexus.resource.ResourceManager locator)

Creates a new CheckFormatMojo instance.

Method Details

executeXmlMojo

protected void executeXmlMojo()
                       throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Description copied from class: AbstractXmlMojo

The equivalent of AbstractXmlMojo.execute() for any subclasses.

Specified by:

executeXmlMojo in class AbstractXmlMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if an unexpected problem occurs. Throwing this exception causes a "BUILD ERROR" message to be displayed.

org.apache.maven.plugin.MojoFailureException - if an expected problem (such as a compilation failure) occurs. Throwing this exception causes a "BUILD FAILURE" message to be displayed.

setIndentSize

public void setIndentSize(int indentSize)

Sets the number of spaces for indentation.

Parameters:

indentSize - the number of spaces