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 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 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<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

      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.

    • getPropertiesEncoding

      public String getPropertiesEncoding()
      Return the encoding of properties files.
      Returns:
      Current encoding of properties files.
      Since:
      3.2.0

    • setPropertiesEncoding

      public void setPropertiesEncoding(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 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<FilterWrapper> getFilterWrappers()
      Returns:
      List of FilterWrapper

    • setFilterWrappers

      public void setFilterWrappers(List<FilterWrapper> filterWrappers)
      Parameters:
      filterWrappers - List of FilterWrapper

    • 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, 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

      @Deprecated public boolean isOverwrite()
      Deprecated.
      Use #getChangeDetection() instead.
      Overwrite existing files even if the destination files are newer.
      Returns:
      true if operation always overwrites.
      Since:
      1.0-beta-2

    • setOverwrite

      @Deprecated public void setOverwrite(boolean overwrite)
      Deprecated.
      Use #setChangeDetection(ChangeDetection) instead.
      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, 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.