component-installation-plugin / com.intershop.gradle.component.installation.tasks / CleanUpTask

CleanUpTask

open class CleanUpTask : DefaultTask

This task will remove all not configured files and directories from the installation. The information is taken from the specified component descriptor. This task does not work incrementally.

Constructors

<init>

CleanUpTask()

This task will remove all not configured files and directories from the installation. The information is taken from the specified component descriptor. This task does not work incrementally.

Properties

backupDir

var backupDir: File

Backup directory of this task. It is used for special or unknown directories and files.

containerPaths

var containerPaths: Set<String>

Set of of all module containers of the component.

containersPath

var containersPath: String

Path of all containers of the component.

descriptorPath

var descriptorPath: String

Descriptor path configuration of the component.

directoryPaths

var directoryPaths: Set<String>

Set of of all directory paths of the component.

installDir

var installDir: File

The installation directory of the component. All items of the component will be installed to this directory.

libsPath

var libsPath: String

Path of all libraries of the component.

linkNames

var linkNames: Set<String>

Set of of all link names of the component.

modulePaths

var modulePaths: Set<String>

Set of of all module paths of the component.

modulesPath

var modulesPath: String

Path of all modules of the component.

Functions

cleanup

fun cleanup(): Unit

The task action of the task. Delete not configured directories or move these files or directories to the backup directory.

provideBackupDir

fun provideBackupDir(backupDir: Provider<Directory>): Unit

Set the provider for the backup directory property.

provideContainerPaths

fun provideContainerPaths(containerPaths: Provider<Set<String>>): Unit

Set the provider for the container path set property.

provideContainersPath

fun provideContainersPath(containersPath: Provider<String>): Unit

Set the provider for the containers path property.

provideDescriptorPath

fun provideDescriptorPath(descriptorPath: Provider<String>): Unit

Set the provider for the descriptor path property.

provideDirectoryPaths

fun provideDirectoryPaths(directoryPaths: Provider<Set<String>>): Unit

Set the provider for the directory set property.

provideInstallDir

fun provideInstallDir(installDir: Provider<Directory>): Unit

Set the provider for the installation directory property.

provideLibsPath

fun provideLibsPath(libsPath: Provider<String>): Unit

Set the provider for the libraries path property.

provideLinkNames

fun provideLinkNames(linkNames: Provider<Set<String>>): Unit

Set the provider for the link set property.

provideModulePaths

fun provideModulePaths(modulePaths: Provider<Set<String>>): Unit

Set the provider for the module path set property.

provideModulesPath

fun provideModulesPath(modulesPath: Provider<String>): Unit

Set the provider for the modules path property.