org.apache.maven.shared.filtering
Class DefaultMavenFileFilter

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.apache.maven.shared.filtering.DefaultMavenFileFilter

All Implemented Interfaces:

MavenFileFilter, org.codehaus.plexus.logging.LogEnabled

public class DefaultMavenFileFilter
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements MavenFileFilter

Author:

Olivier Lamy

Plexus component:

role:

"org.apache.maven.shared.filtering.MavenFileFilter"

role-hint:

"default"

Constructor Summary

DefaultMavenFileFilter()

Method Summary

void	copyFile(File from, File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers, String encoding)
void	copyFile(File from, File to, boolean filtering, List<FileUtils.FilterWrapper> filterWrappers, String encoding, boolean overwrite)
void	copyFile(File from, File to, boolean filtering, MavenProject mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, String encoding, MavenSession mavenSession) Will copy a file with some filtering using defaultFilterWrappers.
void	copyFile(MavenFileFilterRequest mavenFileFilterRequest)
List<FileUtils.FilterWrapper>	getDefaultFilterWrappers(AbstractMavenFilteringRequest req)
List<FileUtils.FilterWrapper>	getDefaultFilterWrappers(MavenProject mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, MavenSession mavenSession) Deprecated.
List<FileUtils.FilterWrapper>	getDefaultFilterWrappers(MavenProject mavenProject, List<String> filters, boolean escapedBackslashesInFilePath, MavenSession mavenSession, MavenResourcesExecution mavenResourcesExecution)
protected void	loadProperties(Properties filterProperties, List<String> propertiesFilePaths, Properties baseProps) protected only for testing reason !

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

Constructor Detail

DefaultMavenFileFilter

public DefaultMavenFileFilter()

Method Detail

copyFile

public void copyFile(File from,
                     File to,
                     boolean filtering,
                     MavenProject mavenProject,
                     List<String> filters,
                     boolean escapedBackslashesInFilePath,
                     String encoding,
                     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 filering

mavenProject - the mavenproject

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

Throws:

MavenFilteringException

See Also:

MavenFileFilter.getDefaultFilterWrappers(MavenProject, List, boolean, MavenSession)

copyFile

public void copyFile(MavenFileFilterRequest mavenFileFilterRequest)
              throws MavenFilteringException

Specified by:

copyFile in interface MavenFileFilter

Throws:

MavenFilteringException

copyFile

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

Specified by:

copyFile in interface MavenFileFilter

filterWrappers - List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

copyFile

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

Specified by:

copyFile in interface MavenFileFilter

Throws:

MavenFilteringException

getDefaultFilterWrappers

public List<FileUtils.FilterWrapper> getDefaultFilterWrappers(MavenProject mavenProject,
                                                              List<String> filters,
                                                              boolean escapedBackslashesInFilePath,
                                                              MavenSession mavenSession)
                                                       throws MavenFilteringException

Deprecated.

Description copied from interface: MavenFileFilter

Will return the default FileUtils.FilterWrappers.

• interpolate with token ${} and values from sysProps, project.properties, filters and project filters.
• interpolate with token @ @ and values from sysProps, project.properties, filters and project filters.
• interpolate with token ${} and values from mavenProject interpolation.
• interpolation with token @ @ and values from mavenProject interpolation

This method is now deprecated and no escape mechanism will be used.

Specified by:

getDefaultFilterWrappers in interface MavenFileFilter

filters - List of properties file

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

See Also:

MavenFileFilter.getDefaultFilterWrappers(org.apache.maven.project.MavenProject, java.util.List, boolean, org.apache.maven.execution.MavenSession)

getDefaultFilterWrappers

public List<FileUtils.FilterWrapper> getDefaultFilterWrappers(MavenProject mavenProject,
                                                              List<String> filters,
                                                              boolean escapedBackslashesInFilePath,
                                                              MavenSession mavenSession,
                                                              MavenResourcesExecution mavenResourcesExecution)
                                                       throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface MavenFileFilter

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

getDefaultFilterWrappers

public List<FileUtils.FilterWrapper> getDefaultFilterWrappers(AbstractMavenFilteringRequest req)
                                                       throws MavenFilteringException

Specified by:

getDefaultFilterWrappers in interface MavenFileFilter

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

loadProperties

protected void loadProperties(Properties filterProperties,
                              List<String> propertiesFilePaths,
                              Properties baseProps)
                       throws MavenFilteringException

protected only for testing reason !

Throws:

MavenFilteringException