org.gradle.cache

Interface DirectoryCacheBuilder

All Superinterfaces:

CacheBuilder<PersistentCache>

public interface DirectoryCacheBuilder
extends CacheBuilder<PersistentCache>

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.cache.CacheBuilder

CacheBuilder.VersionStrategy

Method Summary

Methods

Modifier and Type	Method and Description
DirectoryCacheBuilder	forObject(Object target) Specifies the target domain object.
DirectoryCacheBuilder	withDisplayName(String displayName) Specifies the display name for this cache.
DirectoryCacheBuilder	withInitializer(Action<? super PersistentCache> initializer) Specifies an action to execute to initialize the cache contents, if the cache does not exist or is invalid.
DirectoryCacheBuilder	withLockMode(FileLockManager.LockMode lockMode) Specifies the initial lock mode to use.
DirectoryCacheBuilder	withProperties(Map<String,?> properties) Specifies the additional key properties for the cache.
DirectoryCacheBuilder	withValidator(CacheValidator validator) Specifies a cache validator for this cache.
DirectoryCacheBuilder	withVersionStrategy(CacheBuilder.VersionStrategy strategy) Specifies the versioning strategy for this cache.

Methods inherited from interface org.gradle.cache.CacheBuilder

open

Method Detail

withVersionStrategy

DirectoryCacheBuilder withVersionStrategy(CacheBuilder.VersionStrategy strategy)

Description copied from interface: CacheBuilder

Specifies the versioning strategy for this cache. The default is CacheBuilder.VersionStrategy.CachePerVersion.

Specified by:

withVersionStrategy in interface CacheBuilder<PersistentCache>

Parameters:

strategy - The strategy

Returns:

this

withProperties

DirectoryCacheBuilder withProperties(Map<String,?> properties)

Description copied from interface: CacheBuilder

Specifies the additional key properties for the cache. The cache is treated as invalid if any of the properties do not match the properties used to create the cache. The default for this is an empty map.

Specified by:

withProperties in interface CacheBuilder<PersistentCache>

Parameters:

properties - additional properties for the cache.

Returns:

this

forObject

DirectoryCacheBuilder forObject(Object target)

Description copied from interface: CacheBuilder

Specifies the target domain object. This might be a task, project, or similar. The cache is scoped for the given target object. The default is to use a globally-scoped cache.

Specified by:

forObject in interface CacheBuilder<PersistentCache>

Parameters:

target - The target domain object which the cache is for.

Returns:

this

withDisplayName

DirectoryCacheBuilder withDisplayName(String displayName)

Specifies the display name for this cache. This display name is used in logging and error messages.

withLockMode

DirectoryCacheBuilder withLockMode(FileLockManager.LockMode lockMode)

Specifies the initial lock mode to use. See PersistentCache for details.

Note that not every combination of cache type and lock mode is supported.

withInitializer

DirectoryCacheBuilder withInitializer(Action<? super PersistentCache> initializer)

Specifies an action to execute to initialize the cache contents, if the cache does not exist or is invalid. An exclusive lock is held while the initializer is executing, to prevent cross-process access.

withValidator

DirectoryCacheBuilder withValidator(CacheValidator validator)

Description copied from interface: CacheBuilder

Specifies a cache validator for this cache. If CacheValidator.isValid() results in false, the Cache is considered as invalid.

Specified by:

withValidator in interface CacheBuilder<PersistentCache>

Parameters:

validator - The validator

Returns:

this