MavenResourcesExecution (Apache Maven Filtering 3.1.1 API)

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()` Do nothing.
`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 project `useDefaultFilterWrappers` will be set to `true`.
`MavenResourcesExecution(List<org.apache.maven.model.Resource> resources, File outputDirectory, String encoding, List<FileUtils.FilterWrapper> filterWrappers, File resourcesBaseDirectory, List<String> nonFilteredFileExtensions)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFilerWrapperWithEscaping(org.codehaus.plexus.interpolation.ValueSource valueSource, String startExp, String endExp, String escapeString, boolean multiLineFiltering)`
`void`	`addFilterWrapper(FileUtils.FilterWrapper filterWrapper)`
`MavenResourcesExecution`	`copyOf()`
`String`	`getEncoding()` Return the encoding.
`List<FileUtils.FilterWrapper>`	`getFilterWrappers()`
`List<String>`	`getNonFilteredFileExtensions()`
`File`	`getOutputDirectory()`
`List<org.apache.maven.model.Resource>`	`getResources()`
`File`	`getResourcesBaseDirectory()`
`boolean`	`isAddDefaultExcludes()`
`boolean`	`isFilterFilenames()`
`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(String encoding)` Set the value for encoding.
`void`	`setFilterFilenames(boolean filterFilenames)`
`void`	`setFilterWrappers(List<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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - 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 project useDefaultFilterWrappers will be set to true. The useDefaultExcludes is set to true.
    
    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<FileUtils.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 Detail
  - getEncoding
```
public String getEncoding()
```
    Return the encoding.
    
    Returns:
    Current encoding.
  - setEncoding
```
public void setEncoding(String encoding)
```
    Set the value for encoding.
    
    Parameters:
    encoding - Give the new value for encoding.
  - 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()
```
    Returns:
    The output directory.
  - setOutputDirectory
```
public void setOutputDirectory(File outputDirectory)
```
    Parameters:
    outputDirectory - The output directory.
  - getNonFilteredFileExtensions
```
public List<String> getNonFilteredFileExtensions()
```
    Returns:
    List of String file extensions not to filter
  - setNonFilteredFileExtensions
```
public void setNonFilteredFileExtensions(List<String> nonFilteredFileExtensions)
```
    Parameters:
    nonFilteredFileExtensions - List of String file extensions to not filter
  - getFilterWrappers
```
public List<FileUtils.FilterWrapper> getFilterWrappers()
```
    Returns:
    List of FileUtils.FilterWrapper
  - setFilterWrappers
```
public void setFilterWrappers(List<FileUtils.FilterWrapper> filterWrappers)
```
    Parameters:
    filterWrappers - List of FileUtils.FilterWrapper
  - addFilterWrapper
```
public void addFilterWrapper(FileUtils.FilterWrapper filterWrapper)
```
    Parameters:
    filterWrapper - The filter wrapper which should be added.
  - 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
```
public File getResourcesBaseDirectory()
```
    Returns:
    The resource base directory.
  - setResourcesBaseDirectory
```
public void setResourcesBaseDirectory(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
  - 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, otherwise false.
    Since:
    
    1.0-beta-2
  - isFilterFilenames
```
public boolean isFilterFilenames()
```
    Returns:
    true if filenames are filtered, otherwise false
    Since:
    
    1.2
  - setFilterFilenames
```
public void setFilterFilenames(boolean filterFilenames)
```
    Parameters:
    filterFilenames - true if filenames should be filtered, otherwise false
    Since:
    
    1.2
  - copyOf
```
public MavenResourcesExecution copyOf()
```
    Returns:
    MavenResourcesExecution
  - isSupportMultiLineFiltering
```
public boolean isSupportMultiLineFiltering()
```
    Overrides:
    
    isSupportMultiLineFiltering in class AbstractMavenFilteringRequest
    
    Returns:
    If support multiple line filtering is active or not.
  - setSupportMultiLineFiltering
```
public void setSupportMultiLineFiltering(boolean supportMultiLineFiltering)
```
    Overrides:
    
    setSupportMultiLineFiltering in class AbstractMavenFilteringRequest
    
    Parameters:
    supportMultiLineFiltering - activate or deactivate multiple line filtering support.

Class MavenResourcesExecution

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

MavenResourcesExecution

MavenResourcesExecution

MavenResourcesExecution

Method Detail

getEncoding

setEncoding

getResources

setResources

getOutputDirectory

setOutputDirectory

getNonFilteredFileExtensions

setNonFilteredFileExtensions

getFilterWrappers

setFilterWrappers

addFilterWrapper

addFilerWrapperWithEscaping

getResourcesBaseDirectory

setResourcesBaseDirectory

isUseDefaultFilterWrappers

setUseDefaultFilterWrappers

isAddDefaultExcludes

setAddDefaultExcludes

isOverwrite

setOverwrite

isIncludeEmptyDirs

setIncludeEmptyDirs

isFilterFilenames

setFilterFilenames

copyOf

isSupportMultiLineFiltering

setSupportMultiLineFiltering