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