Class AbstractMavenFilteringRequest
java.lang.Object
org.apache.maven.shared.filtering.AbstractMavenFilteringRequest
- Direct Known Subclasses:
MavenFileFilterRequest
,MavenReaderFilterRequest
,MavenResourcesExecution
- Since:
- 1.0-beta-3
-
Constructor Summary
ModifierConstructorDescriptionprotected
Create instance.protected
AbstractMavenFilteringRequest
(org.apache.maven.project.MavenProject mavenProject, List<String> filters, org.apache.maven.execution.MavenSession mavenSession) Create instance with given parameters -
Method Summary
Modifier and TypeMethodDescriptionSeedelimiters
for more information and default values.Alias forgetFilters()
.The list of filters.org.apache.maven.project.MavenProject
org.apache.maven.execution.MavenSession
boolean
Alias forisEscapeWindowsPaths()
boolean
boolean
boolean
void
setAdditionalProperties
(Properties additionalProperties) void
setDelimiters
(LinkedHashSet<String> delimiters) Set the delimiter specifications to use during filtering.void
setDelimiters
(LinkedHashSet<String> delimiters, boolean useDefaultDelimiters) void
setEscapedBackslashesInFilePath
(boolean escape) Alias forsetEscapeWindowsPaths(boolean)
void
setEscapeString
(String escapeString) void
setEscapeWindowsPaths
(boolean escapedBackslashesInFilePath) void
setFileFilters
(List<String> paramfilters) Alias forsetFilters(List)
void
setFilters
(List<String> filters) Set the filters.void
setInjectProjectBuildFilters
(boolean injectProjectBuildFilters) void
setMavenProject
(org.apache.maven.project.MavenProject mavenProject) Set the MavenProject.void
setMavenSession
(org.apache.maven.execution.MavenSession mavenSession) void
setProjectStartExpressions
(List<String> projectStartExpressions) void
setSupportMultiLineFiltering
(boolean supportMultiLineFiltering)
-
Constructor Details
-
AbstractMavenFilteringRequest
protected AbstractMavenFilteringRequest()Create instance. -
AbstractMavenFilteringRequest
protected AbstractMavenFilteringRequest(org.apache.maven.project.MavenProject mavenProject, List<String> filters, org.apache.maven.execution.MavenSession mavenSession) Create instance with given parameters- Parameters:
mavenProject
- The instance of MavenProject.filters
- The list of filters.mavenSession
- The MavenSession.
-
-
Method Details
-
getMavenProject
public org.apache.maven.project.MavenProject getMavenProject()- Returns:
- The MavenProject
-
setMavenProject
public void setMavenProject(org.apache.maven.project.MavenProject mavenProject) Set the MavenProject.- Parameters:
mavenProject
- The MavenProject to be set.
-
getFilters
The list of filters.- Returns:
- The list of currently set filters.
-
setFilters
Set the filters.- Parameters:
filters
- Set the list of filters
-
getFileFilters
Alias forgetFilters()
.- Returns:
- The list of filters.
-
setFileFilters
Alias forsetFilters(List)
- Parameters:
paramfilters
- The list of filters to be set.
-
isEscapeWindowsPaths
public boolean isEscapeWindowsPaths()- Returns:
- true if escape is activated false otherwise.
- Since:
- 1.0-beta-3
-
setEscapeWindowsPaths
public void setEscapeWindowsPaths(boolean escapedBackslashesInFilePath) - Parameters:
escapedBackslashesInFilePath
- true or false.- Since:
- 1.0-beta-3
-
isEscapedBackslashesInFilePath
public boolean isEscapedBackslashesInFilePath()Alias forisEscapeWindowsPaths()
- Returns:
- The current value of
isEscapeWindowsPaths()
-
setEscapedBackslashesInFilePath
public void setEscapedBackslashesInFilePath(boolean escape) Alias forsetEscapeWindowsPaths(boolean)
- Parameters:
escape
- activate or deactivate escaping.
-
getMavenSession
public org.apache.maven.execution.MavenSession getMavenSession()- Returns:
- Current value of mavenSession
-
setMavenSession
public void setMavenSession(org.apache.maven.execution.MavenSession mavenSession) - Parameters:
mavenSession
- Set new value for the MavenSession of the instance.
-
getAdditionalProperties
- Returns:
- the additional properties.
- Since:
- 1.0-beta-3
-
setAdditionalProperties
- Parameters:
additionalProperties
- The additional properties to be set.- Since:
- 1.0-beta-3
-
isInjectProjectBuildFilters
public boolean isInjectProjectBuildFilters()- Returns:
- the current value of injectProjectBuildFilters.
- Since:
- 1.0-beta-3
-
setInjectProjectBuildFilters
public void setInjectProjectBuildFilters(boolean injectProjectBuildFilters) - Parameters:
injectProjectBuildFilters
- true or false.- Since:
- 1.0-beta-3
-
getEscapeString
- Returns:
- Current value of escapeString.
- Since:
- 1.0-beta-2
-
setEscapeString
- Parameters:
escapeString
- The escape string to use- Since:
- 1.0-beta-2
-
getProjectStartExpressions
- Returns:
- The list of project start expressions.
- Since:
- 1.0-beta-2
-
setProjectStartExpressions
- Parameters:
projectStartExpressions
- The start expressions- Since:
- 1.0-beta-2
-
getDelimiters
Seedelimiters
for more information and default values.- Returns:
- Not allowed to be
null
or empty. - Since:
- 1.0-beta-3
-
setDelimiters
Set the delimiter specifications to use during filtering. Specifications should be of the form: 'BEGIN*END' for asymmetrical delimiters, or 'TOKEN' for symmetrical delimiters. Seedelimiters
for more information and default values.- Parameters:
delimiters
- Ifnull
, reset delimiters to '${*}' only. Otherwise, use the provided value.- Since:
- 1.0-beta-3
-
setDelimiters
- Parameters:
delimiters
- Ifnull
than nothing will happen. If notnull
the delimiters will be set according to the contents. If delimiter entries arenull
those entries will be set to '${*}'.useDefaultDelimiters
- true if the default delimiters will be used false otherwise.
-
isSupportMultiLineFiltering
public boolean isSupportMultiLineFiltering()- Returns:
- If support multiple line filtering is active or not.
-
setSupportMultiLineFiltering
public void setSupportMultiLineFiltering(boolean supportMultiLineFiltering) - Parameters:
supportMultiLineFiltering
- activate or deactivate multiple line filtering support.
-