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>, DynamicObjectAware, IConventionAware, TaskInternal, ExtensionAware, Task, Configurable<Task>

Direct Known Subclasses:

PropertiesGeneratorTask, XmlGeneratorTask

public class GeneratorTask<T>
extends 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

Fields

Modifier and Type	Field and Description
protected ActionBroadcast<T>	afterConfigured
protected ActionBroadcast<T>	beforeConfigured
protected T	domainObject
protected Generator<T>	generator

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
GeneratorTask()

Method Summary

Methods

Modifier and Type	Method and Description
File	getInputFile() The input file to load the initial configuration from.
File	getOutputFile() The output file to write the final configuration to.
void	setInputFile(File inputFile) Sets the input file to load the initial configuration from.
void	setOutputFile(File outputFile) Sets the output file to write the final configuration to.

Methods inherited from class org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.internal.AbstractTask

addValidator, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getExtensions, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

beforeConfigured

protected final ActionBroadcast<T> beforeConfigured

afterConfigured

protected final ActionBroadcast<T> afterConfigured

generator

protected Generator<T> generator

domainObject

protected T domainObject

Constructor Detail

GeneratorTask

public GeneratorTask()

Method Detail

getInputFile

public File 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.

setInputFile

public void setInputFile(File inputFile)

Sets the input file to load the initial configuration from.

Parameters:

inputFile - The input file. Use null to use the output file.

getOutputFile

public File getOutputFile()

The output file to write the final configuration to.

Returns:

The output file.

setOutputFile

public void setOutputFile(File outputFile)

Sets the output file to write the final configuration to.

Parameters:

outputFile - The output file.