Package rife.bld.extension.pmd

Record Class PmdAnalysisResults

java.lang.Object
java.lang.Record
rife.bld.extension.pmd.PmdAnalysisResults
Record Components:
violations - The number of violations found during the analysis
suppressedViolations - The number of suppressed violations found during the analysis
errors - The number of errors returned during the analysis
processingErrors - The number of processing errors returned during the analysis
configurationErrors - The number of processing errors returning during the analysis
rulesChecked - The number of rules checked during the analysis
public record PmdAnalysisResults(int violations, int suppressedViolations, int errors, int processingErrors, int configurationErrors, int rulesChecked) extends Record
Represents the results of a PMD analysis, containing various counts related to violations, errors, and rules.
Since:
1.3.0

  • Constructor Details

    • PmdAnalysisResults

      public PmdAnalysisResults(int violations, int suppressedViolations, int errors, int processingErrors, int configurationErrors, int rulesChecked)
      Creates an instance of a PmdAnalysisResults record class.
      Parameters:
      violations - the value for the violations record component
      suppressedViolations - the value for the suppressedViolations record component
      errors - the value for the errors record component
      processingErrors - the value for the processingErrors record component
      configurationErrors - the value for the configurationErrors record component
      rulesChecked - the value for the rulesChecked record component

  • Method Details

    • hasNoErrors

      public boolean hasNoErrors()
      Checks if the analysis results indicate no errors of any type.
      Returns:
      true if there are no errors, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • violations

      public int violations()
      Returns the value of the violations record component.
      Returns:
      the value of the violations record component

    • suppressedViolations

      public int suppressedViolations()
      Returns the value of the suppressedViolations record component.
      Returns:
      the value of the suppressedViolations record component

    • errors

      public int errors()
      Returns the value of the errors record component.
      Returns:
      the value of the errors record component

    • processingErrors

      public int processingErrors()
      Returns the value of the processingErrors record component.
      Returns:
      the value of the processingErrors record component

    • configurationErrors

      public int configurationErrors()
      Returns the value of the configurationErrors record component.
      Returns:
      the value of the configurationErrors record component

    • rulesChecked

      public int rulesChecked()
      Returns the value of the rulesChecked record component.
      Returns:
      the value of the rulesChecked record component