Package org.gradle.api.tasks

Interface TaskOutputFilePropertyBuilder

All Superinterfaces:

CompatibilityAdapterForTaskOutputs, TaskFilePropertyBuilder, TaskOutputs, TaskPropertyBuilder

public interface TaskOutputFilePropertyBuilder
extends TaskFilePropertyBuilder, TaskOutputs

Describes an output property of a task that contains zero or more files.

Since:

3.0

Method Summary

Modifier and Type	Method	Description
TaskOutputFilePropertyBuilder	dir(java.lang.Object path)	Deprecated. Use TaskOutputs.dir(Object) instead.
TaskOutputFilePropertyBuilder	file(java.lang.Object path)	Deprecated. Use TaskOutputs.file(Object) instead.
TaskOutputFilePropertyBuilder	files(java.lang.Object... paths)	Deprecated. Use TaskOutputs.files(Object...) instead.
FileCollection	getFiles()	Deprecated. Use TaskOutputs.getFiles() instead.
boolean	getHasOutput()	Deprecated. Use TaskOutputs.getHasOutput() instead.
TaskOutputFilePropertyBuilder	optional()	Marks a task property as optional.
TaskOutputFilePropertyBuilder	optional(boolean optional)	Sets whether the task property is optional.
void	upToDateWhen(groovy.lang.Closure upToDateClosure)	Deprecated. Use TaskOutputs.upToDateWhen(Closure) instead.
void	upToDateWhen(Spec<? super Task> upToDateSpec)	Deprecated. Use TaskOutputs.upToDateWhen(Spec) instead.
TaskOutputFilePropertyBuilder	withPropertyName(java.lang.String propertyName)	Sets the name for this property.

Methods inherited from interface org.gradle.api.tasks.TaskOutputs

cacheIf, cacheIf, dirs, doNotCacheIf

Method Detail

withPropertyName

TaskOutputFilePropertyBuilder withPropertyName(java.lang.String propertyName)

Sets the name for this property. The name must be a non-empty string.

If the method is not called, or if it is called with null, a name will be assigned to the property automatically.

Specified by:

withPropertyName in interface TaskFilePropertyBuilder

optional

TaskOutputFilePropertyBuilder optional()

Marks a task property as optional. This means that a value does not have to be specified for the property, but any value specified must meet the validation constraints for the property.

optional

TaskOutputFilePropertyBuilder optional(boolean optional)

Sets whether the task property is optional. If the task property is optional, it means that a value does not have to be specified for the property, but any value specified must meet the validation constraints for the property.

upToDateWhen

@Deprecated
void upToDateWhen(groovy.lang.Closure upToDateClosure)

Deprecated. Use TaskOutputs.upToDateWhen(Closure) instead.

Throws UnsupportedOperationException.

Specified by:

upToDateWhen in interface TaskOutputs

Parameters:

upToDateClosure - The closure to use to determine whether the task outputs are up-to-date.

upToDateWhen

@Deprecated
void upToDateWhen(Spec<? super Task> upToDateSpec)

Deprecated. Use TaskOutputs.upToDateWhen(Spec) instead.

Throws UnsupportedOperationException.

Specified by:

upToDateWhen in interface TaskOutputs

Parameters:

upToDateSpec - The spec to use to determine whether the task outputs are up-to-date.

getHasOutput

@Deprecated
boolean getHasOutput()

Deprecated. Use TaskOutputs.getHasOutput() instead.

Throws UnsupportedOperationException.

Specified by:

getHasOutput in interface TaskOutputs

Returns:

true if this task has declared any outputs, otherwise false.

getFiles

@Deprecated
FileCollection getFiles()

Deprecated. Use TaskOutputs.getFiles() instead.

Throws UnsupportedOperationException.

Specified by:

getFiles in interface TaskOutputs

Returns:

The output files. Returns an empty collection if this task has no output files.

files

@Deprecated
TaskOutputFilePropertyBuilder files(java.lang.Object... paths)

Deprecated. Use TaskOutputs.files(Object...) instead.

Throws UnsupportedOperationException.

Specified by:

files in interface CompatibilityAdapterForTaskOutputs

Specified by:

files in interface TaskOutputs

Parameters:

paths - The output files.

Returns:

this

See Also:

CacheableTask

file

@Deprecated
TaskOutputFilePropertyBuilder file(java.lang.Object path)

Deprecated. Use TaskOutputs.file(Object) instead.

Throws UnsupportedOperationException.

Specified by:

file in interface CompatibilityAdapterForTaskOutputs

Specified by:

file in interface TaskOutputs

Parameters:

path - The output file. The given path is evaluated as per Project.file(Object).

Returns:

a property builder to further configure this property.

dir

@Deprecated
TaskOutputFilePropertyBuilder dir(java.lang.Object path)

Deprecated. Use TaskOutputs.dir(Object) instead.

Throws UnsupportedOperationException.

Specified by:

dir in interface CompatibilityAdapterForTaskOutputs

Specified by:

dir in interface TaskOutputs

Parameters:

path - The output directory. The given path is evaluated as per Project.file(Object).

Returns:

a property builder to further configure this property.