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

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"

DefaultMavenFileFilter

public DefaultMavenFileFilter()

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:

DefaultFilterInfo.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: DefaultFilterInfo

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 DefaultFilterInfo

filters - List of properties file

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

See Also:

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

getDefaultFilterWrappers

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

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

getDefaultFilterWrappers

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

Specified by:

getDefaultFilterWrappers in interface DefaultFilterInfo

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException