Package com.mooltiverse.oss.nyx.gradle

Class CleanTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.mooltiverse.oss.nyx.gradle.CoreTask

com.mooltiverse.oss.nyx.gradle.CleanTask

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, org.gradle.util.Configurable<Task>

public abstract class CleanTask
extends CoreTask

The task running the Clean command by invoking the Nyx.clean() method on the backing Nyx instance.

Nested Class Summary

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

Task.Namer

Field Summary

Fields

Modifier and Type	Field	Description
static String	DESCRIPTION	The description of the task.
static String	GROUP	The group the tasks belong to.
static String	NAME	The name of the task.

Fields inherited from class com.mooltiverse.oss.nyx.gradle.CoreTask

NYX_INSTANCE_PROPERTY, NYX_STATE_PROPERTY

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
CleanTask(NyxExtension extension)	Standard constructor.

Method Summary

Modifier and Type	Method	Description
void	clean()	The actual business method for this task.

Methods inherited from class com.mooltiverse.oss.nyx.gradle.CoreTask

getExtension, hasSharedProperty, nyx, retrieveSharedProperty, state, storeSharedProperty

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, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

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

appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, setImpliesSubProjects, setLoggerMessageRewriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.Task

getConvention

Field Detail

DESCRIPTION

public static final String DESCRIPTION

The description of the task. This also appears in Gradle help.

See Also:

Constant Field Values

NAME

public static final String NAME

The name of the task. This is the name of the task to use inside Gradle scripts.

See Also:

Constant Field Values

GROUP

public static final String GROUP

The group the tasks belong to.

See Also:

Constant Field Values

Constructor Detail

CleanTask

@Inject
public CleanTask(NyxExtension extension)

Standard constructor.

Parameters:

extension - the extension object. Cannot be null. This is injected by Gradle because it's passed as an optional constructor argument by the NyxPlugin definition method.

Method Detail

clean

public void clean()
           throws NyxException

The actual business method for this task. This method runs the Nyx.clean() method on the shared singleton Nyx instance. Gradle knows this is the method to run upon task execution thanks to the TaskAction annotation.

Throws:

NyxException - in case of any exception when invoking the backing instance