Package net.sourceforge.pmd.util.treeexport

Class TreeExportConfiguration

java.lang.Object

net.sourceforge.pmd.AbstractConfiguration

net.sourceforge.pmd.util.treeexport.TreeExportConfiguration

public class TreeExportConfiguration
extends AbstractConfiguration

Constructor Summary

Constructors

Constructor	Description
TreeExportConfiguration()
TreeExportConfiguration(LanguageRegistry registry)

Method Summary

Modifier and Type	Method	Description
void	addRelativizeRoot(Path path)	Set the path used to shorten paths output in the report.
void	addRelativizeRoots(List<Path> paths)	Add several paths to shorten paths that are output in the report.
Path	getFile()
String	getFormat()
Language	getLanguage()
Properties	getLanguageProperties()
PmdReporter	getMessageReporter()
Properties	getProperties()
List<Path>	getRelativizeRoots()	Returns the paths used to shorten paths output in the report.
boolean	isReadStdin()
void	setFile(Path file)
void	setFormat(String format)
void	setLanguage(Language language)
void	setLanguageProperties(Properties properties)
void	setMessageReporter(PmdReporter messageReporter)
void	setProperties(Properties properties)
void	setReadStdin(boolean readStdin)

Methods inherited from class net.sourceforge.pmd.AbstractConfiguration

addInputPath, checkLanguageIsAcceptable, collectFilesRecursively, collectFilesRecursively, getExcludes, getForceLanguageVersion, getIgnoreFile, getInputFile, getInputPathList, getLanguageProperties, getLanguageRegistry, getLanguageVersionDiscoverer, getLanguageVersionOfFile, getReporter, getReportFilePath, getSourceEncoding, getUri, isFailOnError, isFailOnViolation, isForceLanguageVersion, setDefaultLanguageVersion, setDefaultLanguageVersions, setExcludes, setFailOnError, setFailOnViolation, setForceLanguageVersion, setIgnoreFilePath, setInputFilePath, setInputPathList, setInputUri, setOnlyRecognizeLanguage, setReporter, setReportFile, setSourceEncoding

Methods inherited from class java.lang.Object

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

Constructor Details

TreeExportConfiguration

public TreeExportConfiguration(LanguageRegistry registry)

TreeExportConfiguration

public TreeExportConfiguration()

Method Details

getFormat

public String getFormat()

getLanguage

public Language getLanguage()

getProperties

public Properties getProperties()

getFile

public Path getFile()

getLanguageProperties

public Properties getLanguageProperties()

isReadStdin

public boolean isReadStdin()

setFormat

public void setFormat(String format)

setLanguage

public void setLanguage(Language language)

setProperties

public void setProperties(Properties properties)

setLanguageProperties

public void setLanguageProperties(Properties properties)

setFile

public void setFile(Path file)

setReadStdin

public void setReadStdin(boolean readStdin)

getMessageReporter

public PmdReporter getMessageReporter()

setMessageReporter

public void setMessageReporter(PmdReporter messageReporter)

getRelativizeRoots

public List<Path> getRelativizeRoots()

Description copied from class: AbstractConfiguration

Returns the paths used to shorten paths output in the report.

• If the list is empty, then paths are not touched
• If the list is non-empty, then source file paths are relativized with all the items in the list. The shortest of these relative paths is taken as the display name of the file.

Overrides:

getRelativizeRoots in class AbstractConfiguration

addRelativizeRoot

public void addRelativizeRoot(Path path)

Description copied from class: AbstractConfiguration

Set the path used to shorten paths output in the report. The path does not need to exist. If it exists, it must point to a directory and not a file. See AbstractConfiguration.getRelativizeRoots() for the interpretation.

If several paths are added, the shortest paths possible are built.

Overrides:

addRelativizeRoot in class AbstractConfiguration

Parameters:

path - A path

addRelativizeRoots

public void addRelativizeRoots(List<Path> paths)

Description copied from class: AbstractConfiguration

Add several paths to shorten paths that are output in the report. See AbstractConfiguration.addRelativizeRoot(Path).

Overrides:

addRelativizeRoots in class AbstractConfiguration

Parameters:

paths - A list of non-null paths