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 org.apache.maven.execution.MavenSession;
23 import org.apache.maven.model.Resource;
24 import org.apache.maven.project.MavenProject;
25 import org.codehaus.plexus.util.FileUtils;
26
27 import java.io.File;
28 import java.util.List;
29
30 /**
31 * @author Olivier Lamy
32 *
33 */
34 public interface MavenResourcesFiltering
35 {
36
37 /**
38 * @param resources {@link List} of {@link org.apache.maven.model.Resource}
39 * @param outputDirectory parent destination directory
40 * @param mavenProject the maven project
41 * @param encoding encoding to use for writing files
42 * @param fileFilters {@link List} of String which are path to a Property file
43 * @param nonFilteredFileExtensions {@link List} of String for non filtered file extensions
44 * @param mavenSession Can include executionProperties that will be used for filtering
45 * @throws MavenFilteringException
46 * @deprecated use {@link #filterResources(MavenResourcesExecution)}
47 */
48 void filterResources( List<Resource> resources, File outputDirectory, MavenProject mavenProject, String encoding,
49 List<String> fileFilters, List<String> nonFilteredFileExtensions, MavenSession mavenSession )
50 throws MavenFilteringException;
51
52 /**
53 * @param resources {@link List} of {@link org.apache.maven.model.Resource}
54 * @param outputDirectory parent destination directory
55 * @param encoding encoding to use for writing files
56 * @param filterWrappers {@link List} of FileUtils.FilterWrapper
57 * @param resourcesBaseDirectory baseDirectory of resources
58 * @param nonFilteredFileExtensions {@link List} of String for non filtered file extensions
59 * @throws MavenFilteringException
60 * @deprecated use {@link #filterResources(MavenResourcesExecution)}
61 */
62 void filterResources( List<Resource> resources, File outputDirectory, String encoding,
63 List<FileUtils.FilterWrapper> filterWrappers, File resourcesBaseDirectory,
64 List<String> nonFilteredFileExtensions )
65 throws MavenFilteringException;
66
67 /**
68 * return the List of the non filtered extensions (jpg,jpeg,gif,bmp,png)
69 *
70 * @return {@link List} of {@link String}
71 */
72 List getDefaultNonFilteredFileExtensions();
73
74 /**
75 * @param fileName the file name
76 * @param userNonFilteredFileExtensions an extra list of file extensions
77 * @return true if filtering can be applied to the file (means extensions.lowerCase is in the
78 * default List or in the user defined extension List)
79 */
80 boolean filteredFileExtension( String fileName, List<String> userNonFilteredFileExtensions );
81
82 /**
83 * @param mavenResourcesExecution {@link MavenResourcesExecution}
84 * @throws MavenFilteringException
85 */
86 void filterResources( MavenResourcesExecution mavenResourcesExecution )
87 throws MavenFilteringException;
88 }