Class MavenResourcesExecution
java.lang.Object
org.apache.maven.shared.filtering.AbstractMavenFilteringRequest
org.apache.maven.shared.filtering.MavenResourcesExecution
A bean to configure a resources filtering execution.
- Author:
- Olivier Lamy
-
Constructor Summary
ConstructorDescriptionDo nothing.MavenResourcesExecution
(List<org.apache.maven.model.Resource> resources, File outputDirectory, String encoding, List<FilterWrapper> filterWrappers, File resourcesBaseDirectory, List<String> nonFilteredFileExtensions) MavenResourcesExecution
(List<org.apache.maven.model.Resource> resources, File outputDirectory, org.apache.maven.project.MavenProject mavenProject, String encoding, List<String> fileFilters, List<String> nonFilteredFileExtensions, org.apache.maven.execution.MavenSession mavenSession) As we use a Maven projectuseDefaultFilterWrappers
will be set totrue
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addFilerWrapperWithEscaping
(org.codehaus.plexus.interpolation.ValueSource valueSource, String startExp, String endExp, String escapeString, boolean multiLineFiltering) void
addFilterWrapper
(FilterWrapper filterWrapper) copyOf()
Return the encoding.Return the encoding of properties files.List
<org.apache.maven.model.Resource> boolean
boolean
boolean
Write to flattened directory structure.boolean
Copy any empty directories included in the Resources.boolean
Overwrite existing files even if the destination files are newer.boolean
boolean
void
setAddDefaultExcludes
(boolean addDefaultExcludes) void
setEncoding
(String encoding) Set the value for encoding.void
setFilterFilenames
(boolean filterFilenames) void
setFilterWrappers
(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
(List<String> nonFilteredFileExtensions) void
setOutputDirectory
(File outputDirectory) void
setOverwrite
(boolean overwrite) Overwrite existing files even if the destination files are newer.void
setPropertiesEncoding
(String propertiesEncoding) Set the value for encoding of properties files.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, getEscapeString, getFileFilters, getFilters, getMavenProject, getMavenSession, getProjectStartExpressions, isEscapedBackslashesInFilePath, isEscapeWindowsPaths, isInjectProjectBuildFilters, setAdditionalProperties, setDelimiters, setDelimiters, setEscapedBackslashesInFilePath, setEscapeString, setEscapeWindowsPaths, setFileFilters, setFilters, setInjectProjectBuildFilters, setMavenProject, setMavenSession, setProjectStartExpressions
-
Constructor Details
-
MavenResourcesExecution
public MavenResourcesExecution()Do nothing. -
MavenResourcesExecution
public MavenResourcesExecution(List<org.apache.maven.model.Resource> resources, File outputDirectory, org.apache.maven.project.MavenProject mavenProject, String encoding, List<String> fileFilters, List<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(List<org.apache.maven.model.Resource> resources, File outputDirectory, String encoding, List<FilterWrapper> filterWrappers, File resourcesBaseDirectory, List<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 Details
-
getEncoding
Return the encoding.- Returns:
- Current encoding.
-
setEncoding
Set the value for encoding.- Parameters:
encoding
- Give the new value for encoding.
-
getPropertiesEncoding
Return the encoding of properties files.- Returns:
- Current encoding of properties files.
- Since:
- 3.2.0
-
setPropertiesEncoding
Set the value for encoding of properties files.- Parameters:
propertiesEncoding
- Give the new value for encoding of properties files.- Since:
- 3.2.0
-
getResources
- Returns:
- List of
Resource
-
setResources
- Parameters:
resources
- List ofResource
-
getOutputDirectory
- Returns:
- The output directory.
-
setOutputDirectory
- Parameters:
outputDirectory
- The output directory.
-
getNonFilteredFileExtensions
- Returns:
- List of
String
file extensions not to filter
-
setNonFilteredFileExtensions
- Parameters:
nonFilteredFileExtensions
- List ofString
file extensions to not filter
-
getFilterWrappers
- Returns:
- List of
FilterWrapper
-
setFilterWrappers
- Parameters:
filterWrappers
- List ofFilterWrapper
-
addFilerWrapperWithEscaping
public void addFilerWrapperWithEscaping(org.codehaus.plexus.interpolation.ValueSource valueSource, String startExp, String endExp, 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
- Returns:
- The resource base directory.
-
setResourcesBaseDirectory
- 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
- Returns:
MavenResourcesExecution
-
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.
-