properties:write-project-properties

Full name:

org.kuali.maven.plugins:properties-maven-plugin:1.3.3-SNAPSHOT:write-project-properties

Description:

Write project properties to a file.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
outputFile File - The file that properties will be written to
Default value is: ${project.build.directory}/properties/project.properties.

Optional Parameters

Name Type Since Description
antEchoPropertiesMode boolean - If true, the plugin will create the properties file formatted the same way Ant formats properties files using the echoproperties task. This mode adds 3 custom properties at the top of the file, DSTAMP, TODAY, and TSTAMP. In this mode escapeChars is ignored and the 6 characters Ant escapes are used instead CR,LF, TAB,:,#,=
Default value is: false.
escapeChars String - Comma separated list of characters to escape when writing property values. cr=carriage return, lf=linefeed, tab=tab. Any other values are taken literally.
Default value is: cr,lf,tab,backslash,:,#,=.
exclude String - Comma separated set of properties to exclude when writing the properties file
include String - Comma separated set of properties to write to the properties file. If provided, only the properties matching those supplied here will be written to the properties file.
includeEnvironmentVariables boolean - If true, the plugin will include environment variables when writing the properties file. Environment variables are prefixed with "env". Environment variables override project properties.
Default value is: false.
includeSystemProperties boolean - If true, the plugin will include system properties when writing the properties file. System properties override both environment variables and project properties.
Default value is: false.
resolvePlaceholders boolean - If true placeholders are resolved before writing properties to the file

Parameter Details

antEchoPropertiesMode:

If true, the plugin will create the properties file formatted the same way Ant formats properties files using the echoproperties task. This mode adds 3 custom properties at the top of the file, DSTAMP, TODAY, and TSTAMP. In this mode escapeChars is ignored and the 6 characters Ant escapes are used instead CR,LF, TAB,:,#,=
  • Type: boolean
  • Required: No
  • Expression: ${properties.antEchoPropertiesMode}
  • Default: false

escapeChars:

Comma separated list of characters to escape when writing property values. cr=carriage return, lf=linefeed, tab=tab. Any other values are taken literally.
  • Type: java.lang.String
  • Required: No
  • Expression: ${properties.escapeChars}
  • Default: cr,lf,tab,backslash,:,#,=

exclude:

Comma separated set of properties to exclude when writing the properties file
  • Type: java.lang.String
  • Required: No
  • Expression: ${properties.exclude}

include:

Comma separated set of properties to write to the properties file. If provided, only the properties matching those supplied here will be written to the properties file.
  • Type: java.lang.String
  • Required: No
  • Expression: ${properties.include}

includeEnvironmentVariables:

If true, the plugin will include environment variables when writing the properties file. Environment variables are prefixed with "env". Environment variables override project properties.
  • Type: boolean
  • Required: No
  • Expression: ${properties.includeEnvironmentVariables}
  • Default: false

includeSystemProperties:

If true, the plugin will include system properties when writing the properties file. System properties override both environment variables and project properties.
  • Type: boolean
  • Required: No
  • Expression: ${properties.includeSystemProperties}
  • Default: false

outputFile:

The file that properties will be written to
  • Type: java.io.File
  • Required: Yes
  • Expression: ${properties.outputFile}
  • Default: ${project.build.directory}/properties/project.properties

resolvePlaceholders:

If true placeholders are resolved before writing properties to the file
  • Type: boolean
  • Required: No
  • Expression: ${properties.resolvePlaceholders}