org.apache.maven.shared.filtering

Interface MavenFileFilter

All Known Implementing Classes:

DefaultMavenFileFilter

public interface MavenFileFilter

Version:

$Id: MavenFileFilter.java 806295 2009-08-20 18:37:09Z jdcasey $

Author:

olamy

Method Summary

Modifier and Type	Method and Description
void	copyFile(java.io.File from, java.io.File to, boolean filtering, java.util.List filterWrappers, java.lang.String encoding)
void	copyFile(java.io.File from, java.io.File to, boolean filtering, java.util.List filterWrappers, java.lang.String encoding, boolean overwrite)
void	copyFile(java.io.File from, java.io.File to, boolean filtering, org.apache.maven.project.MavenProject mavenProject, java.util.List filters, boolean escapedBackslashesInFilePath, java.lang.String encoding, org.apache.maven.execution.MavenSession mavenSession) Will copy a file with some filtering using defaultFilterWrappers
void	copyFile(MavenFileFilterRequest mavenFileFilterRequest)
java.util.List	getDefaultFilterWrappers(AbstractMavenFilteringRequest request)
java.util.List	getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject, java.util.List filters, boolean escapedBackslashesInFilePath, org.apache.maven.execution.MavenSession mavenSession) Deprecated. use getDefaultFilterWrappers(MavenProject, List, boolean, MavenSession, MavenResourcesExecution)
java.util.List	getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject, java.util.List filters, boolean escapedBackslashesInFilePath, org.apache.maven.execution.MavenSession mavenSession, MavenResourcesExecution mavenResourcesExecution)

Method Detail

copyFile

void copyFile(java.io.File from,
              java.io.File to,
              boolean filtering,
              org.apache.maven.project.MavenProject mavenProject,
              java.util.List filters,
              boolean escapedBackslashesInFilePath,
              java.lang.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(java.io.File from,
              java.io.File to,
              boolean filtering,
              java.util.List filterWrappers,
              java.lang.String encoding)
       throws MavenFilteringException

Parameters:

from -

to -

filtering -

filterWrappers - List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

copyFile

void copyFile(java.io.File from,
              java.io.File to,
              boolean filtering,
              java.util.List filterWrappers,
              java.lang.String encoding,
              boolean overwrite)
       throws MavenFilteringException

Parameters:

from -

to -

filtering -

filterWrappers -

encoding -

overwrite -

Throws:

MavenFilteringException

Since:

1.0-beta-2

getDefaultFilterWrappers

java.util.List getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject,
                                        java.util.List 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 si now deprecated and no escape mechanism will be use

Parameters:

mavenProject -

filters - List of properties file

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

getDefaultFilterWrappers

java.util.List getDefaultFilterWrappers(org.apache.maven.project.MavenProject mavenProject,
                                        java.util.List 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

java.util.List getDefaultFilterWrappers(AbstractMavenFilteringRequest request)
                                 throws MavenFilteringException

Parameters:

request -

Returns:

List of FileUtils.FilterWrapper

Throws:

MavenFilteringException

Since:

1.0-beta-3