Fork me on GitHub
Built by Maven

properties:read-project-properties

Full name:

org.codehaus.mojo:properties-maven-plugin:1.2.1:read-project-properties

Description:

The read-project-properties goal reads property files and URLs and stores the properties as project properties. It serves as an alternate to specifying properties in pom.xml. It is especially useful when making properties defined in a runtime resource available at build time.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.0.

Optional Parameters

Name Type Since Description
<files> File[] 1.0.0 The properties files that will be used when reading properties.
<keyPrefix> String 1.1.0 Prefix that will be added before name of each property. Can be useful for separating properties with same name from different files.
<override> boolean 1.2.0 Determine, whether existing properties should be overridden or not. Default: true.
Default value is: true.
<quiet> boolean 1.0.0 If the plugin should be quiet if any of the files was not found
Default value is: false.
<skipLoadProperties> boolean 1.2.0 Skip plugin execution.
Default value is: false.
User property is: prop.skipLoadProperties.
<urls> String[] 1.0.0 The URLs that will be used when reading properties. These may be non-standard URLs of the form classpath:com/company/resource.properties. Note that the type is not URL for this reason and therefore will be explicitly checked by this Mojo.
<useDefaultValues> boolean 1.2.0 If the plugin should process default values within property placeholders
Default value is: false.

Parameter Details

<files>

The properties files that will be used when reading properties.
  • Type: java.io.File[]
  • Since: 1.0.0
  • Required: No

<keyPrefix>

Prefix that will be added before name of each property. Can be useful for separating properties with same name from different files.
  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No

<override>

Determine, whether existing properties should be overridden or not. Default: true.
  • Type: boolean
  • Since: 1.2.0
  • Required: No
  • Default: true

<quiet>

If the plugin should be quiet if any of the files was not found
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • Default: false

<skipLoadProperties>

Skip plugin execution.
  • Type: boolean
  • Since: 1.2.0
  • Required: No
  • User Property: prop.skipLoadProperties
  • Default: false

<urls>

The URLs that will be used when reading properties. These may be non-standard URLs of the form classpath:com/company/resource.properties. Note that the type is not URL for this reason and therefore will be explicitly checked by this Mojo.
  • Type: java.lang.String[]
  • Since: 1.0.0
  • Required: No

<useDefaultValues>

If the plugin should process default values within property placeholders
  • Type: boolean
  • Since: 1.2.0
  • Required: No
  • Default: false