Interface EnhancedTask

All Superinterfaces:

Comparable<Task>, EnhancedPluginAdditions, ExtensionAware, Named, Task

public interface EnhancedTask
extends Task, EnhancedPluginAdditions

The enhanced task contains a handful of helper methods to make working with the enhanced plugin and caches easier.

Nested Class Summary

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

Task.Namer

Field Summary

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

Method Summary

Modifier and Type	Method	Description
default Provider<Directory>	getDefaultOutputDirectory()	The default output directory to use for this task if it outputs a directory.
default Provider<RegularFile>	getDefaultOutputFile()	The default output file to use for this task if it outputs a file.
default Provider<RegularFile>	getDefaultOutputFile(String ext)	The default output file to use for this task if it outputs a file.
default EnhancedPlugin<? super Project>	getPlugin()	Deprecated. This method is public only due to the limitations imposed by Java 8.
default Provider<File>	getTool(Tool tool)	Gets a provider to the file for a Tool to be used.
default DirectoryProperty	globalCaches()	Gets the global caches to be used for this plugin.
default DirectoryProperty	localCaches()	Gets the local caches to be used for this plugin.
Class<? extends EnhancedPlugin<? super Project>>	pluginType()	The enhanced plugin type for this task.
default DirectoryProperty	workingProjectDirectory()	Gets the working project directory to be used for this plugin.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.gradle.api.plugins.ExtensionAware

getExtensions

Methods inherited from interface org.gradle.api.Task

configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, getActions, getAnt, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Method Details

pluginType

Class<? extends EnhancedPlugin<? super Project>> pluginType()

The enhanced plugin type for this task.

Returns:

The plugin type

getPlugin

@Deprecated
@Internal
default EnhancedPlugin<? super Project> getPlugin()

Deprecated.

This method is public only due to the limitations imposed by Java 8. Do not use this. Use Task.getProject() -> PluginAware.getPlugins() -> PluginContainer.getPlugin(Class).

Gets the enhanced plugin used by this task as defined in pluginType().

Returns:

The enhanced plugin

getTool

default Provider<File> getTool(Tool tool)

Description copied from interface: EnhancedPluginAdditions

Gets a provider to the file for a Tool to be used. The tool's state is managed by Gradle through the ValueSource API and will not cause caching issues.

Specified by:

getTool in interface EnhancedPluginAdditions

Parameters:

tool - The tool to get

Returns:

A provider for the tool file

globalCaches

default DirectoryProperty globalCaches()

Description copied from interface: EnhancedPluginAdditions

Gets the global caches to be used for this plugin. These caches persist between projects and should be used to eliminate excess work done by projects that request the same data.

It is stored in ~/.gradle/caches/minecraftforge/plugin.

Specified by:

globalCaches in interface EnhancedPluginAdditions

Returns:

The global caches

localCaches

default DirectoryProperty localCaches()

Description copied from interface: EnhancedPluginAdditions

Gets the local caches to be used for this plugin. Data done by tasks that should not be shared between projects should be stored here.

It is located in project/build/minecraftforge/plugin.

Specified by:

localCaches in interface EnhancedPluginAdditions

Returns:

The global caches

workingProjectDirectory

default DirectoryProperty workingProjectDirectory()

Description copied from interface: EnhancedPluginAdditions

Gets the working project directory to be used for this plugin. This directory is either the ProjectLayout.getProjectDirectory() of the Project or the BuildLayout.getRootDirectory() of the Settings. Attempting to call this when the plugin target is not either type will throw an exception.

It is located in project/build/minecraftforge/plugin.

Specified by:

workingProjectDirectory in interface EnhancedPluginAdditions

Returns:

The working project directory

getDefaultOutputDirectory

@Internal
default Provider<Directory> getDefaultOutputDirectory()

The default output directory to use for this task if it outputs a directory.

Returns:

A provider for the directory

getDefaultOutputFile

@Internal
default Provider<RegularFile> getDefaultOutputFile()

The default output file to use for this task if it outputs a file. Uses the .jar extension.

Returns:

A provider for the file

getDefaultOutputFile

default Provider<RegularFile> getDefaultOutputFile(String ext)

The default output file to use for this task if it outputs a file.

Parameters:

ext - The extension to use for the file

Returns:

A provider for the file