RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.pmd-code.org/apidocs/pmd-core/6.55.0/net/sourceforge/pmd/Report.html below:

Report (PMD Core 6.55.0 API)

java.lang.Object
- net.sourceforge.pmd.Report

- Nested Class Summary
- Constructor Summary Constructors Constructor Description Report() Deprecated.
- Method Summary
  - Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface java.lang.IterableforEach, spliterator

- Constructor Detail
  - Report
```
@Deprecated
@InternalApi
public Report()
```
- Method Detail
  - createReport
```
@Deprecated
@InternalApi
public static Report createReport(RuleContext ctx,
                                  String fileName)
```
    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()
```
    Calculate a summary of violation counts per fully classified class name.
    
    Returns:
    
    violations per class name
  - getViolationTree
```
@Deprecated
public ReportTree getViolationTree()
```
  - getSummary
```
@Deprecated
public Map<String,Integer> getSummary()
```
    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()
```
    Returns the suppressed violations.
  - addRuleViolation
```
@Deprecated
@InternalApi
public void addRuleViolation(RuleViolation violation)
```
    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)
```
    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)
```
    Adds a new configuration error to the report.
    
    Parameters:
    
    error - the error to add
  - addError
```
@Deprecated
@InternalApi
public void addError(Report.ProcessingError error)
```
    Adds a new processing error to the report.
    
    Parameters:
    
    error - the error to add
  - merge
```
@Deprecated
@InternalApi
public void merge(Report r)
```
    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()
```
    Check whether any metrics have been reported
    
    Returns:
    
    true if there are metrics, false otherwise
  - metrics
```
@Deprecated
public Iterator<Metric> metrics()
```
    Iterate over the metrics.
    
    Returns:
    
    an iterator over the metrics
  - isEmpty
```
@Deprecated
public boolean isEmpty()
```
    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()
```
    Checks whether any processing errors have been reported.
    
    Returns:
    
    true if there were any processing errors, false otherwise
  - hasConfigErrors
```
@Deprecated
public boolean hasConfigErrors()
```
    Checks whether any configuration errors have been reported.
    
    Returns:
    
    true if there were any configuration errors, false otherwise
  - treeIsEmpty
```
@Deprecated
public boolean treeIsEmpty()
```
    Checks whether no violations have been reported.
    
    Returns:
    
    true if no violations have been reported, false otherwise
  - treeIterator
```
@Deprecated
public Iterator<RuleViolation> treeIterator()
```
    Returns an iteration over the reported violations.
    
    Returns:
    
    an iterator
  - iterator
```
@Deprecated
public Iterator<RuleViolation> iterator()
```
    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()
```
    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()
```
    Returns an iterator of the reported processing errors.
    
    Returns:
    
    the iterator
  - configErrors
```
@Deprecated
public Iterator<Report.ConfigurationError> configErrors()
```
    Returns an iterator of the reported configuration errors.
    
    Returns:
    
    the iterator
  - treeSize
```
@Deprecated
public int treeSize()
```
    The number of violations.
    
    Returns:
    
    number of violations.
  - size
```
@Deprecated
public int size()
```
    The number of violations.
    
    Returns:
    
    number of violations.
  - start
```
@Deprecated
public void start()
```
    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()
```
    Mark the end time of the report. This is ued to get the elapsed time.
    
    See Also:
    
    getElapsedTimeInMillis()
  - getElapsedTimeInMillis
```
@Deprecated
public long getElapsedTimeInMillis()
```
  - getListeners
```
@Deprecated
public List<ThreadSafeReportListener> getListeners()
```
  - addListeners
```
@Deprecated
public void addListeners(List<ThreadSafeReportListener> allListeners)
```
    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:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4