org.apache.maven.shared.filtering
Interface MavenResourcesFiltering

All Known Implementing Classes:
DefaultMavenResourcesFiltering

public interface MavenResourcesFiltering

Author:
Olivier Lamy

Method Summary
 boolean filteredFileExtension(String fileName, List<String> userNonFilteredFileExtensions)
           
 void filterResources(List<Resource> resources, File outputDirectory, MavenProject mavenProject, String encoding, List<String> fileFilters, List<String> nonFilteredFileExtensions, MavenSession mavenSession)
          Deprecated. use filterResources(MavenResourcesExecution)
 void filterResources(List<Resource> resources, File outputDirectory, String encoding, List<FileUtils.FilterWrapper> filterWrappers, File resourcesBaseDirectory, List<String> nonFilteredFileExtensions)
          Deprecated. use filterResources(MavenResourcesExecution)
 void filterResources(MavenResourcesExecution mavenResourcesExecution)
           
 List getDefaultNonFilteredFileExtensions()
          return the List of the non filtered extensions (jpg,jpeg,gif,bmp,png)
 

Method Detail

filterResources

void filterResources(List<Resource> resources,
                     File outputDirectory,
                     MavenProject mavenProject,
                     String encoding,
                     List<String> fileFilters,
                     List<String> nonFilteredFileExtensions,
                     MavenSession mavenSession)
                     throws MavenFilteringException
Deprecated. use filterResources(MavenResourcesExecution)

Parameters:
resources - List of Resource
outputDirectory - parent destination directory
mavenProject - the maven project
encoding - encoding to use for writing files
fileFilters - List of String which are path to a Property file
nonFilteredFileExtensions - List of String for non filtered file extensions
mavenSession - Can include executionProperties that will be used for filtering
Throws:
MavenFilteringException

filterResources

void filterResources(List<Resource> resources,
                     File outputDirectory,
                     String encoding,
                     List<FileUtils.FilterWrapper> filterWrappers,
                     File resourcesBaseDirectory,
                     List<String> nonFilteredFileExtensions)
                     throws MavenFilteringException
Deprecated. use filterResources(MavenResourcesExecution)

Parameters:
resources - List of Resource
outputDirectory - parent destination directory
encoding - encoding to use for writing files
filterWrappers - List of FileUtils.FilterWrapper
resourcesBaseDirectory - baseDirectory of resources
nonFilteredFileExtensions - List of String for non filtered file extensions
Throws:
MavenFilteringException

getDefaultNonFilteredFileExtensions

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

Returns:
List of String

filteredFileExtension

boolean filteredFileExtension(String fileName,
                              List<String> userNonFilteredFileExtensions)
Parameters:
fileName - the file name
userNonFilteredFileExtensions - an extra list of file extensions
Returns:
true if filtering can be applied to the file (means extensions.lowerCase is in the default List or in the user defined extension List)

filterResources

void filterResources(MavenResourcesExecution mavenResourcesExecution)
                     throws MavenFilteringException
Parameters:
mavenResourcesExecution - MavenResourcesExecution
Throws:
MavenFilteringException


Copyright © 2002-2012 The Apache Software Foundation. All Rights Reserved.