properties:write-project-properties

Full name:

org.kuali.maven.plugins:properties-maven-plugin:2.0.1: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.
User property is: properties.outputFile.
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.
User property is: properties.outputStyle.

Optional Parameters

Name Type Since Description
comment String - Anything provided here is added as a comment at the top of the properties file.
User property is: properties.comment.
encoding String - The encoding to use when storing the properties
Default value is: ${project.build.sourceEncoding}.
User property is: properties.encoding.
exclude String - CSV list of properties to exclude. A single wildcard character * is supported.
User property is: properties.exclude.
excludes List - List of properties to exclude. A single wildcard character * is supported.
include String - CSV list of properties to include. A single wildcard character * is supported.
User property is: properties.include.
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.
User property is: properties.includeEnvironmentVariables.
includeStandardMavenProperties boolean - If true, these Maven properties are added to the properties file: 
  project.groupId
  project.artifactId
  project.version
  project.basedir
  project.build.directory

Default value is: false.
User property is: properties.includeStandardMavenProperties.
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.
User property is: properties.includeSystemProperties.
includes List - List of properties to include. A single wildcard character * is supported.
prefix String - If supplied property keys are prefixed with this value before being stored.
User property is: properties.prefix.
resolvePlaceholders boolean - If true placeholders are resolved before writing properties to the file
Default value is: false.
User property is: properties.resolvePlaceholders.

Parameter Details

comment:

Anything provided here is added as a comment at the top of the properties file.
  • Type: java.lang.String
  • Required: No
  • User Property: properties.comment

encoding:

The encoding to use when storing the properties
  • Type: java.lang.String
  • Required: No
  • User Property: properties.encoding
  • Default: ${project.build.sourceEncoding}

exclude:

CSV list of properties to exclude. A single wildcard character * is supported.
  • Type: java.lang.String
  • Required: No
  • User Property: properties.exclude

excludes:

List of properties to exclude. A single wildcard character * is supported.
  • Type: java.util.List
  • Required: No

include:

CSV list of properties to include. A single wildcard character * is supported.
  • Type: java.lang.String
  • Required: No
  • User Property: 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
  • User Property: properties.includeEnvironmentVariables
  • Default: false

includeStandardMavenProperties:

If true, these Maven properties are added to the properties file: 
  project.groupId
  project.artifactId
  project.version
  project.basedir
  project.build.directory
  • Type: boolean
  • Required: No
  • User Property: properties.includeStandardMavenProperties
  • 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
  • User Property: properties.includeSystemProperties
  • Default: false

includes:

List of properties to include. A single wildcard character * is supported.
  • Type: java.util.List
  • Required: No

outputFile:

The file that properties will be written to
  • Type: java.io.File
  • Required: Yes
  • User Property: 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.kuali.maven.plugins.properties.OutputStyle
  • Required: Yes
  • User Property: properties.outputStyle
  • Default: NORMAL

prefix:

If supplied property keys are prefixed with this value before being stored.
  • Type: java.lang.String
  • Required: No
  • User Property: properties.prefix

resolvePlaceholders:

If true placeholders are resolved before writing properties to the file
  • Type: boolean
  • Required: No
  • User Property: properties.resolvePlaceholders
  • Default: false