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 Summary
Nested classes/interfaces inherited from interface org.gradle.api.Task
Task.Namer -
Field Summary
Fields inherited from class org.gradle.plugins.ide.api.GeneratorTask
afterConfigured, beforeConfigured, domainObject, generatorFields inherited from interface org.gradle.api.Task
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE -
Constructor Summary
Constructors -
Method Summary
Modifier 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.GeneratorTask
getIncremental, getInputFile, getInputFileIfExists, getInstantiator, setInputFileMethods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTask
compareTo, 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.AbstractTask
acceptServiceReferences, 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.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.Task
doNotTrackState, getConvention, notCompatibleWithConfigurationCache
-
Constructor Details
-
GenerateIdeaModule
public GenerateIdeaModule() -
GenerateIdeaModule
-
-
Method Details
-
create
- Specified by:
createin classXmlGeneratorTask<Module>
-
configure
- Specified by:
configurein classXmlGeneratorTask<Module>
-
getXmlTransformer
public org.gradle.internal.xml.XmlTransformer getXmlTransformer()- Overrides:
getXmlTransformerin classXmlGeneratorTask<Module>
-
getOutputFile
Configures 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 classGeneratorTask<Module>- Returns:
- The output file.
-
setOutputFile
Description copied from class:GeneratorTaskSets the output file to write the final configuration to.- Overrides:
setOutputFilein classGeneratorTask<Module>- Parameters:
newOutputFile- The output file.
-
getModule
The Idea module model containing the details required to generate the module file. -
setModule
-