net.sourceforge.pmd.build

Class RuleSetToDocs

java.lang.Object

net.sourceforge.pmd.build.RuleSetToDocs

All Implemented Interfaces:

PmdBuildTools

public class RuleSetToDocs
extends Object
implements PmdBuildTools

A small class to convert files from pmd rulesets fmt to xdoc fmt

Author:

Romain PELISSE, belaran@gmail.com

Constructor Summary

Constructors

Constructor and Description
RuleSetToDocs()

Method Summary

Modifier and Type	Method and Description
void	convertRulesets()
String	getIndexRuleSetFilename()
String	getMergedRuleSetFilename()
String	getRulesDirectory()
URL[]	getRuntimeClasspath()
String	getSiteXml()
String	getSiteXmlTarget()
String	getTargetDirectory()
RulesetFileTemplater	getXmlFileTemplater()
void	preSiteGeneration()
void	setIndexRuleSetFilename(String indexRuleSetFilename)
void	setMergedRuleSetFilename(String mergedRuleSetFilename)
void	setRulesDirectory(String rulesDirectory)
void	setRuntimeClasspath(URL[] runtimeClasspath) Configures the classpath to use to analyze the properties of rules.
void	setSiteXml(String siteXml)
void	setSiteXmlTarget(String siteXmlTarget)
void	setTargetDirectory(String targetDirectory)
void	setXmlFileTemplater(RulesetFileTemplater xmlFileTemplater)

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleSetToDocs

public RuleSetToDocs()

Method Detail

getRuntimeClasspath

public URL[] getRuntimeClasspath()

setRuntimeClasspath

public void setRuntimeClasspath(URL[] runtimeClasspath)

Description copied from interface: PmdBuildTools

Configures the classpath to use to analyze the properties of rules.

Specified by:

setRuntimeClasspath in interface PmdBuildTools

See Also:

RuntimeRulePropertiesAnalyzer

getSiteXmlTarget

public String getSiteXmlTarget()

setSiteXmlTarget

public void setSiteXmlTarget(String siteXmlTarget)

Specified by:

setSiteXmlTarget in interface PmdBuildTools

getRulesDirectory

public String getRulesDirectory()

Specified by:

getRulesDirectory in interface PmdBuildTools

Returns:

the rulesDirectory

setRulesDirectory

public void setRulesDirectory(String rulesDirectory)

Specified by:

setRulesDirectory in interface PmdBuildTools

Parameters:

rulesDirectory - the rulesDirectory to set

getIndexRuleSetFilename

public String getIndexRuleSetFilename()

setIndexRuleSetFilename

public void setIndexRuleSetFilename(String indexRuleSetFilename)

getMergedRuleSetFilename

public String getMergedRuleSetFilename()

setMergedRuleSetFilename

public void setMergedRuleSetFilename(String mergedRuleSetFilename)

getTargetDirectory

public String getTargetDirectory()

Specified by:

getTargetDirectory in interface PmdBuildTools

Returns:

the targetDirectory

setTargetDirectory

public void setTargetDirectory(String targetDirectory)

Specified by:

setTargetDirectory in interface PmdBuildTools

Parameters:

targetDirectory - the targetDirectory to set

getXmlFileTemplater

public RulesetFileTemplater getXmlFileTemplater()

setXmlFileTemplater

public void setXmlFileTemplater(RulesetFileTemplater xmlFileTemplater)

getSiteXml

public String getSiteXml()

setSiteXml

public void setSiteXml(String siteXml)

Specified by:

setSiteXml in interface PmdBuildTools

convertRulesets

public void convertRulesets()
                     throws PmdBuildException

Specified by:

convertRulesets in interface PmdBuildTools

Throws:

PmdBuildException

preSiteGeneration

public void preSiteGeneration()

Specified by:

preSiteGeneration in interface PmdBuildTools