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(File from, File to, boolean filtering, List<FilterWrapper> filterWrappers, String encoding)	Deprecated. use copyFile(File, File, boolean, List, String, ChangeDetection) instead
void	copyFile(File from, File to, boolean filtering, List<FilterWrapper> filterWrappers, String encoding, boolean overwrite)	Deprecated. use copyFile(File, File, boolean, List, String, ChangeDetection) instead
void	copyFile(File from, File to, boolean filtering, List<FilterWrapper> filterWrappers, String encoding, ChangeDetection changeDetection)
void	copyFile(File from, File to, boolean filtering, org.apache.maven.project.MavenProject mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, String encoding, org.apache.maven.execution.MavenSession mavenSession)	Deprecated. Use copyFile(File, File, boolean, MavenProject, List, boolean, String, MavenSession, ChangeDetection) instead.
void	copyFile(File from, File to, boolean filtering, org.apache.maven.project.MavenProject mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, String encoding, org.apache.maven.execution.MavenSession mavenSession, ChangeDetection changeDetection)	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(File from,
 File to,
 boolean filtering,
 org.apache.maven.project.MavenProject mavenProject,
 List<String> filters,
 boolean escapedBackslashesInFilePath,
 String encoding,
 org.apache.maven.execution.MavenSession mavenSession)
       throws MavenFilteringException

Deprecated.

Use copyFile(File, File, boolean, MavenProject, List, boolean, String, MavenSession, ChangeDetection) instead.

Will copy a file with some filtering using defaultFilterWrappers.

Parameters:

from - file to copy/filter

to - destination file

filtering - enable or not filtering

mavenProject - MavenProject

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 - MavenSession

Throws:

MavenFilteringException - in case of failure.

See Also:

• DefaultFilterInfo.getDefaultFilterWrappers(MavenProject, List, boolean,MavenSession, MavenResourcesExecution)

copyFile

void copyFile(File from,
 File to,
 boolean filtering,
 org.apache.maven.project.MavenProject mavenProject,
 List<String> filters,
 boolean escapedBackslashesInFilePath,
 String encoding,
 org.apache.maven.execution.MavenSession mavenSession,
 ChangeDetection changeDetection)
       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 - MavenProject

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 - MavenSession

Throws:

MavenFilteringException - in case of failure.

Since:

3.5.0

See Also:

• DefaultFilterInfo.getDefaultFilterWrappers(MavenProject, List, boolean,MavenSession, MavenResourcesExecution)

copyFile

void copyFile(MavenFileFilterRequest mavenFileFilterRequest)
       throws MavenFilteringException

Parameters:

mavenFileFilterRequest - the request

Throws:

MavenFilteringException - in case of failure.

Since:

1.0-beta-3

copyFile

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

Deprecated.

use copyFile(File, File, boolean, List, String, ChangeDetection) instead

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.

copyFile

@Deprecated
void copyFile(File from,
 File to,
 boolean filtering,
 List<FilterWrapper> filterWrappers,
 String encoding,
 boolean overwrite)
       throws MavenFilteringException

Deprecated.

use copyFile(File, File, boolean, List, String, ChangeDetection) instead

Parameters:

from - The source file

to - The destination file

filtering - true to apply filtering

filterWrappers - The filters to be applied.

encoding - The encoding to use

overwrite - unused

Throws:

MavenFilteringException - In case of an error.

Since:

1.0-beta-2

copyFile

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

Parameters:

from - The source file

to - The destination file

filtering - true to apply filtering

filterWrappers - The filters to be applied.

encoding - The encoding to use

changeDetection - The change detection mode to use to determine if the file should be copied/filtered.

Throws:

MavenFilteringException - In case of an error.

Since:

3.5.0