Package net.sourceforge.pmd

Class Report

java.lang.Object

net.sourceforge.pmd.Report

All Implemented Interfaces:

Iterable<RuleViolation>

public class Report
extends Object
implements Iterable<RuleViolation>

A Report is the output of a PMD execution. This includes violations, suppressed violations, metrics, error during processing and configuration errors. PMD's entry point creates a report (see PmdAnalysis.performAnalysisAndCollectReport()) The mutation methods on this class are deprecated, as they will be internalized in PMD 7.

For special use cases, like filtering the report after PMD analysis and before rendering the report, some transformation operations are provided:

• filterViolations(Predicate)
• union(Report)

These methods create a new Report rather than modifying their receiver.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Report.ConfigurationError	Represents a configuration error.
static class	Report.ProcessingError	Represents a processing error, such as a parse error.
static class	Report.ReadableDuration	Deprecated. Not used within PMD.
static class	Report.SuppressedViolation	Represents a violation, that has been suppressed.

Constructor Summary

Constructors

Constructor	Description
Report()	Deprecated. Report instances are created by PMD.

Method Summary

Modifier and Type	Method	Description
void	addConfigError(Report.ConfigurationError error)	Deprecated. PMD's way of creating a report is internal and may be changed in pmd 7.
void	addError(Report.ProcessingError error)	Deprecated. PMD's way of creating a report is internal and may be changed in pmd 7.
void	addListener(ThreadSafeReportListener listener)	Deprecated.
void	addListeners(List<ThreadSafeReportListener> allListeners)	Deprecated. ThreadSafeReportListener is deprecated
void	addMetric(Metric metric)	Deprecated. see StatisticalRule
void	addRuleViolation(RuleViolation violation)	Deprecated. PMD's way of creating a report is internal and may be changed in pmd 7.
Iterator<Report.ConfigurationError>	configErrors()	Deprecated. Use getConfigurationErrors()
static Report	createReport(RuleContext ctx, String fileName)	Deprecated. Is internal API
void	end()	Deprecated. Not used, getElapsedTimeInMillis() will be removed
Iterator<Report.ProcessingError>	errors()	Deprecated. Use getProcessingErrors()
Report	filterViolations(Predicate<RuleViolation> filter)	Creates a new report taking all the information from this report, but filtering the violations.
List<Report.ConfigurationError>	getConfigurationErrors()	Returns an unmodifiable list of configuration errors that have been recorded until now.
Map<String,Integer>	getCountSummary()	Deprecated. This is too specific.
long	getElapsedTimeInMillis()	Deprecated. Unused
List<ThreadSafeReportListener>	getListeners()	Deprecated. ThreadSafeReportListener is deprecated
List<Report.ProcessingError>	getProcessingErrors()	Returns an unmodifiable list of processing errors that have been recorded until now.
Map<String,Integer>	getSummary()	Deprecated. This is too specific, only used by one renderer.
List<Report.SuppressedViolation>	getSuppressedRuleViolations()	Deprecated. Use getSuppressedViolations() (be aware, that that method returns an unmodifiable list)
List<Report.SuppressedViolation>	getSuppressedViolations()	Returns an unmodifiable list of violations that were suppressed.
List<RuleViolation>	getViolations()	Returns an unmodifiable list of violations that have been recorded until now.
ReportTree	getViolationTree()	Deprecated. The ReportTree is deprecated
boolean	hasConfigErrors()	Deprecated. Use getConfigurationErrors().isEmpty()
boolean	hasErrors()	Deprecated. Use getProcessingErrors().isEmpty()
boolean	hasMetrics()	Deprecated. see StatisticalRule
boolean	isEmpty()	Deprecated. Use getViolations() or getProcessingErrors()
Iterator<RuleViolation>	iterator()	Deprecated. Use getViolations()
void	merge(Report r)	Deprecated. Internal API
Iterator<Metric>	metrics()	Deprecated. see StatisticalRule
int	size()	Deprecated. Use getViolations()
void	start()	Deprecated. Not used, getElapsedTimeInMillis() will be removed
void	suppress(Map<Integer,String> lines)	Configure the lines, that are suppressed via a NOPMD comment.
boolean	treeIsEmpty()	Deprecated. The ReportTree is deprecated, use getViolations().isEmpty() instead.
Iterator<RuleViolation>	treeIterator()	Deprecated. The ReportTree is deprecated
int	treeSize()	Deprecated. The ReportTree is deprecated
Report	union(Report other)	Creates a new report by combining this report with another report.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Report

@Deprecated
@InternalApi
public Report()

Deprecated.

Report instances are created by PMD. There is no need to create a own report. This constructor will be hidden in PMD7.

Method Detail

createReport

@Deprecated
@InternalApi
public static Report createReport(RuleContext ctx,
                                  String fileName)

Deprecated.

Is internal API

Creates a new, initialized, empty report for the given file name.

Parameters:

ctx - The context to use to connect to the report

fileName - the filename used to report any violations

Returns:

the new report

suppress

public void suppress(Map<Integer,String> lines)

Configure the lines, that are suppressed via a NOPMD comment.

Parameters:

lines - the suppressed lines

getCountSummary

@Deprecated
public Map<String,Integer> getCountSummary()

Deprecated.

This is too specific. Not every violation has a qualified name.

Calculate a summary of violation counts per fully classified class name.

Returns:

violations per class name

getViolationTree

@Deprecated
public ReportTree getViolationTree()

Deprecated.

The ReportTree is deprecated

getSummary

@Deprecated
public Map<String,Integer> getSummary()

Deprecated.

This is too specific, only used by one renderer.

Calculate a summary of violations per rule.

Returns:

a Map summarizing the Report: String (rule name) -> Integer (count of violations)

addListener

@Deprecated
public void addListener(ThreadSafeReportListener listener)

Deprecated.

Registers a report listener

Parameters:

listener - the listener

getSuppressedRuleViolations

@Deprecated
public List<Report.SuppressedViolation> getSuppressedRuleViolations()

Deprecated.

Use getSuppressedViolations() (be aware, that that method returns an unmodifiable list)

Returns the suppressed violations.

addRuleViolation

@Deprecated
@InternalApi
public void addRuleViolation(RuleViolation violation)

Deprecated.

PMD's way of creating a report is internal and may be changed in pmd 7.

Adds a new rule violation to the report and notify the listeners.

Parameters:

violation - the violation to add

addMetric

@Deprecated
public void addMetric(Metric metric)

Deprecated.

see StatisticalRule

Adds a new metric to the report and notify the listeners

Parameters:

metric - the metric to add

addConfigError

@Deprecated
@InternalApi
public void addConfigError(Report.ConfigurationError error)

Deprecated.

PMD's way of creating a report is internal and may be changed in pmd 7.

Adds a new configuration error to the report.

Parameters:

error - the error to add

addError

@Deprecated
@InternalApi
public void addError(Report.ProcessingError error)

Deprecated.

PMD's way of creating a report is internal and may be changed in pmd 7.

Adds a new processing error to the report.

Parameters:

error - the error to add

merge

@Deprecated
@InternalApi
public void merge(Report r)

Deprecated.

Internal API

Merges the given report into this report. This might be necessary, if a summary over all violations is needed as PMD creates one report per file by default.

This is synchronized on an internal lock (note that other mutation operations are not synchronized, todo for pmd 7).

Parameters:

r - the report to be merged into this.

See Also:

AbstractAccumulatingRenderer

hasMetrics

@Deprecated
public boolean hasMetrics()

Deprecated.

see StatisticalRule

Check whether any metrics have been reported

Returns:

true if there are metrics, false otherwise

metrics

@Deprecated
public Iterator<Metric> metrics()

Deprecated.

see StatisticalRule

Iterate over the metrics.

Returns:

an iterator over the metrics

isEmpty

@Deprecated
public boolean isEmpty()

Deprecated.

Use getViolations() or getProcessingErrors()

Checks whether there are no violations and no processing errors. That means, that PMD analysis yielded nothing to worry about.

hasErrors

@Deprecated
public boolean hasErrors()

Deprecated.

Use getProcessingErrors().isEmpty()

Checks whether any processing errors have been reported.

Returns:

true if there were any processing errors, false otherwise

hasConfigErrors

@Deprecated
public boolean hasConfigErrors()

Deprecated.

Use getConfigurationErrors().isEmpty()

Checks whether any configuration errors have been reported.

Returns:

true if there were any configuration errors, false otherwise

treeIsEmpty

@Deprecated
public boolean treeIsEmpty()

Deprecated.

The ReportTree is deprecated, use getViolations().isEmpty() instead.

Checks whether no violations have been reported.

Returns:

true if no violations have been reported, false otherwise

treeIterator

@Deprecated
public Iterator<RuleViolation> treeIterator()

Deprecated.

The ReportTree is deprecated

Returns an iteration over the reported violations.

Returns:

an iterator

iterator

@Deprecated
public Iterator<RuleViolation> iterator()

Deprecated.

Use getViolations()

Specified by:

iterator in interface Iterable<RuleViolation>

getSuppressedViolations

public final List<Report.SuppressedViolation> getSuppressedViolations()

Returns an unmodifiable list of violations that were suppressed.

getViolations

public final List<RuleViolation> getViolations()

Returns an unmodifiable list of violations that have been recorded until now. None of those violations were suppressed.

The violations list is sorted with RuleViolation.DEFAULT_COMPARATOR.

getProcessingErrors

public final List<Report.ProcessingError> getProcessingErrors()

Returns an unmodifiable list of processing errors that have been recorded until now.

getConfigurationErrors

public final List<Report.ConfigurationError> getConfigurationErrors()

Returns an unmodifiable list of configuration errors that have been recorded until now.

errors

@Deprecated
public Iterator<Report.ProcessingError> errors()

Deprecated.

Use getProcessingErrors()

Returns an iterator of the reported processing errors.

Returns:

the iterator

configErrors

@Deprecated
public Iterator<Report.ConfigurationError> configErrors()

Deprecated.

Use getConfigurationErrors()

Returns an iterator of the reported configuration errors.

Returns:

the iterator

treeSize

@Deprecated
public int treeSize()

Deprecated.

The ReportTree is deprecated

The number of violations.

Returns:

number of violations.

size

@Deprecated
public int size()

Deprecated.

Use getViolations()

The number of violations.

Returns:

number of violations.

start

@Deprecated
public void start()

Deprecated.

Not used, getElapsedTimeInMillis() will be removed

Mark the start time of the report. This is used to get the elapsed time in the end.

See Also:

getElapsedTimeInMillis()

end

@Deprecated
public void end()

Deprecated.

Not used, getElapsedTimeInMillis() will be removed

Mark the end time of the report. This is ued to get the elapsed time.

See Also:

getElapsedTimeInMillis()

getElapsedTimeInMillis

@Deprecated
public long getElapsedTimeInMillis()

Deprecated.

Unused

getListeners

@Deprecated
public List<ThreadSafeReportListener> getListeners()

Deprecated.

ThreadSafeReportListener is deprecated

addListeners

@Deprecated
public void addListeners(List<ThreadSafeReportListener> allListeners)

Deprecated.

ThreadSafeReportListener is deprecated

Adds all given listeners to this report

Parameters:

allListeners - the report listeners

filterViolations

@Experimental
public Report filterViolations(Predicate<RuleViolation> filter)

Creates a new report taking all the information from this report, but filtering the violations.

Parameters:

filter - when true, the violation will be kept.

Returns:

copy of this report

union

@Experimental
public Report union(Report other)

Creates a new report by combining this report with another report. This is similar to merge(Report), but instead a new report is created. The lowest start time and greatest end time are kept in the copy.

Parameters:

other - the other report to combine

Returns: