api / org.gradle.api.file / DeleteSpec

DeleteSpec

interface DeleteSpec

A specification for deleting files from the filesystem.

Functions

delete

abstract fun delete(vararg files: Any): DeleteSpec

Specifies the files to delete.

setFollowSymlinks

abstract fun setFollowSymlinks(followSymlinks: Boolean): Unit

Specifies whether or not symbolic links should be followed during deletion.

Inheritors

Delete

open class Delete : ConventionTask, DeleteSpec

Deletes files or directories. Example:

 task makePretty(type: Delete) { delete 'uglyFolder', 'uglyFile' followSymlinks = true } 
Be default symlinks will not be followed when deleting files. To change this behavior call Delete#setFollowSymlinks(boolean) with true. On systems that do not support symlinks, this will have no effect.