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 import javax.annotation.Nonnull;
25
26 import org.apache.maven.execution.MavenSession;
27 import org.apache.maven.project.MavenProject;
28 import org.apache.maven.shared.utils.io.FileUtils;
29
30 /**
31 * @author Kristian Rosenvold
32 */
33 public interface DefaultFilterInfo
34 {
35
36 /**
37 * @param mavenProject The maven project
38 * @param filters The filters to get
39 * @param escapedBackslashesInFilePath escape backslashes ?
40 * @param mavenSession The maven session
41 * @param mavenResourcesExecution The filtering configuration
42 * @throws MavenFilteringException in case of failure.
43 * @return {@link java.util.List} of FileUtils.FilterWrapper
44 * @since 1.0-beta-2
45 */
46 @Nonnull
47 List<FileUtils.FilterWrapper> getDefaultFilterWrappers( MavenProject mavenProject, List<String> filters,
48 boolean escapedBackslashesInFilePath,
49 MavenSession mavenSession,
50 MavenResourcesExecution mavenResourcesExecution )
51 throws MavenFilteringException;
52
53 /**
54 * @param request The filtering request
55 * @throws org.apache.maven.shared.filtering.MavenFilteringException in case of failure.
56 * @return {@link java.util.List} of FileUtils.FilterWrapper
57 * @since 1.0-beta-3
58 */
59 @Nonnull
60 List<FileUtils.FilterWrapper> getDefaultFilterWrappers( AbstractMavenFilteringRequest request )
61 throws MavenFilteringException;
62 }