API Documentation: | IdeaModule |
---|
Generates an IDEA module file.
Property | Description |
downloadJavadoc | Whether to download and add javadoc associated with the dependency jars. |
downloadSources | Whether to download and add sources associated with the dependency jars. |
excludeDirs | The dirs to be excluded by idea. |
inputFile | The input file to load the initial configuration from. Defaults to the output file. If the specified input file does not exist, this task uses some default initial configuration. |
javaVersion | The JDK to use for this module. If this is |
moduleDir | The content root directory of the module. |
outputDir | The idea output dir for the production sources. If |
outputFile | The output file to write the final configuration to. |
scopes | The keys of this map are the Intellij scopes. Each key points to another map that has two keys, plus and minus.
The values of those keys are sets of |
sourceDirs | The dirs containing the production sources. |
testOutputDir | The idea output dir for the test sources. If |
testSourceDirs | The dirs containing the test sources. |
variables | The variables to be used for replacing absolute paths in the iml entries. For example, you might add a
|
Whether to download and add javadoc associated with the dependency jars.
- Default with
idea
plugin: false
Whether to download and add sources associated with the dependency jars.
- Default with
idea
plugin: true
The dirs to be excluded by idea.
- Default with
idea
plugin: [project.buildDir, project.file('.gradle')]
File
inputFile
The input file to load the initial configuration from. Defaults to the output file. If the specified input file does not exist, this task uses some default initial configuration.
String
javaVersion
The JDK to use for this module. If this is null
the value of the existing or default ipr XML (inherited)
is used. If it is set to inherited
, the project SDK is used. Otherwise the SDK for the corresponding
value of java version is used for this module
- Default with
idea
plugin: 'inherited'
File
outputDir
The idea output dir for the production sources. If null
no entry for output dirs is created.
- Default with
idea
plugin: null
- Default with
idea
andjava
plugin: project.sourceSets.main.classesDir
File
outputFile
The output file to write the final configuration to.
- Default with
idea
plugin: ${project.projectDir}
/${project.name}
.iml
Map
<String
, Map
<String
, Configuration
>>
scopes
Map
<String
, Map
<String
, Configuration
>>The keys of this map are the Intellij scopes. Each key points to another map that has two keys, plus and minus.
The values of those keys are sets of Configuration
objects. The files of the
plus configurations are added minus the files from the minus configurations.
- Default with
idea
plugin: [:]
- Default with
idea
andjava
plugin: -
COMPILE
->project.configurations.compile
RUNTIME
->project.configurations.runtime - project.configurations.compile
TEST
->project.configurations.testRuntime - project.configurations.runtime
The dirs containing the production sources.
- Default with
idea
plugin: []
- Default with
idea
andjava
plugin: - source dirs from
project.sourceSets.main.allSource
File
testOutputDir
The idea output dir for the test sources. If null
no entry for test output dirs is created.
- Default with
idea
plugin: null
- Default with
idea
andjava
plugin: project.sourceSets.test.classesDir
The dirs containing the test sources.
- Default with
idea
plugin: []
- Default with
idea
andjava
plugin: - source dirs from
project.sourceSets.test.allSource
Method | Description |
beforeConfigured(closure) | Adds a closure to be called before the domain object is configured by this task. The domain object is passed as a parameter to the closure. |
beforeConfigured(action) | Adds an action to be called before the domain object is configured by this task. The domain object is passed as a parameter to the action. |
whenConfigured(closure) | Adds a closure to be called after the domain object has been configured by this task. The domain object is passed as a parameter to the closure. |
whenConfigured(action) | Adds an action to be called after the domain object has been configured by this task. The domain object is passed as a parameter to the action. |
withXml(closure) | Adds a closure to be called when the XML document has been created. The XML is passed to the closure as a
parameter in form of a |
withXml(action) | Adds an action to be called when the XML document has been created. The XML is passed to the action as a
parameter in form of a |
void
beforeConfigured
(Closure
closure)
Adds a closure to be called before the domain object is configured by this task. The domain object is passed as a parameter to the closure.
The closure is executed after the domain object has been loaded from the input file. Using this method allows you to change the domain object in some way before the task configures it.
void
beforeConfigured
(Action
<? super T
>
action)
Action
<? super T
>Adds an action to be called before the domain object is configured by this task. The domain object is passed as a parameter to the action.
The action is executed after the domain object has been loaded from the input file. Using this method allows you to change the domain object in some way before the task configures it.
void
whenConfigured
(Closure
closure)
Adds a closure to be called after the domain object has been configured by this task. The domain object is passed as a parameter to the closure.
The closure is executed just before the domain object is written to the output file. Using this method allows you to override the configuration applied by this task.
void
whenConfigured
(Action
<? super T
>
action)
Action
<? super T
>Adds an action to be called after the domain object has been configured by this task. The domain object is passed as a parameter to the action.
The action is executed just before the domain object is written to the output file. Using this method allows you to override the configuration applied by this task.
void
withXml
(Closure
closure)
Adds a closure to be called when the XML document has been created. The XML is passed to the closure as a
parameter in form of a XmlProvider
. The closure can modify the XML before
it is written to the output file.
void
withXml
(Action
<? super XmlProvider
>
action)
Action
<? super XmlProvider
>Adds an action to be called when the XML document has been created. The XML is passed to the action as a
parameter in form of a XmlProvider
. The action can modify the XML before
it is written to the output file.