1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.plugins.pmd;
20
21 import org.apache.maven.plugin.MojoExecutionException;
22
23 /**
24 * @param <D> type of violation to exclude, e.g. {@link org.apache.maven.plugins.pmd.model.Violation}
25 * or {@link org.apache.maven.plugins.pmd.model.Duplication}.
26 * @author Andreas Dangel
27 */
28 public interface ExcludeFromFile<D> {
29 /**
30 * Loads the exclude definitions from the given file.
31 *
32 * @param excludeFromFailureFile the path to the properties file
33 * @throws MojoExecutionException if the properties file couldn't be loaded
34 */
35 void loadExcludeFromFailuresData(String excludeFromFailureFile) throws MojoExecutionException;
36
37 /**
38 * Determines how many exclusions are considered.
39 * @return the number of active exclusions
40 */
41 int countExclusions();
42
43 /**
44 * Checks whether the given violation is excluded. Note: the exclusions must have been
45 * loaded before via {@link #loadExcludeFromFailuresData(String)}.
46 *
47 * @param errorDetail the violation to check
48 * @return <code>true</code> if the violation should be excluded, <code>false</code> otherwise.
49 */
50 boolean isExcludedFromFailure(D errorDetail);
51 }