Package de.protos.etrice.gradle

Class GenerateTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.SourceTask

de.protos.etrice.gradle.GenerateTask

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, PatternFilterable, Configurable<Task>

@DisableCachingByDefault(because="Generator execution is an external process with unvalidated caching semantics")
public abstract class GenerateTask
extends SourceTask

Base task class for generator execution.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Named

Named.Namer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPTION_CLEAN
static final String	OPTION_GENDIR
static final String	OPTION_LOGLEVEL
static final String	OPTION_MODELPATH

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

Constructor	Description
GenerateTask(WorkerExecutor executor, ObjectFactory objects)	Creates a new task for a generator.

Method Summary

Modifier and Type	Method	Description
ConfigurableFileCollection	getClasspath()
Property<Boolean>	getDebug()	When enabled, the process is started suspended and listening on port 5005.
DirectoryProperty	getGenDir()
ConfigurableFileCollection	getModelpath()
Property<String>	getModule()
MapProperty<String,Object>	getOptions()

Methods inherited from class org.gradle.api.tasks.SourceTask

exclude, exclude, exclude, exclude, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source

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

conventionMapping, conventionMapping, getConventionMapping

Methods 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, usesService

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

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Task

doNotTrackState, notCompatibleWithConfigurationCache

Field Details

OPTION_GENDIR

public static final String OPTION_GENDIR

See Also:

• Constant Field Values

OPTION_MODELPATH

public static final String OPTION_MODELPATH

See Also:

• Constant Field Values

OPTION_CLEAN

public static final String OPTION_CLEAN

See Also:

• Constant Field Values

OPTION_LOGLEVEL

public static final String OPTION_LOGLEVEL

See Also:

• Constant Field Values

Constructor Details

GenerateTask

@Inject
public GenerateTask(WorkerExecutor executor,
 ObjectFactory objects)

Creates a new task for a generator.

Parameters:

executor - Gradle worker executor

objects - Gradle object factory

Method Details

getClasspath

@InputFiles
@Classpath
public ConfigurableFileCollection getClasspath()

Returns:

all files of the generator classpath

getModule

@Input
public Property<String> getModule()

Returns:

the symbolic name of the generator

getOptions

@Input
public MapProperty<String,Object> getOptions()

Returns:

All generator options

getGenDir

@OutputDirectory
public DirectoryProperty getGenDir()

Returns:

Directory for generated source files

getModelpath

@InputFiles
@PathSensitive(RELATIVE)
public ConfigurableFileCollection getModelpath()

Returns:

the modelpath for the generator

getDebug

@Input
public Property<Boolean> getDebug()

When enabled, the process is started suspended and listening on port 5005.

Returns:

whether to enable or disable debugging for the process