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.
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
addDefaultExcludes
By default files like.gitignore
,.cvsignore
etc.private java.lang.String
encoding
private boolean
filterFilenames
private java.util.List<FilterWrapper>
filterWrappers
private boolean
flatten
Write resources to a flattened directory structure.private boolean
includeEmptyDirs
Copy any empty directories included in the Resources.private java.util.List<java.lang.String>
nonFilteredFileExtensions
private java.io.File
outputDirectory
private boolean
overwrite
Overwrite existing files even if the destination files are newer.private java.lang.String
propertiesEncoding
private java.util.List<org.apache.maven.model.Resource>
resources
private java.io.File
resourcesBaseDirectory
private boolean
supportMultiLineFiltering
Do not stop trying to filter tokens when reaching EOL.private boolean
useDefaultFilterWrappers
-
Constructor Summary
Constructors Constructor Description MavenResourcesExecution()
Do nothing.MavenResourcesExecution(java.util.List<org.apache.maven.model.Resource> resources, java.io.File outputDirectory, java.lang.String encoding, java.util.List<FilterWrapper> filterWrappers, java.io.File resourcesBaseDirectory, java.util.List<java.lang.String> nonFilteredFileExtensions)
MavenResourcesExecution(java.util.List<org.apache.maven.model.Resource> resources, java.io.File outputDirectory, org.apache.maven.project.MavenProject mavenProject, java.lang.String encoding, java.util.List<java.lang.String> fileFilters, java.util.List<java.lang.String> nonFilteredFileExtensions, org.apache.maven.execution.MavenSession mavenSession)
As we use a Maven projectuseDefaultFilterWrappers
will be set totrue
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addFilerWrapperWithEscaping(org.codehaus.plexus.interpolation.ValueSource valueSource, java.lang.String startExp, java.lang.String endExp, java.lang.String escapeString, boolean multiLineFiltering)
void
addFilterWrapper(FilterWrapper filterWrapper)
private <T> java.util.List<T>
copyList(java.util.List<T> lst)
MavenResourcesExecution
copyOf()
java.lang.String
getEncoding()
Return the encoding.java.util.List<FilterWrapper>
getFilterWrappers()
java.util.List<java.lang.String>
getNonFilteredFileExtensions()
java.io.File
getOutputDirectory()
java.lang.String
getPropertiesEncoding()
Return the encoding of properties files.java.util.List<org.apache.maven.model.Resource>
getResources()
java.io.File
getResourcesBaseDirectory()
boolean
isAddDefaultExcludes()
boolean
isFilterFilenames()
boolean
isFlatten()
Write to flattened directory structure.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
setAddDefaultExcludes(boolean addDefaultExcludes)
void
setEncoding(java.lang.String encoding)
Set the value for encoding.void
setFilterFilenames(boolean filterFilenames)
void
setFilterWrappers(java.util.List<FilterWrapper> filterWrappers)
void
setFlatten(boolean flatten)
Write to flattened directory structure.void
setIncludeEmptyDirs(boolean includeEmptyDirs)
Copy any empty directories included in the Resources.void
setNonFilteredFileExtensions(java.util.List<java.lang.String> nonFilteredFileExtensions)
void
setOutputDirectory(java.io.File outputDirectory)
void
setOverwrite(boolean overwrite)
Overwrite existing files even if the destination files are newer.void
setPropertiesEncoding(java.lang.String propertiesEncoding)
Set the value for encoding of properties files.void
setResources(java.util.List<org.apache.maven.model.Resource> resources)
void
setResourcesBaseDirectory(java.io.File resourcesBaseDirectory)
void
setSupportMultiLineFiltering(boolean supportMultiLineFiltering)
void
setUseDefaultFilterWrappers(boolean useDefaultFilterWrappers)
-
Methods inherited from class org.apache.maven.shared.filtering.AbstractMavenFilteringRequest
getAdditionalProperties, getDelimiters, getEscapeString, getFileFilters, getFilters, getMavenProject, getMavenSession, getProjectStartExpressions, isEscapedBackslashesInFilePath, isEscapeWindowsPaths, isInjectProjectBuildFilters, setAdditionalProperties, setDelimiters, setDelimiters, setEscapedBackslashesInFilePath, setEscapeString, setEscapeWindowsPaths, setFileFilters, setFilters, setInjectProjectBuildFilters, setMavenProject, setMavenSession, setProjectStartExpressions
-
-
-
-
Field Detail
-
resources
private java.util.List<org.apache.maven.model.Resource> resources
-
outputDirectory
private java.io.File outputDirectory
-
nonFilteredFileExtensions
private java.util.List<java.lang.String> nonFilteredFileExtensions
-
filterWrappers
private java.util.List<FilterWrapper> filterWrappers
-
resourcesBaseDirectory
private java.io.File resourcesBaseDirectory
-
useDefaultFilterWrappers
private boolean useDefaultFilterWrappers
-
filterFilenames
private boolean filterFilenames
-
encoding
private java.lang.String encoding
-
propertiesEncoding
private java.lang.String propertiesEncoding
- Since:
- 3.2.0
-
addDefaultExcludes
private boolean addDefaultExcludes
By default files like.gitignore
,.cvsignore
etc. are excluded which means they will not being copied. If you need them for a particular reason you can do that by settings this tofalse
. This means all files like the following will be copied.- Misc: **/*~, **/#*#, **/.#*, **/%*%, **/._*
- CVS: **/CVS, **/CVS/**, **/.cvsignore
- RCS: **/RCS, **/RCS/**
- SCCS: **/SCCS, **/SCCS/**
- VSSercer: **/vssver.scc
- MKS: **/project.pj
- SVN: **/.svn, **/.svn/**
- GNU: **/.arch-ids, **/.arch-ids/**
- Bazaar: **/.bzr, **/.bzr/**
- SurroundSCM: **/.MySCMServerInfo
- Mac: **/.DS_Store
- Serena Dimension: **/.metadata, **/.metadata/**
- Mercurial: **/.hg, **/.hg/**, **/.hgignore,
- GIT: **/.git, **/.gitignore, **/.gitattributes, **/.git/**
- Bitkeeper: **/BitKeeper, **/BitKeeper/**, **/ChangeSet, **/ChangeSet/**
- Darcs: **/_darcs, **/_darcs/**, **/.darcsrepo, **/.darcsrepo/****/-darcs-backup*, **/.darcs-temp-mail
- Since:
- 3.1.0
-
overwrite
private boolean overwrite
Overwrite existing files even if the destination files are newer.false
by default.- Since:
- 1.0-beta-2
-
includeEmptyDirs
private boolean includeEmptyDirs
Copy any empty directories included in the Resources.- Since:
- 1.0-beta-2
-
supportMultiLineFiltering
private boolean supportMultiLineFiltering
Do not stop trying to filter tokens when reaching EOL.- Since:
- 1.0
-
flatten
private boolean flatten
Write resources to a flattened directory structure.
-
-
Constructor Detail
-
MavenResourcesExecution
public MavenResourcesExecution()
Do nothing.
-
MavenResourcesExecution
public MavenResourcesExecution(java.util.List<org.apache.maven.model.Resource> resources, java.io.File outputDirectory, org.apache.maven.project.MavenProject mavenProject, java.lang.String encoding, java.util.List<java.lang.String> fileFilters, java.util.List<java.lang.String> nonFilteredFileExtensions, org.apache.maven.execution.MavenSession mavenSession)
As we use a Maven projectuseDefaultFilterWrappers
will be set totrue
. TheuseDefaultExcludes
is set totrue
.- Parameters:
resources
- The list of resources.outputDirectory
- The output directory.mavenProject
- The maven project.encoding
- The given encoding.fileFilters
- The file filters.nonFilteredFileExtensions
- The extensions which should not being filtered.mavenSession
- The maven session.
-
MavenResourcesExecution
public MavenResourcesExecution(java.util.List<org.apache.maven.model.Resource> resources, java.io.File outputDirectory, java.lang.String encoding, java.util.List<FilterWrapper> filterWrappers, java.io.File resourcesBaseDirectory, java.util.List<java.lang.String> nonFilteredFileExtensions)
- Parameters:
resources
- The list of resources.outputDirectory
- The output directory.encoding
- The given encoding.filterWrappers
- The list of filter wrappers.resourcesBaseDirectory
- The resources base directory.nonFilteredFileExtensions
- The list of extensions which should not being filtered.
-
-
Method Detail
-
getEncoding
public java.lang.String getEncoding()
Return the encoding.- Returns:
- Current encoding.
-
setEncoding
public void setEncoding(java.lang.String encoding)
Set the value for encoding.- Parameters:
encoding
- Give the new value for encoding.
-
getPropertiesEncoding
public java.lang.String getPropertiesEncoding()
Return the encoding of properties files.- Returns:
- Current encoding of properties files.
- Since:
- 3.2.0
-
setPropertiesEncoding
public void setPropertiesEncoding(java.lang.String propertiesEncoding)
Set the value for encoding of properties files.- Parameters:
propertiesEncoding
- Give the new value for encoding of properties files.- Since:
- 3.2.0
-
getResources
public java.util.List<org.apache.maven.model.Resource> getResources()
- Returns:
- List of
Resource
-
setResources
public void setResources(java.util.List<org.apache.maven.model.Resource> resources)
- Parameters:
resources
- List ofResource
-
getOutputDirectory
public java.io.File getOutputDirectory()
- Returns:
- The output directory.
-
setOutputDirectory
public void setOutputDirectory(java.io.File outputDirectory)
- Parameters:
outputDirectory
- The output directory.
-
getNonFilteredFileExtensions
public java.util.List<java.lang.String> getNonFilteredFileExtensions()
- Returns:
- List of
String
file extensions not to filter
-
setNonFilteredFileExtensions
public void setNonFilteredFileExtensions(java.util.List<java.lang.String> nonFilteredFileExtensions)
- Parameters:
nonFilteredFileExtensions
- List ofString
file extensions to not filter
-
getFilterWrappers
public java.util.List<FilterWrapper> getFilterWrappers()
- Returns:
- List of
FilterWrapper
-
setFilterWrappers
public void setFilterWrappers(java.util.List<FilterWrapper> filterWrappers)
- Parameters:
filterWrappers
- List ofFilterWrapper
-
addFilterWrapper
public void addFilterWrapper(FilterWrapper filterWrapper)
- Parameters:
filterWrapper
- The filter wrapper which should be added.
-
addFilerWrapperWithEscaping
public void addFilerWrapperWithEscaping(org.codehaus.plexus.interpolation.ValueSource valueSource, java.lang.String startExp, java.lang.String endExp, java.lang.String escapeString, boolean multiLineFiltering)
- Parameters:
valueSource
-ValueSource
startExp
- start token like${
endExp
- endToken}
escapeString
- The escape string.multiLineFiltering
- do we support or use filtering on multi lines with start and endtoken on multi lines- Since:
- 1.0
-
getResourcesBaseDirectory
public java.io.File getResourcesBaseDirectory()
- Returns:
- The resource base directory.
-
setResourcesBaseDirectory
public void setResourcesBaseDirectory(java.io.File resourcesBaseDirectory)
- Parameters:
resourcesBaseDirectory
- Set the resource base directory.
-
isUseDefaultFilterWrappers
public boolean isUseDefaultFilterWrappers()
- Returns:
- use default filter wrapper
-
setUseDefaultFilterWrappers
public void setUseDefaultFilterWrappers(boolean useDefaultFilterWrappers)
- Parameters:
useDefaultFilterWrappers
-useDefaultFilterWrappers
-
isAddDefaultExcludes
public boolean isAddDefaultExcludes()
- Returns:
- add the default excludes.
-
setAddDefaultExcludes
public void setAddDefaultExcludes(boolean addDefaultExcludes)
- Parameters:
addDefaultExcludes
-addDefaultExcludes
-
isOverwrite
public boolean isOverwrite()
Overwrite existing files even if the destination files are newer.- Returns:
overwrite
- Since:
- 1.0-beta-2
-
setOverwrite
public void setOverwrite(boolean overwrite)
Overwrite existing files even if the destination files are newer.- Parameters:
overwrite
- overwrite true or false.- Since:
- 1.0-beta-2
-
isFlatten
public boolean isFlatten()
Write to flattened directory structure.- Returns:
flatten
-
setFlatten
public void setFlatten(boolean flatten)
Write to flattened directory structure.- Parameters:
flatten
- flatten true or false.
-
isIncludeEmptyDirs
public boolean isIncludeEmptyDirs()
Copy any empty directories included in the Resources.- Returns:
includeEmptyDirs
- Since:
- 1.0-beta-2
-
setIncludeEmptyDirs
public void setIncludeEmptyDirs(boolean includeEmptyDirs)
Copy any empty directories included in the Resources.- Parameters:
includeEmptyDirs
-true
to include empty directories, otherwisefalse
.- Since:
- 1.0-beta-2
-
isFilterFilenames
public boolean isFilterFilenames()
- Returns:
true
if filenames are filtered, otherwisefalse
- Since:
- 1.2
-
setFilterFilenames
public void setFilterFilenames(boolean filterFilenames)
- Parameters:
filterFilenames
-true
if filenames should be filtered, otherwisefalse
- Since:
- 1.2
-
copyOf
public MavenResourcesExecution copyOf()
- Returns:
MavenResourcesExecution
-
copyList
private <T> java.util.List<T> copyList(java.util.List<T> lst)
-
isSupportMultiLineFiltering
public boolean isSupportMultiLineFiltering()
- Overrides:
isSupportMultiLineFiltering
in classAbstractMavenFilteringRequest
- Returns:
- If support multiple line filtering is active or not.
-
setSupportMultiLineFiltering
public void setSupportMultiLineFiltering(boolean supportMultiLineFiltering)
- Overrides:
setSupportMultiLineFiltering
in classAbstractMavenFilteringRequest
- Parameters:
supportMultiLineFiltering
- activate or deactivate multiple line filtering support.
-
-