org.apache.maven.shared.filtering

Class DefaultMavenFileFilter

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.shared.filtering.DefaultMavenFileFilter

All Implemented Interfaces:

DefaultFilterInfo, MavenFileFilter, org.codehaus.plexus.logging.LogEnabled

@Component(role=MavenFileFilter.class,
           hint="default")
public class DefaultMavenFileFilter
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements MavenFileFilter

Author:

Olivier Lamy

Constructor Summary

Constructors

Constructor and Description
DefaultMavenFileFilter()

Method Summary

Modifier and Type	Method and Description
void	copyFile(File from, File to, boolean filtering, List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> filterWrappers, String encoding)
void	copyFile(File from, File to, boolean filtering, List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> filterWrappers, String encoding, boolean overwrite)
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<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper>	getDefaultFilterWrappers(AbstractMavenFilteringRequest req)
List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper>	getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, org.apache.maven.execution.MavenSession mavenSession, MavenResourcesExecution mavenResourcesExecution)

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

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

public DefaultMavenFileFilter()

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

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:

#getDefaultFilterWrappers(MavenProject, List, boolean, MavenSession)

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<org.apache.maven.shared.utils.io.FileUtils.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

public void copyFile(File from,
                     File to,
                     boolean filtering,
                     List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> filterWrappers,
                     String encoding,
                     boolean overwrite)
              throws MavenFilteringException

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 - Overwrite to file ?

Throws:

MavenFilteringException - In case of an error.

getDefaultFilterWrappers

@Nonnull
public List<org.apache.maven.shared.utils.io.FileUtils.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

@Nonnull
public List<org.apache.maven.shared.utils.io.FileUtils.FilterWrapper> getDefaultFilterWrappers(AbstractMavenFilteringRequest req)
                                                                                                 throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Parameters:

req - The filtering request

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException - in case of failure.