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.shared.filtering;
20
21 import java.util.List;
22
23 /**
24 * @author Olivier Lamy
25 */
26 public interface MavenResourcesFiltering {
27
28 /**
29 * return the List of the non filtered extensions (jpg,jpeg,gif,bmp,png,ico)
30 *
31 * @return {@link List} of {@link String}
32 */
33 List<String> getDefaultNonFilteredFileExtensions();
34
35 /**
36 * @param fileName the file name
37 * @param userNonFilteredFileExtensions an extra list of file extensions
38 * @return true if filtering can be applied to the file (means extensions.lowerCase is in the default List or in the
39 * user defined extension List)
40 */
41 boolean filteredFileExtension(String fileName, List<String> userNonFilteredFileExtensions);
42
43 /**
44 * @param mavenResourcesExecution {@link MavenResourcesExecution}
45 * @throws MavenFilteringException in case of failure.
46 */
47 void filterResources(MavenResourcesExecution mavenResourcesExecution) throws MavenFilteringException;
48 }