Package org.apache.maven.shared.filtering

Class DefaultMavenFileFilter

java.lang.Object

org.apache.maven.shared.filtering.DefaultMavenFileFilter

All Implemented Interfaces:

DefaultFilterInfo, MavenFileFilter

@Singleton
@Named
public class DefaultMavenFileFilter
extends Object
implements MavenFileFilter

Author:

Olivier Lamy

Constructor Summary

Constructors

Constructor	Description
DefaultMavenFileFilter(org.sonatype.plexus.build.incremental.BuildContext buildContext)

Method Summary

Modifier and Type	Method	Description
void	copyFile(File from, File to, boolean filtering, List<FilterWrapper> filterWrappers, String encoding)
void	copyFile(File from, File to, boolean filtering, List<FilterWrapper> filterWrappers, String encoding, boolean overwrite)	Deprecated.
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)	Will copy a file with some filtering using defaultFilterWrappers.
void	copyFile(MavenFileFilterRequest mavenFileFilterRequest)
List<FilterWrapper>	getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, org.apache.maven.execution.MavenSession mavenSession, MavenResourcesExecution mavenResourcesExecution)
List<FilterWrapper>	getDefaultFilterWrappers(AbstractMavenFilteringRequest request)
protected org.slf4j.Logger	getLogger()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDefaultFilterWrappers, getDefaultFilterWrappers

Constructor Detail

DefaultMavenFileFilter

@Inject
public DefaultMavenFileFilter(org.sonatype.plexus.build.incremental.BuildContext buildContext)

Method Detail

copyFile

public 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

Description copied from interface: MavenFileFilter

Will copy a file with some filtering using defaultFilterWrappers.

Specified by:

copyFile in interface MavenFileFilter

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

public void copyFile(MavenFileFilterRequest mavenFileFilterRequest)
              throws MavenFilteringException

Specified by:

copyFile in interface MavenFileFilter

Parameters:

mavenFileFilterRequest - the request

Throws:

MavenFilteringException - in case of failure.

copyFile

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

Specified by:

copyFile in interface MavenFileFilter

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
public void copyFile(File from,
                     File to,
                     boolean filtering,
                     List<FilterWrapper> filterWrappers,
                     String encoding,
                     boolean overwrite)
              throws MavenFilteringException

Deprecated.

Specified by:

copyFile in interface MavenFileFilter

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.

getLogger

protected org.slf4j.Logger getLogger()

getDefaultFilterWrappers

public List<FilterWrapper> getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject,
                                                    List<String> filters,
                                                    boolean escapedBackslashesInFilePath,
                                                    org.apache.maven.execution.MavenSession mavenSession,
                                                    MavenResourcesExecution mavenResourcesExecution)
                                             throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Parameters:

mavenProject - The maven project

filters - The filters to get

escapedBackslashesInFilePath - escape backslashes ?

mavenSession - The maven session

mavenResourcesExecution - The filtering configuration

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException - in case of failure.

getDefaultFilterWrappers

public List<FilterWrapper> getDefaultFilterWrappers(AbstractMavenFilteringRequest request)
                                             throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Parameters:

request - The filtering request

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException - in case of failure.