property-helper:get

Full name:

org.basepom.maven:property-helper-maven-plugin:4.0.0:get

Description:

Fetches the defined numbers and add properties.

Attributes:

Requires a Maven project to be executed.
The goal is thread-safe and supports parallel builds.

Optional Parameters

Name	Type	Since	Description
`<activeGroups>`	`String[]`	`-`	The property groups to activate. If none are given, all property groups are activated. `<activeGroups> <activeGroup>group1</activeGroup> <activeGroup>group2</activeGroup> ... </activeGroups>`
`<dates>`	`DateDefinition[]`	`-`	Date property definitions. <dates> <date> <id>...</id> <skip>true\|false</skip> <export>true\|false</export> <value>...</value> <timezone>...</timezone> <format>...</format> <regexp>...</regexp> <transformers>...</transformers> <propertyFile>...</propertyFile> <propertyNameInFile>...</propertyNameInFile> <initialValue>...</initialValue> <onMissingFile>ignore\|warn\|fail\|create</onMissingFile> <onMissingFileProperty>ignore\|warn\|fail\|create</onMissingFileProperty> <onMissingProperty>ignore\|warn\|fail</onMissingProperty> </date> ... </dates>
`<macros>`	`MacroDefinition[]`	`-`	Macro definitions. <macros> <macro> <id>...</id> <skip>true\|false</skip> <export>true\|false</export> <macroType>...</macroType> <macroClass>...</macroClass> <properties> <some-name>some-value</some-name> ... </properties> <format>...</format> <regexp>...</regexp> <transformers>...</transformers> <propertyFile>...</propertyFile> <propertyNameInFile>...</propertyNameInFile> <initialValue>...</initialValue> <onMissingFile>ignore\|warn\|fail\|create</onMissingFile> <onMissingFileProperty>ignore\|warn\|fail\|create</onMissingFileProperty> <onMissingProperty>ignore\|warn\|fail</onMissingProperty> </macro> ... </macros>
`<numbers>`	`NumberDefinition[]`	`-`	Number property definitions. <numbers> <number> <id>...</id> <skip>true\|false</skip> <export>true\|false</export> <fieldNumber>...</fieldNumber> <increment>...</increment> <format>...</format> <regexp>...</regexp> <transformers>...</transformers> <propertyFile>...</propertyFile> <propertyNameInFile>...</propertyNameInFile> <initialValue>...</initialValue> <onMissingFile>ignore\|warn\|fail\|create</onMissingFile> <onMissingFileProperty>ignore\|warn\|fail\|create</onMissingFileProperty> <onMissingProperty>ignore\|warn\|fail</onMissingProperty> </number> ... </numbers>
`<onDuplicateField>`	`String`	`-`	Defines the action to take if a field is defined multiple times (e.g. as a number and a string). Options are `ignore` - ignore multiple definitions silently, retain just the first one found `warn` - like ignore, but also log a warning message `fail` - fail the build with an exception Default value is: `fail`. Alias is: `onDuplicateProperty`.
`<persist>`	`boolean`	`-`	If set to true, all fields that have a `<propertyFile>` configuration attribute are persisted to disk. Default value is: `false`.
`<propertyGroups>`	`PropertyGroupDefinition[]`	`-`	Define property groups. A property group contains one or more property definitions. Property groups are active by default unless they are explicitly listed with `<activeGroups>...</activeGroups`. `<propertyGroups> <propertyGroup> <id>...</id> <activeOnRelease>true\|false</activeOnRelease> <activeOnSnapshot>true\|false</activeOnSnapshot> <onDuplicateProperty>ignore\|warn\|fail</onDuplicateProperty> <onMissingField>ignore\|warn\|fail</onMissingField> <properties> <property> <name>...</name> <value>...</value> <transformers>...</transformers> </property> ... </properties> </propertyGroup> ... </propertyGroups>`
`<skip>`	`boolean`	`-`	If set to true, goal execution is skipped. Default value is: `false`.
`<strings>`	`StringDefinition[]`	`-`	String property definitions. <strings> <string> <id>...</id> <skip>true\|false</skip> <export>true\|false</export> <values> <value>...</value> ... </values> <blankIsValid>true\|false</blankIsValid> <onMissingValue>ignore\|warn\|fail</onMissingValue <format>...</format> <regexp>...</regexp> <transformers>...</transformers> <propertyFile>...</propertyFile> <propertyNameInFile>...</propertyNameInFile> <initialValue>...</initialValue> <onMissingFile>ignore\|warn\|fail\|create</onMissingFile> <onMissingFileProperty>ignore\|warn\|fail\|create</onMissingFileProperty> <onMissingProperty>ignore\|warn\|fail</onMissingProperty> </string> ... </strings>
`<uuids>`	`UuidDefinition[]`	`-`	Uuid definitions. `<uuids> <uuid> <id>...</id> <skip>true\|false</skip> <export>true\|false</export> <value>...</value> <format>...</format> <regexp>...</regexp> <transformers>...</transformers> <propertyFile>...</propertyFile> <propertyNameInFile>...</propertyNameInFile> <initialValue>...</initialValue> <onMissingFile>ignore\|warn\|fail\|create</onMissingFile> <onMissingFileProperty>ignore\|warn\|fail\|create</onMissingFileProperty> <onMissingProperty>ignore\|warn\|fail</onMissingProperty> </uuid> ... </uuids>`

Parameter Details

<activeGroups>

The property groups to activate. If none are given, all property groups are activated.

<activeGroups>
    <activeGroup>group1</activeGroup>
    <activeGroup>group2</activeGroup>
    ...
</activeGroups>

Type: java.lang.String[]
Required: No

<dates>

Date property definitions.

<dates>
    <date>
        <id>...</id>
        <skip>true|false</skip>
        <export>true|false</export>

        <value>...</value>
        <timezone>...</timezone>
        <format>...</format>
        <regexp>...</regexp>
        <transformers>...</transformers>

        <propertyFile>...</propertyFile>
        <propertyNameInFile>...</propertyNameInFile>
        <initialValue>...</initialValue>
        <onMissingFile>ignore|warn|fail|create</onMissingFile>
        <onMissingFileProperty>ignore|warn|fail|create</onMissingFileProperty>
        <onMissingProperty>ignore|warn|fail</onMissingProperty>
    </date>
    ...
</dates>

Type: org.basepom.mojo.propertyhelper.definitions.DateDefinition[]
Required: No

<macros>

Macro definitions.

<macros>
    <macro>
        <id>...</id>
        <skip>true|false</skip>
        <export>true|false</export>

        <macroType>...</macroType>
        <macroClass>...</macroClass>
        <properties>
            <some-name>some-value</some-name>
            ...
        </properties>

        <format>...</format>
        <regexp>...</regexp>
        <transformers>...</transformers>

        <propertyFile>...</propertyFile>
        <propertyNameInFile>...</propertyNameInFile>
        <initialValue>...</initialValue>
        <onMissingFile>ignore|warn|fail|create</onMissingFile>
        <onMissingFileProperty>ignore|warn|fail|create</onMissingFileProperty>
        <onMissingProperty>ignore|warn|fail</onMissingProperty>
    </macro>
    ...
</macros>

Type: org.basepom.mojo.propertyhelper.definitions.MacroDefinition[]
Required: No

<numbers>

Number property definitions.

<numbers>
    <number>
        <id>...</id>
        <skip>true|false</skip>
        <export>true|false</export>

        <fieldNumber>...</fieldNumber>
        <increment>...</increment>
        <format>...</format>
        <regexp>...</regexp>
        <transformers>...</transformers>

        <propertyFile>...</propertyFile>
        <propertyNameInFile>...</propertyNameInFile>
        <initialValue>...</initialValue>
        <onMissingFile>ignore|warn|fail|create</onMissingFile>
        <onMissingFileProperty>ignore|warn|fail|create</onMissingFileProperty>
        <onMissingProperty>ignore|warn|fail</onMissingProperty>
    </number>
    ...
</numbers>

Type: org.basepom.mojo.propertyhelper.definitions.NumberDefinition[]
Required: No

<onDuplicateField>

Defines the action to take if a field is defined multiple times (e.g. as a number and a string).
Options are

ignore - ignore multiple definitions silently, retain just the first one found
warn - like ignore, but also log a warning message
fail - fail the build with an exception

Type: java.lang.String
Required: No
Default: fail
Alias: onDuplicateProperty

<persist>

If set to true, all fields that have a <propertyFile> configuration attribute are persisted to disk.

Type: boolean
Required: No
Default: false

<propertyGroups>

Define property groups. A property group contains one or more property definitions. Property groups are active by default unless they are explicitly listed with <activeGroups>...</activeGroups.

<propertyGroups>
    <propertyGroup>
        <id>...</id>

        <activeOnRelease>true|false</activeOnRelease>
        <activeOnSnapshot>true|false</activeOnSnapshot>
        <onDuplicateProperty>ignore|warn|fail</onDuplicateProperty>
        <onMissingField>ignore|warn|fail</onMissingField>

        <properties>
            <property>
                <name>...</name>
                <value>...</value>
                <transformers>...</transformers>
            </property>
            ...
        </properties>
    </propertyGroup>
    ...
</propertyGroups>

Type: org.basepom.mojo.propertyhelper.definitions.PropertyGroupDefinition[]
Required: No

<skip>

If set to true, goal execution is skipped.

Type: boolean
Required: No
Default: false

<strings>

String property definitions.

<strings>
    <string>
        <id>...</id>
        <skip>true|false</skip>
        <export>true|false</export>

        <values>
            <value>...</value>
            ...
        </values>
        <blankIsValid>true|false</blankIsValid>
        <onMissingValue>ignore|warn|fail</onMissingValue
        <format>...</format>
        <regexp>...</regexp>
        <transformers>...</transformers>

        <propertyFile>...</propertyFile>
        <propertyNameInFile>...</propertyNameInFile>
        <initialValue>...</initialValue>
        <onMissingFile>ignore|warn|fail|create</onMissingFile>
        <onMissingFileProperty>ignore|warn|fail|create</onMissingFileProperty>
        <onMissingProperty>ignore|warn|fail</onMissingProperty>
    </string>
    ...
</strings>

Type: org.basepom.mojo.propertyhelper.definitions.StringDefinition[]
Required: No

<uuids>

Uuid definitions.

<uuids>
    <uuid>
        <id>...</id>
        <skip>true|false</skip>
        <export>true|false</export>

        <value>...</value>
        <format>...</format>
        <regexp>...</regexp>
        <transformers>...</transformers>

        <propertyFile>...</propertyFile>
        <propertyNameInFile>...</propertyNameInFile>
        <initialValue>...</initialValue>
        <onMissingFile>ignore|warn|fail|create</onMissingFile>
        <onMissingFileProperty>ignore|warn|fail|create</onMissingFileProperty>
        <onMissingProperty>ignore|warn|fail</onMissingProperty>
    </uuid>
    ...
</uuids>

Type: org.basepom.mojo.propertyhelper.definitions.UuidDefinition[]
Required: No