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>
AReport
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 (seePmdAnalysis.performAnalysisAndCollectReport()
) The mutation methods on this class are deprecated, as they will be internalized in PMD 7.
-
-
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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 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 deprecatedvoid
addMetric(Metric metric)
Deprecated.seeStatisticalRule
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.static Report
createReport(RuleContext ctx, String fileName)
Deprecated.Is internal APIvoid
end()
Deprecated.Not used,getElapsedTimeInMillis()
will be removedIterator<Report.ProcessingError>
errors()
Deprecated.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.UnusedList<ThreadSafeReportListener>
getListeners()
Deprecated.ThreadSafeReportListener
is deprecatedList<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.UsegetSuppressedViolations()
(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.TheReportTree
is deprecatedboolean
hasConfigErrors()
Deprecated.UsegetConfigurationErrors()
.isEmpty()boolean
hasErrors()
Deprecated.UsegetProcessingErrors()
.isEmpty()boolean
hasMetrics()
Deprecated.seeStatisticalRule
boolean
isEmpty()
Deprecated.Iterator<RuleViolation>
iterator()
Deprecated.UsegetViolations()
void
merge(Report r)
Deprecated.Internal APIIterator<Metric>
metrics()
Deprecated.seeStatisticalRule
int
size()
Deprecated.UsegetViolations()
void
start()
Deprecated.Not used,getElapsedTimeInMillis()
will be removedvoid
suppress(Map<Integer,String> lines)
Configure the lines, that are suppressed via a NOPMD comment.boolean
treeIsEmpty()
Deprecated.TheReportTree
is deprecated, usegetViolations()
.isEmpty() instead.Iterator<RuleViolation>
treeIterator()
Deprecated.TheReportTree
is deprecatedint
treeSize()
Deprecated.TheReportTree
is deprecated-
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 APICreates a new, initialized, empty report for the given file name.- Parameters:
ctx
- The context to use to connect to the reportfileName
- 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.TheReportTree
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.UsegetSuppressedViolations()
(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.seeStatisticalRule
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 APIMerges 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.seeStatisticalRule
Check whether any metrics have been reported- Returns:
true
if there are metrics,false
otherwise
-
metrics
@Deprecated public Iterator<Metric> metrics()
Deprecated.seeStatisticalRule
Iterate over the metrics.- Returns:
- an iterator over the metrics
-
isEmpty
@Deprecated public boolean isEmpty()
Deprecated.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.UsegetProcessingErrors()
.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.UsegetConfigurationErrors()
.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.TheReportTree
is deprecated, usegetViolations()
.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.TheReportTree
is deprecatedReturns an iteration over the reported violations.- Returns:
- an iterator
-
iterator
@Deprecated public Iterator<RuleViolation> iterator()
Deprecated.UsegetViolations()
- Specified by:
iterator
in interfaceIterable<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.Returns an iterator of the reported processing errors.- Returns:
- the iterator
-
configErrors
@Deprecated public Iterator<Report.ConfigurationError> configErrors()
Deprecated.Returns an iterator of the reported configuration errors.- Returns:
- the iterator
-
treeSize
@Deprecated public int treeSize()
Deprecated.TheReportTree
is deprecatedThe number of violations.- Returns:
- number of violations.
-
size
@Deprecated public int size()
Deprecated.UsegetViolations()
The number of violations.- Returns:
- number of violations.
-
start
@Deprecated public void start()
Deprecated.Not used,getElapsedTimeInMillis()
will be removedMark 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 removedMark 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 deprecatedAdds all given listeners to this report- Parameters:
allListeners
- the report listeners
-
-