Built by Maven

itconfiguration:config

Full name:

org.apache.maven.its.plugins:maven-it-plugin-configuration:2.1-SNAPSHOT:config

Description:

Dumps this mojo's configuration into a properties file.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: validate.

Optional Parameters

Name Type Since Description
aliasDefaultExpressionParam String - A parameter that combines all of the annotations.
Default value is: test.
User property is: config.aliasDefaultExpressionParam.
aliasParam String - A parameter with an alias.
aliasStringParams String[] - A complex parameter with an alias.
beanParam Bean - A complex parameter of type Bean.
booleanParam Boolean - A simple parameter of type Boolean.
User property is: config.booleanParam.
byteParam Byte - A simple parameter of type Byte.
User property is: config.byteParam.
characterParam Character - A simple parameter of type Character.
User property is: config.characterParam.
dateParam Date - A simple parameter of type Date.
User property is: config.dateParam.
defaultParam String - A parameter with a constant default value.
Default value is: maven-core-it.
defaultParamWithExpression String - A parameter with a default value using multiple expressions.
Default value is: ${project.groupId}:${project.artifactId}:${project.version}.
domParam PlexusConfiguration - A raw DOM snippet.
doubleParam Double - A simple parameter of type Double.
User property is: config.doubleParam.
fileParam File - A simple parameter of type File.
User property is: config.fileParam.
fileParams File[] - An array parameter of component type File.
floatParam Float - A simple parameter of type Float.
User property is: config.floatParam.
integerParam Integer - A simple parameter of type Integer.
User property is: config.intergerParam.
listParam List - A collection parameter of type List.
longParam Long - A simple parameter of type Long.
User property is: config.longParam.
mapParam Map - A collection parameter of type Map.
primitiveBooleanParam boolean - A simple parameter of type Boolean.TYPE.
User property is: config.primitiveBooleanParam.
primitiveIntegerParam int - A simple parameter of type Integer.TYPE.
User property is: config.primitiveIntegerParam.
propertiesFile File - The path to the properties file into which to save the mojo configuration.
User property is: config.propertiesFile.
propertiesParam Properties - A collection parameter of type Properties.
setParam Set - A collection parameter of type Set.
shortParam Short - A simple parameter of type Short.
User property is: config.shortParam.
stringParam String - A simple parameter of type String.
User property is: config.stringParam.
stringParams String[] - An array parameter of component type String.
uriParam URI - A simple parameter of type URI (requires Maven 3.x).
urlParam URL - A simple parameter of type URL.
User property is: config.urlParam.

Parameter Details

aliasDefaultExpressionParam:

A parameter that combines all of the annotations.
  • Type: java.lang.String
  • Required: No
  • User Property: config.aliasDefaultExpressionParam
  • Default: test

aliasParam:

A parameter with an alias.
  • Type: java.lang.String
  • Required: No

aliasStringParams:

A complex parameter with an alias.
  • Type: java.lang.String[]
  • Required: No

beanParam:

A complex parameter of type Bean.
  • Type: org.apache.maven.plugin.coreit.Bean
  • Required: No

booleanParam:

A simple parameter of type Boolean.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: config.booleanParam

byteParam:

A simple parameter of type Byte.
  • Type: java.lang.Byte
  • Required: No
  • User Property: config.byteParam

characterParam:

A simple parameter of type Character.
  • Type: java.lang.Character
  • Required: No
  • User Property: config.characterParam

dateParam:

A simple parameter of type Date.
  • Type: java.util.Date
  • Required: No
  • User Property: config.dateParam

defaultParam:

A parameter with a constant default value.
  • Type: java.lang.String
  • Required: No
  • Default: maven-core-it

defaultParamWithExpression:

A parameter with a default value using multiple expressions.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.groupId}:${project.artifactId}:${project.version}

domParam:

A raw DOM snippet.
  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Required: No

doubleParam:

A simple parameter of type Double.
  • Type: java.lang.Double
  • Required: No
  • User Property: config.doubleParam

fileParam:

A simple parameter of type File.
  • Type: java.io.File
  • Required: No
  • User Property: config.fileParam

fileParams:

An array parameter of component type File.
  • Type: java.io.File[]
  • Required: No

floatParam:

A simple parameter of type Float.
  • Type: java.lang.Float
  • Required: No
  • User Property: config.floatParam

integerParam:

A simple parameter of type Integer.
  • Type: java.lang.Integer
  • Required: No
  • User Property: config.intergerParam

listParam:

A collection parameter of type List.
  • Type: java.util.List
  • Required: No

longParam:

A simple parameter of type Long.
  • Type: java.lang.Long
  • Required: No
  • User Property: config.longParam

mapParam:

A collection parameter of type Map.
  • Type: java.util.Map
  • Required: No

primitiveBooleanParam:

A simple parameter of type Boolean.TYPE.
  • Type: boolean
  • Required: No
  • User Property: config.primitiveBooleanParam

primitiveIntegerParam:

A simple parameter of type Integer.TYPE.
  • Type: int
  • Required: No
  • User Property: config.primitiveIntegerParam

propertiesFile:

The path to the properties file into which to save the mojo configuration.
  • Type: java.io.File
  • Required: No
  • User Property: config.propertiesFile

propertiesParam:

A collection parameter of type Properties.
  • Type: java.util.Properties
  • Required: No

setParam:

A collection parameter of type Set.
  • Type: java.util.Set
  • Required: No

shortParam:

A simple parameter of type Short.
  • Type: java.lang.Short
  • Required: No
  • User Property: config.shortParam

stringParam:

A simple parameter of type String.
  • Type: java.lang.String
  • Required: No
  • User Property: config.stringParam

stringParams:

An array parameter of component type String.
  • Type: java.lang.String[]
  • Required: No

uriParam:

A simple parameter of type URI (requires Maven 3.x).
  • Type: java.net.URI
  • Required: No

urlParam:

A simple parameter of type URL.
  • Type: java.net.URL
  • Required: No
  • User Property: config.urlParam