ExcludeFromFile (Apache Maven PMD Plugin 3.14.0 API)

Type Parameters:

D - type of violation to exclude, e.g. Violation or Duplication.

All Known Implementing Classes:

ExcludeDuplicationsFromFile, ExcludeViolationsFromFile
```
public interface ExcludeFromFile<D>
```
Author:

Andreas Dangel

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`countExclusions()`	Determines how many exclusions are considered.
`boolean`	`isExcludedFromFailure(D errorDetail)`	Checks whether the given violation is excluded.
`void`	`loadExcludeFromFailuresData(java.lang.String excludeFromFailureFile)`	Loads the exclude definitions from the given file.

- Method Detail
  - loadExcludeFromFailuresData
```
void loadExcludeFromFailuresData(java.lang.String excludeFromFailureFile)
                          throws MojoExecutionException
```
    Loads the exclude definitions from the given file.
    
    Parameters:
    
    excludeFromFailureFile - the path to the properties file
    
    Throws:
    
    MojoExecutionException - if the properties file couldn't be loaded
  - countExclusions
```
int countExclusions()
```
    Determines how many exclusions are considered.
    
    Returns:
    
    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).
    
    Parameters:
    
    errorDetail - the violation to check
    
    Returns:
    
    true if the violation should be excluded, false otherwise.