Package org.apache.maven.plugins.pmd
Class ExcludeViolationsFromFile
java.lang.Object
org.apache.maven.plugins.pmd.ExcludeViolationsFromFile
- All Implemented Interfaces:
ExcludeFromFile<Violation>
This class contains utility for loading property files, which define which PMD violations
from which classes should be ignored and not cause a failure.
See property
pmd.excludeFromFailureFile
.- Author:
- Andreas Dangel
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Determines how many exclusions are considered.boolean
isExcludedFromFailure
(net.sourceforge.pmd.RuleViolation errorDetail) Checks whether the givenRuleViolation
is excluded.boolean
isExcludedFromFailure
(Violation errorDetail) Checks whether the given violation is excluded.void
loadExcludeFromFailuresData
(String excludeFromFailureFile) Loads the exclude definitions from the given file.
-
Constructor Details
-
ExcludeViolationsFromFile
public ExcludeViolationsFromFile()
-
-
Method Details
-
loadExcludeFromFailuresData
public void loadExcludeFromFailuresData(String excludeFromFailureFile) throws MojoExecutionException Description copied from interface:ExcludeFromFile
Loads the exclude definitions from the given file.- Specified by:
loadExcludeFromFailuresData
in interfaceExcludeFromFile<Violation>
- Parameters:
excludeFromFailureFile
- the path to the properties file- Throws:
MojoExecutionException
- if the properties file couldn't be loaded
-
isExcludedFromFailure
Description copied from interface:ExcludeFromFile
Checks whether the given violation is excluded. Note: the exclusions must have been loaded before viaExcludeFromFile.loadExcludeFromFailuresData(String)
.- Specified by:
isExcludedFromFailure
in interfaceExcludeFromFile<Violation>
- Parameters:
errorDetail
- the violation to check- Returns:
true
if the violation should be excluded,false
otherwise.
-
isExcludedFromFailure
public boolean isExcludedFromFailure(net.sourceforge.pmd.RuleViolation errorDetail) Checks whether the givenRuleViolation
is excluded. Note: the exclusions must have been loaded before vialoadExcludeFromFailuresData(String)
.- Parameters:
errorDetail
- the violation to check- Returns:
true
if the violation should be excluded,false
otherwise.
-
countExclusions
public int countExclusions()Description copied from interface:ExcludeFromFile
Determines how many exclusions are considered.- Specified by:
countExclusions
in interfaceExcludeFromFile<Violation>
- Returns:
- the number of active exclusions
-