Built by Maven

merge-properties:merge

Full name:

org.polago.maven.plugins:merge-properties-maven-plugin:1.2:merge

Description:

Merges a set of properties files into an output file.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: process-resources.

Required Parameters

Name Type Since Description
<outputDirectory> File - The output directory into which to create the outputFile.
<outputFile> String - The output filename that the properties should be merged into relative to the outputDirectory.
<resources> List - The list of resources to merge. Please see the POM Reference for a description of how to specify the resources element. Note that the <targetPath> element is always ignored and the default <include> pattern is **/*.properties.

Optional Parameters

Name Type Since Description
<delimiters> LinkedHashSet -

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 use. Note that Java Properties files are always encoded in ISO-8859-1.
Default value is: ISO-8859-1.
User property is: encoding.
<escapeString> String - Expression preceded with this String won't be interpolated \${foo} will be replaced with ${foo}.
User property is: maven.resources.escapeString.
<escapeWindowsPaths> boolean - 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.
<mavenFilteringHints> List -

List of plexus components hints which implements MavenResourcesFiltering.filterResources() . They will be executed after the resources copying/filtering.
<overwrite> boolean - Overwrite any existing outputFile even if the outputFile file is newer.
Default value is: false.
User property is: maven.resources.overwrite.
<overwriteProperties> boolean - Overwrite any duplicate properties instead of failing the build.
Default value is: false.
User property is: maven.resources.overwrite.
<skip> boolean 1.1 Skip the execution of the plugin if you need to.
Default value is: false.
User property is: maven.resources.skip.
<supportMultiLineFiltering> boolean - Stop searching endToken at the end of line.
Default value is: false.
User property is: maven.resources.supportMultiLineFiltering.
<useBuildFilters> boolean - 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: buildFilters and filters


Default value is: true.
<useDefaultDelimiters> boolean - If false, don't use the maven's built-in delimiters.
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.LinkedHashSet
  • Required: No

<encoding>

The character encoding scheme to use. Note that Java Properties files are always encoded in ISO-8859-1.
  • Type: java.lang.String
  • Required: No
  • User Property: encoding
  • Default: ISO-8859-1

<escapeString>

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

<escapeWindowsPaths>

Whether to escape backslashes and colons in windows-style paths.
  • Type: boolean
  • 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.
  • Type: java.util.List
  • Required: No

<mavenFilteringHints>

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

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

<outputDirectory>

The output directory into which to create the outputFile.
  • Type: java.io.File
  • Required: Yes

<outputFile>

The output filename that the properties should be merged into relative to the outputDirectory.
  • Type: java.lang.String
  • Required: Yes

<overwrite>

Overwrite any existing outputFile even if the outputFile file is newer.
  • Type: boolean
  • Required: No
  • User Property: maven.resources.overwrite
  • Default: false

<overwriteProperties>

Overwrite any duplicate properties instead of failing the build.
  • Type: boolean
  • Required: No
  • User Property: maven.resources.overwrite
  • Default: false

<resources>

The list of resources to merge. Please see the POM Reference for a description of how to specify the resources element. Note that the <targetPath> element is always ignored and the default <include> pattern is **/*.properties.
  • Type: java.util.List
  • Required: Yes

<skip>

Skip the execution of the plugin if you need to.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: maven.resources.skip
  • Default: false

<supportMultiLineFiltering>

Stop searching endToken at the end of line.
  • Type: boolean
  • 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: buildFilters and filters

  • Type: boolean
  • Required: No
  • Default: true

<useDefaultDelimiters>

If false, don't use the maven's built-in delimiters.
  • Type: boolean
  • Required: No
  • Default: true