Package org.gradle.plugins.ide.idea
Class GenerateIdeaModule
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
- All Implemented Interfaces:
- Comparable<Task>,- org.gradle.api.internal.DynamicObjectAware,- org.gradle.api.internal.IConventionAware,- org.gradle.api.internal.TaskInternal,- Named,- ExtensionAware,- Task,- Configurable<Task>
@DisableCachingByDefault(because="Not made cacheable, yet")
public abstract class GenerateIdeaModule
extends XmlGeneratorTask<Module>
Generates an IDEA module file. If you want to fine tune the idea configuration
 
 Please refer to interesting examples on idea configuration in IdeaModule.
 
 At this moment nearly all configuration is done via IdeaModule.
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from class org.gradle.plugins.ide.api.GeneratorTaskafterConfigured, beforeConfigured, domainObject, generatorFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidprotected Modulecreate()The Idea module model containing the details required to generate the module file.Configures output *.iml file.org.gradle.internal.xml.XmlTransformervoidsetModule(IdeaModule module) voidsetOutputFile(File newOutputFile) Sets the output file to write the final configuration to.Methods inherited from class org.gradle.plugins.ide.api.GeneratorTaskgetIncremental, getInputFile, getInputFileIfExists, getInstantiator, setInputFileMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
GenerateIdeaModulepublic GenerateIdeaModule()
- 
GenerateIdeaModule
 
- 
- 
Method Details- 
create- Specified by:
- createin class- XmlGeneratorTask<Module>
 
- 
configure- Specified by:
- configurein class- XmlGeneratorTask<Module>
 
- 
getXmlTransformerpublic org.gradle.internal.xml.XmlTransformer getXmlTransformer()- Overrides:
- getXmlTransformerin class- XmlGeneratorTask<Module>
 
- 
getOutputFileConfigures output *.iml file. It's optional because the task should configure it correctly for you (including making sure it is unique in the multi-module build). If you really need to change the output file name it is much easier to do it via the idea.module.name property.Please refer to documentation in IdeaModulename property. In IntelliJ IDEA the module name is the same as the name of the *.iml file.- Overrides:
- getOutputFilein class- GeneratorTask<Module>
- Returns:
- The output file.
 
- 
setOutputFileDescription copied from class:GeneratorTaskSets the output file to write the final configuration to.- Overrides:
- setOutputFilein class- GeneratorTask<Module>
- Parameters:
- newOutputFile- The output file.
 
- 
getModuleThe Idea module model containing the details required to generate the module file.
- 
setModule
 
-