Package org.gradle.plugins.ide.api
Class GeneratorTask<T>
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.plugins.ide.api.GeneratorTask<T>
- Type Parameters:
T- The domain object for the configuration file.
- 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>
- Direct Known Subclasses:
GenerateSolutionFileTask,PropertiesGeneratorTask,PropertyListGeneratorTask,XmlGeneratorTask
@DisableCachingByDefault(because="Abstract super-class, not to be instantiated directly")
public abstract class GeneratorTask<T>
extends org.gradle.api.internal.ConventionTask
A GeneratorTask generates a configuration file based on a domain object of type T.
When executed the task:
- loads the object from the input file, if it exists.
- Calls the beforeConfigured actions, passing the object to each action.
- Configures the object in some task-specific way.
- Calls the afterConfigured actions, passing the object to each action.
- writes the object to the output file.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.gradle.api.Task
Task.Namer -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final org.gradle.internal.MutableActionSet<T>protected final org.gradle.internal.MutableActionSet<T>protected Tprotected org.gradle.plugins.ide.internal.generator.generator.Generator<T>Fields 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 booleanWhether this generator task can be treated as an incremental task or notThe input file to load the initial configuration from.protected Fileprotected org.gradle.internal.reflect.InstantiatorThe output file to write the final configuration to.voidsetInputFile(File inputFile) Sets the input file to load the initial configuration from.voidsetOutputFile(File outputFile) Sets the output file to write the final configuration to.Methods 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
-
Field Details
-
beforeConfigured
-
afterConfigured
-
generator
-
domainObject
-
-
Constructor Details
-
GeneratorTask
public GeneratorTask()
-
-
Method Details
-
getIncremental
Whether this generator task can be treated as an incremental task or not- Since:
- 4.7
-
getInstantiator
@Inject protected org.gradle.internal.reflect.Instantiator getInstantiator() -
getInputFile
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.- Returns:
- The input file.
-
getInputFileIfExists
-
setInputFile
Sets the input file to load the initial configuration from.- Parameters:
inputFile- The input file. Use null to use the output file.
-
getOutputFile
The output file to write the final configuration to.- Returns:
- The output file.
-
setOutputFile
Sets the output file to write the final configuration to.- Parameters:
outputFile- The output file.
-