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