package org.apache.maven.shared.filtering;

 /*

  * Licensed to the Apache Software Foundation (ASF) under one

  * or more contributor license agreements.  See the NOTICE file

  * distributed with this work for additional information

  * regarding copyright ownership.  The ASF licenses this file

  * to you under the Apache License, Version 2.0 (the

  * "License"); you may not use this file except in compliance

  * with the License.  You may obtain a copy of the License at

  *

  *    http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing,

  * software distributed under the License is distributed on an

  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

  * KIND, either express or implied.  See the License for the

  * specific language governing permissions and limitations

  * under the License.

  */

 import org.apache.maven.execution.MavenSession;

 import org.apache.maven.model.Resource;

 import org.apache.maven.project.MavenProject;

 import org.codehaus.plexus.util.FileUtils;

 import java.io.File;

 import java.util.List;

 /**

  * @author Olivier Lamy

  *

  */

 public interface MavenResourcesFiltering

 {

     /**

      * @param resources                 {@link List} of {@link org.apache.maven.model.Resource}

      * @param outputDirectory           parent destination directory

      * @param mavenProject              the maven project

      * @param encoding                  encoding to use for writing files

      * @param fileFilters               {@link List} of String which are path to a Property file

      * @param nonFilteredFileExtensions {@link List} of String for non filtered file extensions

      * @param mavenSession              Can include executionProperties that will be used for filtering

      * @throws MavenFilteringException

      * @deprecated use {@link #filterResources(MavenResourcesExecution)}

      */

     void filterResources( List<Resource> resources, File outputDirectory, MavenProject mavenProject, String encoding,

                           List<String> fileFilters, List<String> nonFilteredFileExtensions, MavenSession mavenSession )

         throws MavenFilteringException;

     /**

      * @param resources                 {@link List} of {@link org.apache.maven.model.Resource}

      * @param outputDirectory           parent destination directory

      * @param encoding                  encoding to use for writing files

      * @param filterWrappers            {@link List} of FileUtils.FilterWrapper

      * @param resourcesBaseDirectory    baseDirectory of resources

      * @param nonFilteredFileExtensions {@link List} of String for non filtered file extensions

      * @throws MavenFilteringException

      * @deprecated use {@link #filterResources(MavenResourcesExecution)}

      */

     void filterResources( List<Resource> resources, File outputDirectory, String encoding,

                           List<FileUtils.FilterWrapper> filterWrappers, File resourcesBaseDirectory,

                           List<String> nonFilteredFileExtensions )

         throws MavenFilteringException;

     /**

      * return the List of the non filtered extensions (jpg,jpeg,gif,bmp,png)

      *

      * @return {@link List} of {@link String}

      */

     List getDefaultNonFilteredFileExtensions();

     /**

      * @param fileName                      the file name

      * @param userNonFilteredFileExtensions an extra list of file extensions

      * @return true if filtering can be applied to the file (means extensions.lowerCase is in the

      *         default List or in the user defined extension List)

      */

     boolean filteredFileExtension( String fileName, List<String> userNonFilteredFileExtensions );

     /**

      * @param mavenResourcesExecution {@link MavenResourcesExecution}

      * @throws MavenFilteringException

      */

     void filterResources( MavenResourcesExecution mavenResourcesExecution )

         throws MavenFilteringException;

 }