org.apache.maven.shared.filtering

Interface MavenFileFilter

All Known Implementing Classes:

DefaultMavenFileFilter

public interface MavenFileFilter

Author:

Olivier Lamy

Method Summary

Methods

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

Method Detail

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

Will copy a file with some filtering using defaultFilterWrappers.

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:

getDefaultFilterWrappers(MavenProject, List, boolean, MavenSession)

copyFile

void copyFile(MavenFileFilterRequest mavenFileFilterRequest)
              throws MavenFilteringException

Parameters:

mavenFileFilterRequest -

Throws:

MavenFilteringException

Since:

1.0-beta-3

copyFile

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

Parameters:

from -

to -

filtering -

filterWrappers - List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

copyFile

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

Parameters:

from -

to -

filtering -

filterWrappers -

encoding -

overwrite -

Throws:

MavenFilteringException

Since:

1.0-beta-2

getDefaultFilterWrappers

List<org.codehaus.plexus.util.FileUtils.FilterWrapper> getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject,
                                                                              List<String> filters,
                                                                              boolean escapedBackslashesInFilePath,
                                                                              org.apache.maven.execution.MavenSession mavenSession)
                                                                                throws MavenFilteringException

Deprecated. use getDefaultFilterWrappers(MavenProject, List, boolean, MavenSession, MavenResourcesExecution)

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.

Parameters:

mavenProject -

filters - List of properties file

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

getDefaultFilterWrappers

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

Parameters:

mavenProject -

filters -

escapedBackslashesInFilePath -

mavenSession -

mavenResourcesExecution -

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

Since:

1.0-beta-2

getDefaultFilterWrappers

List<org.codehaus.plexus.util.FileUtils.FilterWrapper> getDefaultFilterWrappers(AbstractMavenFilteringRequest request)
                                                                                throws MavenFilteringException

Parameters:

request -

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

Since:

1.0-beta-3