Package org.apache.maven.shared.filtering

Interface MavenFileFilter

All Superinterfaces:

DefaultFilterInfo

All Known Implementing Classes:

DefaultMavenFileFilter

public interface MavenFileFilter
extends DefaultFilterInfo

Author:

Olivier Lamy

Method Summary

Modifier and Type	Method	Description
void	copyFile(Path from, Path to, boolean filtering, List<FilterWrapper> filterWrappers, String encoding)
void	copyFile(Path from, Path to, boolean filtering, org.apache.maven.api.Project mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, String encoding, org.apache.maven.api.Session mavenSession)	Will copy a file with some filtering using defaultFilterWrappers.
void	copyFile(MavenFileFilterRequest mavenFileFilterRequest)

Methods inherited from interface org.apache.maven.shared.filtering.DefaultFilterInfo

getDefaultFilterWrappers, getDefaultFilterWrappers

Method Details

copyFile

void copyFile(Path from,
 Path to,
 boolean filtering,
 org.apache.maven.api.Project mavenProject,
 List<String> filters,
 boolean escapedBackslashesInFilePath,
 String encoding,
 org.apache.maven.api.Session mavenSession)
       throws MavenFilteringException

Will copy a file with some filtering using defaultFilterWrappers.

Parameters:

from - file to copy/filter

to - destination file

filtering - enable or not filtering

mavenProject - Project

filters - List of String which are path to a Property file

escapedBackslashesInFilePath - escape backslashes in file path.

encoding - The encoding which is used during the filtering process.

mavenSession - Session

Throws:

MavenFilteringException - in case of failure.

See Also:

• DefaultFilterInfo.getDefaultFilterWrappers(Project, List, boolean, Session, MavenResourcesExecution)

copyFile

void copyFile(MavenFileFilterRequest mavenFileFilterRequest)
       throws MavenFilteringException

Parameters:

mavenFileFilterRequest - the request

Throws:

MavenFilteringException - in case of failure.

Since:

1.0-beta-3

copyFile

void copyFile(Path from,
 Path to,
 boolean filtering,
 List<FilterWrapper> filterWrappers,
 String encoding)
       throws MavenFilteringException

Parameters:

from - The source file

to - The target file

filtering - true to apply filtering

filterWrappers - List of FileUtils.FilterWrapper

encoding - The encoding used during the filtering.

Throws:

MavenFilteringException - In case of an error.