org.gradle.cache

Interface CacheBuilder<T>

All Known Subinterfaces:

DirectoryCacheBuilder, ObjectCacheBuilder<E,T>

public interface CacheBuilder<T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CacheBuilder.VersionStrategy

Method Summary

Methods

Modifier and Type	Method and Description
CacheBuilder<T>	forObject(Object target) Specifies the target domain object.
T	open() Opens the cache.
CacheBuilder<T>	withProperties(Map<String,?> properties) Specifies the additional key properties for the cache.
CacheBuilder<T>	withValidator(CacheValidator validator) Specifies a cache validator for this cache.
CacheBuilder<T>	withVersionStrategy(CacheBuilder.VersionStrategy strategy) Specifies the versioning strategy for this cache.

Method Detail

withProperties

CacheBuilder<T> withProperties(Map<String,?> properties)

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.

Parameters:

properties - additional properties for the cache.

Returns:

this

forObject

CacheBuilder<T> forObject(Object target)

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.

Parameters:

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

Returns:

this

withVersionStrategy

CacheBuilder<T> withVersionStrategy(CacheBuilder.VersionStrategy strategy)

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

Parameters:

strategy - The strategy

Returns:

this

withValidator

CacheBuilder<T> withValidator(CacheValidator validator)

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

Parameters:

validator - The validator

Returns:

this

open

T open()
       throws CacheOpenException

Opens the cache.

Returns:

The cache.

Throws:

CacheOpenException