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