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