Package net.sourceforge.pmd.ant

Class Formatter

java.lang.Object

net.sourceforge.pmd.ant.Formatter

public class Formatter
extends Object

Part of PMD Ant task configuration. Setters of this class are interpreted by Ant as properties settable in the XML. This is therefore published API.

This class is used to configure a specific Renderer for outputting the violations. This is called a formatter in PMD Ant task configuration and might look like this:

 <pmd>
   <formatter type="html" toFile="${build}/pmd_report.html"/>
 </pmd>
 

See Also:

PMDTask.addFormatter(Formatter)

Constructor Summary

Constructors

Constructor	Description
Formatter()

Method Summary

Modifier and Type	Method	Description
void	addConfiguredParam(org.apache.tools.ant.types.Parameter parameter)
void	setShowSuppressed(boolean value)
void	setToConsole(boolean toConsole)
void	setToFile(File toFile)
void	setType(String type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Formatter

public Formatter()

Method Detail

setShowSuppressed

public void setShowSuppressed(boolean value)

setType

public void setType(String type)

setToFile

public void setToFile(File toFile)

setToConsole

public void setToConsole(boolean toConsole)

addConfiguredParam

public void addConfiguredParam(org.apache.tools.ant.types.Parameter parameter)

toString

public String toString()

Overrides:

toString in class Object