resources:resources

Full name:

org.apache.maven.plugins:maven-resources-plugin:2.6:resources

Description:

Copy resources for the main source code to the main output directory. Always uses the project.build.resources element to specify the resources to copy.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: process-resources.

Required Parameters

Name Type Since Description
outputDirectory File - The output directory into which to copy the resources.
Default value is: ${project.build.outputDirectory}.

Optional Parameters

Name Type Since Description
delimiters List 2.4

Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form 'beginToken*endToken'. If no '*' is given, the delimiter is assumed to be the same for start and end.

So, the default filtering delimiters might be specified as:

<delimiters>
  <delimiter>${*}</delimiter>
  <delimiter>@</delimiter>
</delimiters>

Since the '@' delimiter is the same on both ends, we don't need to specify '@*@' (though we can).


encoding String - The character encoding scheme to be applied when filtering resources.
Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
escapeString String 2.3 Expression preceded with the String won't be interpolated \${foo} will be replaced with ${foo}
User property is: maven.resources.escapeString.
escapeWindowsPaths boolean 2.4 Whether to escape backslashes and colons in windows-style paths.
Default value is: true.
User property is: maven.resources.escapeWindowsPaths.
filters List - The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.
Normally, these will be configured from a plugin's execution section, to provide a different set of filters for a particular execution. For instance, starting in Maven 2.2.0, you have the option of configuring executions with the id's default-resources and default-testResources to supply different configurations for the two different types of resources. By supplying extraFilters configurations, you can separate which filters are used for which type of resource.
includeEmptyDirs boolean 2.3 Copy any empty directories included in the Resources.
Default value is: false.
User property is: maven.resources.includeEmptyDirs.
mavenFilteringHints List 2.4

List of plexus components hint which implements MavenResourcesFiltering.filterResources(). They will be executed after the resources copying/filtering.


nonFilteredFileExtensions List 2.3 Additional file extensions to not apply filtering (already defined are : jpg, jpeg, gif, bmp, png)
overwrite boolean 2.3 Overwrite existing files even if the destination files are newer.
Default value is: false.
User property is: maven.resources.overwrite.
supportMultiLineFiltering boolean 2.5 stop searching endToken at the end of line
Default value is: false.
User property is: maven.resources.supportMultiLineFiltering.
useBuildFilters boolean 2.4 If false, don't use the filters specified in the build/filters section of the POM when processing resources in this mojo execution.
See also: ResourcesMojo.buildFilters and ResourcesMojo.filters
Default value is: true.
useDefaultDelimiters boolean 2.4 (no description)
Default value is: true.

Parameter Details

delimiters:

Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form 'beginToken*endToken'. If no '*' is given, the delimiter is assumed to be the same for start and end.

So, the default filtering delimiters might be specified as:

<delimiters>
  <delimiter>${*}</delimiter>
  <delimiter>@</delimiter>
</delimiters>

Since the '@' delimiter is the same on both ends, we don't need to specify '@*@' (though we can).

  • Type: java.util.List
  • Since: 2.4
  • Required: No

encoding:

The character encoding scheme to be applied when filtering resources.
  • Type: java.lang.String
  • Required: No
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

escapeString:

Expression preceded with the String won't be interpolated \${foo} will be replaced with ${foo}
  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • User Property: maven.resources.escapeString

escapeWindowsPaths:

Whether to escape backslashes and colons in windows-style paths.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • User Property: maven.resources.escapeWindowsPaths
  • Default: true

filters:

The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.
Normally, these will be configured from a plugin's execution section, to provide a different set of filters for a particular execution. For instance, starting in Maven 2.2.0, you have the option of configuring executions with the id's default-resources and default-testResources to supply different configurations for the two different types of resources. By supplying extraFilters configurations, you can separate which filters are used for which type of resource.
  • Type: java.util.List
  • Required: No

includeEmptyDirs:

Copy any empty directories included in the Resources.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: maven.resources.includeEmptyDirs
  • Default: false

mavenFilteringHints:

List of plexus components hint which implements MavenResourcesFiltering.filterResources(). They will be executed after the resources copying/filtering.

  • Type: java.util.List
  • Since: 2.4
  • Required: No

nonFilteredFileExtensions:

Additional file extensions to not apply filtering (already defined are : jpg, jpeg, gif, bmp, png)
  • Type: java.util.List
  • Since: 2.3
  • Required: No

outputDirectory:

The output directory into which to copy the resources.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.outputDirectory}

overwrite:

Overwrite existing files even if the destination files are newer.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: maven.resources.overwrite
  • Default: false

supportMultiLineFiltering:

stop searching endToken at the end of line
  • Type: boolean
  • Since: 2.5
  • Required: No
  • User Property: maven.resources.supportMultiLineFiltering
  • Default: false

useBuildFilters:

If false, don't use the filters specified in the build/filters section of the POM when processing resources in this mojo execution.
See also: ResourcesMojo.buildFilters and ResourcesMojo.filters
  • Type: boolean
  • Since: 2.4
  • Required: No
  • Default: true

useDefaultDelimiters:

(no description)
  • Type: boolean
  • Since: 2.4
  • Required: No
  • Default: true