org.apache.maven.shared.filtering
Class MavenResourcesExecution

java.lang.Object
  extended by org.apache.maven.shared.filtering.AbstractMavenFilteringRequest
      extended by org.apache.maven.shared.filtering.MavenResourcesExecution

public class MavenResourcesExecution
extends AbstractMavenFilteringRequest

A bean to configure a resources filtering execution

Version:
$Id: MavenResourcesExecution.java 889246 2009-12-10 12:51:21Z mkleint $
Author:
olamy

Constructor Summary
MavenResourcesExecution()
           
MavenResourcesExecution(java.util.List resources, java.io.File outputDirectory, org.apache.maven.project.MavenProject mavenProject, java.lang.String encoding, java.util.List fileFilters, java.util.List nonFilteredFileExtensions, org.apache.maven.execution.MavenSession mavenSession)
          As we use a maven project useDefaultFilterWrappers will set to true
MavenResourcesExecution(java.util.List resources, java.io.File outputDirectory, java.lang.String encoding, java.util.List filterWrappers, java.io.File resourcesBaseDirectory, java.util.List nonFilteredFileExtensions)
           
 
Method Summary
 void addFilerWrapper(org.codehaus.plexus.interpolation.ValueSource valueSource)
          Helper to add FileUtils.FilterWrapper, will RegexBasedInterpolator with default regex Exp ${ } and InterpolatorFilterReader with defaultTokens ${ }
 void addFilerWrapper(org.codehaus.plexus.interpolation.ValueSource valueSource, java.lang.String startRegExp, java.lang.String endRegExp, java.lang.String startToken, java.lang.String endToken)
          Deprecated. this doesn't support escaping use addFilerWrapperWithEscaping(ValueSource, String, String, String)
 void addFilerWrapperWithEscaping(org.codehaus.plexus.interpolation.ValueSource valueSource, java.lang.String startExp, java.lang.String endExp, java.lang.String escapeString)
           
 void addFilterWrapper(org.codehaus.plexus.util.FileUtils.FilterWrapper filterWrapper)
           
 MavenResourcesExecution copyOf()
           
 java.util.List getFilterWrappers()
           
 java.util.List getNonFilteredFileExtensions()
           
 java.io.File getOutputDirectory()
           
 java.util.List getResources()
           
 java.io.File getResourcesBaseDirectory()
           
 boolean isIncludeEmptyDirs()
          Copy any empty directories included in the Resources.
 boolean isOverwrite()
          Overwrite existing files even if the destination files are newer.
 boolean isUseDefaultFilterWrappers()
           
 void setFilterWrappers(java.util.List filterWrappers)
           
 void setIncludeEmptyDirs(boolean includeEmptyDirs)
          Copy any empty directories included in the Resources.
 void setNonFilteredFileExtensions(java.util.List nonFilteredFileExtensions)
           
 void setOutputDirectory(java.io.File outputDirectory)
           
 void setOverwrite(boolean overwrite)
          Overwrite existing files even if the destination files are newer.
 void setResources(java.util.List resources)
           
 void setResourcesBaseDirectory(java.io.File resourcesBaseDirectory)
           
 void setUseDefaultFilterWrappers(boolean useDefaultFilterWrappers)
           
 
Methods inherited from class org.apache.maven.shared.filtering.AbstractMavenFilteringRequest
getAdditionalProperties, getDelimiters, getEncoding, getEscapeString, getFileFilters, getFilters, getMavenProject, getMavenSession, getProjectStartExpressions, isEscapedBackslashesInFilePath, isEscapeWindowsPaths, isInjectProjectBuildFilters, setAdditionalProperties, setDelimiters, setEncoding, setEscapedBackslashesInFilePath, setEscapeString, setEscapeWindowsPaths, setFileFilters, setFilters, setInjectProjectBuildFilters, setMavenProject, setMavenSession, setProjectStartExpressions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MavenResourcesExecution

public MavenResourcesExecution()

MavenResourcesExecution

public MavenResourcesExecution(java.util.List resources,
                               java.io.File outputDirectory,
                               org.apache.maven.project.MavenProject mavenProject,
                               java.lang.String encoding,
                               java.util.List fileFilters,
                               java.util.List nonFilteredFileExtensions,
                               org.apache.maven.execution.MavenSession mavenSession)
As we use a maven project useDefaultFilterWrappers will set to true

Parameters:
resources -
outputDirectory -
mavenProject -
encoding -
fileFilters -
nonFilteredFileExtensions -
mavenSession -

MavenResourcesExecution

public MavenResourcesExecution(java.util.List resources,
                               java.io.File outputDirectory,
                               java.lang.String encoding,
                               java.util.List filterWrappers,
                               java.io.File resourcesBaseDirectory,
                               java.util.List nonFilteredFileExtensions)
Method Detail

getResources

public java.util.List getResources()
Returns:
List of Resource

setResources

public void setResources(java.util.List resources)
Parameters:
resources - List of Resource

getOutputDirectory

public java.io.File getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(java.io.File outputDirectory)

getNonFilteredFileExtensions

public java.util.List getNonFilteredFileExtensions()
Returns:
List of String file extensions to not filtering

setNonFilteredFileExtensions

public void setNonFilteredFileExtensions(java.util.List nonFilteredFileExtensions)
Parameters:
nonFilteredFileExtensions - List of String file extensions to not filtering

getFilterWrappers

public java.util.List getFilterWrappers()
Returns:
List of FileUtils.FilterWrapper

setFilterWrappers

public void setFilterWrappers(java.util.List filterWrappers)
Parameters:
filterWrappers - List of FileUtils.FilterWrapper

addFilterWrapper

public void addFilterWrapper(org.codehaus.plexus.util.FileUtils.FilterWrapper filterWrapper)

addFilerWrapper

public void addFilerWrapper(org.codehaus.plexus.interpolation.ValueSource valueSource)
Helper to add FileUtils.FilterWrapper, will RegexBasedInterpolator with default regex Exp ${ } and InterpolatorFilterReader with defaultTokens ${ }

Parameters:
valueSource -

addFilerWrapper

public void addFilerWrapper(org.codehaus.plexus.interpolation.ValueSource valueSource,
                            java.lang.String startRegExp,
                            java.lang.String endRegExp,
                            java.lang.String startToken,
                            java.lang.String endToken)
Deprecated. this doesn't support escaping use addFilerWrapperWithEscaping(ValueSource, String, String, String)

Parameters:
valueSource -
startRegExp -
endRegExp -
startToken -
endToken -

addFilerWrapperWithEscaping

public void addFilerWrapperWithEscaping(org.codehaus.plexus.interpolation.ValueSource valueSource,
                                        java.lang.String startExp,
                                        java.lang.String endExp,
                                        java.lang.String escapeString)
Parameters:
valueSource -
startExp - start token like ${
endExp - endToken }
escapeString -
Since:
1.0-beta-2

getResourcesBaseDirectory

public java.io.File getResourcesBaseDirectory()

setResourcesBaseDirectory

public void setResourcesBaseDirectory(java.io.File resourcesBaseDirectory)

isUseDefaultFilterWrappers

public boolean isUseDefaultFilterWrappers()

setUseDefaultFilterWrappers

public void setUseDefaultFilterWrappers(boolean useDefaultFilterWrappers)

isOverwrite

public boolean isOverwrite()
Overwrite existing files even if the destination files are newer.

Returns:
Since:
1.0-beta-2

setOverwrite

public void setOverwrite(boolean overwrite)
Overwrite existing files even if the destination files are newer.

Parameters:
overwrite -
Since:
1.0-beta-2

isIncludeEmptyDirs

public boolean isIncludeEmptyDirs()
Copy any empty directories included in the Resources.

Returns:
Since:
1.0-beta-2

setIncludeEmptyDirs

public void setIncludeEmptyDirs(boolean includeEmptyDirs)
Copy any empty directories included in the Resources.

Parameters:
includeEmptyDirs -
Since:
1.0-beta-2

copyOf

public MavenResourcesExecution copyOf()


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.