org.apache.maven.shared.filtering
Interface MavenResourcesFiltering

All Known Implementing Classes:
DefaultMavenResourcesFiltering

public interface MavenResourcesFiltering

Version:
$Id: MavenResourcesFiltering.java 682187 2008-08-03 16:03:28Z dennisl $
Author:
olamy

Method Summary
 boolean filteredFileExtension(String fileName, List userNonFilteredFileExtensions)
           
 void filterResources(List resources, File outputDirectory, org.apache.maven.project.MavenProject mavenProject, String encoding, List fileFilters, List nonFilteredFileExtensions, org.apache.maven.execution.MavenSession mavenSession)
           
 void filterResources(List resources, File outputDirectory, String encoding, List filterWrappers, File resourcesBaseDirectory, List nonFilteredFileExtensions)
           
 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 resources,
                     File outputDirectory,
                     org.apache.maven.project.MavenProject mavenProject,
                     String encoding,
                     List fileFilters,
                     List nonFilteredFileExtensions,
                     org.apache.maven.execution.MavenSession mavenSession)
                     throws MavenFilteringException
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 resources,
                     File outputDirectory,
                     String encoding,
                     List filterWrappers,
                     File resourcesBaseDirectory,
                     List nonFilteredFileExtensions)
                     throws MavenFilteringException
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 userNonFilteredFileExtensions)
Parameters:
fileName - the file name
userNonFilteredFileExtensions - an extra list of file extensions
Returns:
true if filtering can be apply 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 -
Throws:
MavenFilteringException


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.