org.apache.maven.shared.filtering

Class MavenResourcesExecution

java.lang.Object

org.apache.maven.shared.filtering.AbstractMavenFilteringRequest

org.apache.maven.shared.filtering.MavenResourcesExecution

public class MavenResourcesExecution
extends AbstractMavenFilteringRequest

A bean to configure a resources filtering execution.

Author:

Olivier Lamy

Constructor Summary

Constructors

Constructor and Description
MavenResourcesExecution()
MavenResourcesExecution(List<org.apache.maven.model.Resource> resources, File outputDirectory, org.apache.maven.project.MavenProject mavenProject, String encoding, List fileFilters, List<String> nonFilteredFileExtensions, org.apache.maven.execution.MavenSession mavenSession) As we use a Maven project useDefaultFilterWrappers will be set to true.
MavenResourcesExecution(List<org.apache.maven.model.Resource> resources, File outputDirectory, String encoding, List<org.codehaus.plexus.util.FileUtils.FilterWrapper> filterWrappers, File resourcesBaseDirectory, List<String> nonFilteredFileExtensions)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFilerWrapper(org.codehaus.plexus.interpolation.ValueSource valueSource) Deprecated. This doesn't support escaping use addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)
void	addFilerWrapper(org.codehaus.plexus.interpolation.ValueSource valueSource, String startRegExp, String endRegExp, String startToken, String endToken) Deprecated. This doesn't support escaping use addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)
void	addFilerWrapperWithEscaping(org.codehaus.plexus.interpolation.ValueSource valueSource, String startExp, String endExp, String escapeString) Deprecated. This doesn't support escaping use addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)
void	addFilerWrapperWithEscaping(org.codehaus.plexus.interpolation.ValueSource valueSource, String startExp, String endExp, String escapeString, boolean supportMultiLineFiltering)
void	addFilterWrapper(org.codehaus.plexus.util.FileUtils.FilterWrapper filterWrapper)
MavenResourcesExecution	copyOf()
List<org.codehaus.plexus.util.FileUtils.FilterWrapper>	getFilterWrappers()
List<String>	getNonFilteredFileExtensions()
File	getOutputDirectory()
List<org.apache.maven.model.Resource>	getResources()
File	getResourcesBaseDirectory()
boolean	isIncludeEmptyDirs() Copy any empty directories included in the Resources.
boolean	isOverwrite() Overwrite existing files even if the destination files are newer.
boolean	isSupportMultiLineFiltering()
boolean	isUseDefaultFilterWrappers()
void	setFilterWrappers(List<org.codehaus.plexus.util.FileUtils.FilterWrapper> filterWrappers)
void	setIncludeEmptyDirs(boolean includeEmptyDirs) Copy any empty directories included in the Resources.
void	setNonFilteredFileExtensions(List<String> nonFilteredFileExtensions)
void	setOutputDirectory(File outputDirectory)
void	setOverwrite(boolean overwrite) Overwrite existing files even if the destination files are newer.
void	setResources(List<org.apache.maven.model.Resource> resources)
void	setResourcesBaseDirectory(File resourcesBaseDirectory)
void	setSupportMultiLineFiltering(boolean supportMultiLineFiltering)
void	setUseDefaultFilterWrappers(boolean useDefaultFilterWrappers)

Methods inherited from class org.apache.maven.shared.filtering.AbstractMavenFilteringRequest

getAdditionalProperties, getDelimiters, getEncoding, getEscapeString, getFileFilters, getFilters, getMavenProject, getMavenSession, getProjectStartExpressions, isEscapedBackslashesInFilePath, isEscapeWindowsPaths, isInjectProjectBuildFilters, setAdditionalProperties, setDelimiters, setEncoding, setEscapedBackslashesInFilePath, setEscapeString, setEscapeWindowsPaths, setFileFilters, setFilters, setInjectProjectBuildFilters, setMavenProject, setMavenSession, setProjectStartExpressions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MavenResourcesExecution

public MavenResourcesExecution()

MavenResourcesExecution

public MavenResourcesExecution(List<org.apache.maven.model.Resource> resources,
                       File outputDirectory,
                       org.apache.maven.project.MavenProject mavenProject,
                       String encoding,
                       List fileFilters,
                       List<String> nonFilteredFileExtensions,
                       org.apache.maven.execution.MavenSession mavenSession)

As we use a Maven project useDefaultFilterWrappers will be set to true.

Parameters:

resources -

outputDirectory -

mavenProject -

encoding -

fileFilters -

nonFilteredFileExtensions -

mavenSession -

MavenResourcesExecution

public MavenResourcesExecution(List<org.apache.maven.model.Resource> resources,
                       File outputDirectory,
                       String encoding,
                       List<org.codehaus.plexus.util.FileUtils.FilterWrapper> filterWrappers,
                       File resourcesBaseDirectory,
                       List<String> nonFilteredFileExtensions)

Method Detail

getResources

public List<org.apache.maven.model.Resource> getResources()

Returns:

List of Resource

setResources

public void setResources(List<org.apache.maven.model.Resource> resources)

Parameters:

resources - List of Resource

getOutputDirectory

public File getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

getNonFilteredFileExtensions

public List<String> getNonFilteredFileExtensions()

Returns:

List of String file extensions to not filter

setNonFilteredFileExtensions

public void setNonFilteredFileExtensions(List<String> nonFilteredFileExtensions)

Parameters:

nonFilteredFileExtensions - List of String file extensions to not filter

getFilterWrappers

public List<org.codehaus.plexus.util.FileUtils.FilterWrapper> getFilterWrappers()

Returns:

List of FileUtils.FilterWrapper

setFilterWrappers

public void setFilterWrappers(List<org.codehaus.plexus.util.FileUtils.FilterWrapper> filterWrappers)

Parameters:

filterWrappers - List of FileUtils.FilterWrapper

addFilterWrapper

public void addFilterWrapper(org.codehaus.plexus.util.FileUtils.FilterWrapper filterWrapper)

addFilerWrapper

public void addFilerWrapper(org.codehaus.plexus.interpolation.ValueSource valueSource)

Deprecated. This doesn't support escaping use addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)

Helper to add FileUtils.FilterWrapper, will RegexBasedInterpolator with default regex Exp ${ } and InterpolatorFilterReaderLineEnding with defaultTokens ${ }.

Parameters:

valueSource -

addFilerWrapper

public void addFilerWrapper(org.codehaus.plexus.interpolation.ValueSource valueSource,
                   String startRegExp,
                   String endRegExp,
                   String startToken,
                   String endToken)

Deprecated. This doesn't support escaping use addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)

Parameters:

valueSource -

startRegExp -

endRegExp -

startToken -

endToken -

addFilerWrapperWithEscaping

public void addFilerWrapperWithEscaping(org.codehaus.plexus.interpolation.ValueSource valueSource,
                               String startExp,
                               String endExp,
                               String escapeString)

Deprecated. This doesn't support escaping use addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)

Parameters:

valueSource -

startExp - start token like ${

endExp - endToken }

escapeString -

Since:

1.0-beta-2

addFilerWrapperWithEscaping

public void addFilerWrapperWithEscaping(org.codehaus.plexus.interpolation.ValueSource valueSource,
                               String startExp,
                               String endExp,
                               String escapeString,
                               boolean supportMultiLineFiltering)

Parameters:

valueSource -

startExp - start token like ${

endExp - endToken }

escapeString -

supportMultiLineFiltering - do we support or use filtering on multi lines with start and endtoken on multi lines

Since:

1.0

getResourcesBaseDirectory

public File getResourcesBaseDirectory()

setResourcesBaseDirectory

public void setResourcesBaseDirectory(File resourcesBaseDirectory)

isUseDefaultFilterWrappers

public boolean isUseDefaultFilterWrappers()

setUseDefaultFilterWrappers

public void setUseDefaultFilterWrappers(boolean useDefaultFilterWrappers)

isOverwrite

public boolean isOverwrite()

Overwrite existing files even if the destination files are newer.

Since:

1.0-beta-2

setOverwrite

public void setOverwrite(boolean overwrite)

Overwrite existing files even if the destination files are newer.

Parameters:

overwrite -

Since:

1.0-beta-2

isIncludeEmptyDirs

public boolean isIncludeEmptyDirs()

Copy any empty directories included in the Resources.

Since:

1.0-beta-2

setIncludeEmptyDirs

public void setIncludeEmptyDirs(boolean includeEmptyDirs)

Copy any empty directories included in the Resources.

Parameters:

includeEmptyDirs -

Since:

1.0-beta-2

copyOf

public MavenResourcesExecution copyOf()

isSupportMultiLineFiltering

public boolean isSupportMultiLineFiltering()

Overrides:

isSupportMultiLineFiltering in class AbstractMavenFilteringRequest

setSupportMultiLineFiltering

public void setSupportMultiLineFiltering(boolean supportMultiLineFiltering)

Overrides:

setSupportMultiLineFiltering in class AbstractMavenFilteringRequest