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