idea:module

Full name:

org.apache.maven.plugins:maven-idea-plugin:2.2.1:module

Description:

Creates the module files (*.iml) for IntelliJ IDEA.

Attributes:

  • Requires a Maven project to be executed.
  • Invokes the execution of the lifecycle phase generate-sources prior to executing itself.

Optional Parameters

Name Type Since Description
dependenciesAsLibraries boolean - Causes the module libraries to use a short name for all dependencies. This is very convenient but has been reported to cause problems with IDEA.
Default value is: false.
deploymentDescriptorFile String - Specify the location of the deployment descriptor file, if one is provided.
User property is: deploymentDescriptorFile.
downloadJavadocs boolean - Enables/disables the downloading of javadoc attachments.
Default value is: false.
User property is: downloadJavadocs.
downloadSources boolean - Enables/disables the downloading of source attachments.
Default value is: false.
User property is: downloadSources.
exclude String - A comma-separated list of directories that should be excluded. These directories are in addition to those already excluded, such as target.
ideaPlugin boolean - Tell IntelliJ IDEA that this module is an IntelliJ IDEA Plugin.
Default value is: false.
ideaVersion String - Specify the version of IDEA to target. This is needed to identify the default formatting of project-jdk-name used by IDEA. Currently supports 4.x and 5.x. This will only be used when parameter jdkName is not set.
Default value is: 5.x.
User property is: ideaVersion.
javadocClassifier String - Sets the classifier string attached to an artifact javadoc archive name.
Default value is: javadoc.
User property is: javadocClassifier.
libraries Library[] - An optional set of Library objects that allow you to specify a comma separated list of source dirs, class dirs, or to indicate that the library should be excluded from the module. For example: 
<libraries>
 <library>
     <name>webwork</name>
     <sources>file://$webwork$/src/java</sources>
     <!--
     <classes>...</classes>
     <exclude>true</exclude>
     -->
 </library>
</libraries>

linkModules boolean - Whether to link the reactor projects as dependency modules or as libraries.
Default value is: true.
User property is: linkModules.
overwrite boolean - Whether to update the existing project files or overwrite them.
Default value is: false.
User property is: overwrite.
sourceClassifier String - Sets the classifier string attached to an artifact source archive name.
Default value is: sources.
User property is: sourceClassifier.
useFullNames boolean - Whether to use full artifact names when referencing libraries.
Default value is: false.
User property is: useFullNames.

Parameter Details

dependenciesAsLibraries:

Causes the module libraries to use a short name for all dependencies. This is very convenient but has been reported to cause problems with IDEA.
  • Type: boolean
  • Required: No
  • Default: false

deploymentDescriptorFile:

Specify the location of the deployment descriptor file, if one is provided.
  • Type: java.lang.String
  • Required: No
  • User Property: deploymentDescriptorFile

downloadJavadocs:

Enables/disables the downloading of javadoc attachments.
  • Type: boolean
  • Required: No
  • User Property: downloadJavadocs
  • Default: false

downloadSources:

Enables/disables the downloading of source attachments.
  • Type: boolean
  • Required: No
  • User Property: downloadSources
  • Default: false

exclude:

A comma-separated list of directories that should be excluded. These directories are in addition to those already excluded, such as target.
  • Type: java.lang.String
  • Required: No

ideaPlugin:

Tell IntelliJ IDEA that this module is an IntelliJ IDEA Plugin.
  • Type: boolean
  • Required: No
  • Default: false

ideaVersion:

Specify the version of IDEA to target. This is needed to identify the default formatting of project-jdk-name used by IDEA. Currently supports 4.x and 5.x. This will only be used when parameter jdkName is not set.
  • Type: java.lang.String
  • Required: No
  • User Property: ideaVersion
  • Default: 5.x

javadocClassifier:

Sets the classifier string attached to an artifact javadoc archive name.
  • Type: java.lang.String
  • Required: No
  • User Property: javadocClassifier
  • Default: javadoc

libraries:

An optional set of Library objects that allow you to specify a comma separated list of source dirs, class dirs, or to indicate that the library should be excluded from the module. For example: 
<libraries>
 <library>
     <name>webwork</name>
     <sources>file://$webwork$/src/java</sources>
     <!--
     <classes>...</classes>
     <exclude>true</exclude>
     -->
 </library>
</libraries>
  • Type: org.apache.maven.plugin.idea.Library[]
  • Required: No

linkModules:

Whether to link the reactor projects as dependency modules or as libraries.
  • Type: boolean
  • Required: No
  • User Property: linkModules
  • Default: true

overwrite:

Whether to update the existing project files or overwrite them.
  • Type: boolean
  • Required: No
  • User Property: overwrite
  • Default: false

sourceClassifier:

Sets the classifier string attached to an artifact source archive name.
  • Type: java.lang.String
  • Required: No
  • User Property: sourceClassifier
  • Default: sources

useFullNames:

Whether to use full artifact names when referencing libraries.
  • Type: boolean
  • Required: No
  • User Property: useFullNames
  • Default: false