Package org.codehaus.mojo.xml

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 org.codehaus.mojo.xml.AbstractXmlMojo

AbstractXmlMojo.CatalogHandling

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor	Description
CheckFormatMojo()	Creates a new CheckFormatMojo instance.

Method Summary

Modifier and Type	Method	Description
void	execute()	Called by Maven for executing the Mojo.
void	setIndentSize(int indentSize)	Sets the number of spaces for indentation.

Methods inherited from class org.codehaus.mojo.xml.AbstractXmlMojo

activateProxy, asAbsoluteFile, asFiles, getBasedir, getCatalogHandling, getExcludes, getFileNames, getFiles, getLocator, getProject, getResolver, getResource, isSkipping, passivateProxy, setCatalogs

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 Details

CheckFormatMojo

public CheckFormatMojo()

Creates a new CheckFormatMojo instance.

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Called by Maven for executing the Mojo.

Throws:

org.apache.maven.plugin.MojoExecutionException - Running the Mojo failed.

org.apache.maven.plugin.MojoFailureException - A configuration error was detected.

setIndentSize

public void setIndentSize(int indentSize)

Sets the number of spaces for indentation.

Parameters:

indentSize - the number of spaces