properties:write-project-properties

Full name:

org.kuali.maven.plugins:properties-maven-plugin:1.4.7: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.
outputStyle OutputStyle - Either NORMAL or ENVIRONMENT_VARIABLE. When set to ENVIRONMENT_VARIABLE the keys in the properties file will all be upper case with periods replaced by underscores.
Default value is: NORMAL.

Optional Parameters

Name Type Since Description
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.
prefix String - If supplied property keys are prefixed with this value before being stored.
resolvePlaceholders boolean - If true placeholders are resolved before writing properties to the file
trimBeforeResolve boolean - If true, include/exclude is used to trim the properties list before resolving placeholders
Default value is: true.

Parameter Details

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

outputStyle:

Either NORMAL or ENVIRONMENT_VARIABLE. When set to ENVIRONMENT_VARIABLE the keys in the properties file will all be upper case with periods replaced by underscores.
  • Type: org.codehaus.mojo.properties.OutputStyle
  • Required: Yes
  • Expression: ${properties.outputStyle}
  • Default: NORMAL

prefix:

If supplied property keys are prefixed with this value before being stored.
  • Type: java.lang.String
  • Required: No
  • Expression: ${properties.prefix}

resolvePlaceholders:

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

trimBeforeResolve:

If true, include/exclude is used to trim the properties list before resolving placeholders
  • Type: boolean
  • Required: No
  • Expression: ${properties.trimBeforeResolve}
  • Default: true