Package org.apache.maven.plugins.pmd

Schnittstelle ExcludeFromFile<D>

Typparameter:
D - type of violation to exclude, e.g. Violation or Duplication.
Alle bekannten Implementierungsklassen:
ExcludeDuplicationsFromFile, ExcludeViolationsFromFile
public interface ExcludeFromFile<D>
Autor:
Andreas Dangel

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    int
    countExclusions()
    Determines how many exclusions are considered.
    boolean
    isExcludedFromFailure(D errorDetail)
    Checks whether the given violation is excluded.
    void
    loadExcludeFromFailuresData(String excludeFromFailureFile)
    Loads the exclude definitions from the given file.

  • Methodendetails

    • loadExcludeFromFailuresData

      void loadExcludeFromFailuresData(String excludeFromFailureFile) throws org.apache.maven.plugin.MojoExecutionException
      Loads the exclude definitions from the given file.
      Parameter:
      excludeFromFailureFile - the path to the properties file
      Löst aus:
      org.apache.maven.plugin.MojoExecutionException - if the properties file couldn't be loaded

    • countExclusions

      int countExclusions()
      Determines how many exclusions are considered.
      Gibt zurück:
      the number of active exclusions

    • isExcludedFromFailure

      boolean isExcludedFromFailure(D errorDetail)
      Checks whether the given violation is excluded. Note: the exclusions must have been loaded before via loadExcludeFromFailuresData(String).
      Parameter:
      errorDetail - the violation to check
      Gibt zurück:
      true if the violation should be excluded, false otherwise.