org.gradle.api.internal.externalresource.cached

Class DefaultCachedExternalResourceIndex<K extends Serializable>

java.lang.Object

org.gradle.api.internal.externalresource.cached.DefaultCachedExternalResourceIndex<K>

All Implemented Interfaces:

CachedExternalResourceIndex<K>

Direct Known Subclasses:

ArtifactAtRepositoryCachedExternalResourceIndex, ByUrlCachedExternalResourceIndex

public class DefaultCachedExternalResourceIndex<K extends Serializable>
extends Object
implements CachedExternalResourceIndex<K>

Constructor Summary

Constructors

Constructor and Description
DefaultCachedExternalResourceIndex(File persistentCacheFile, Class<K> keyType, TimeProvider timeProvider, CacheLockingManager cacheLockingManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(K key) Remove the entry for the given key if it exists.
CachedExternalResource	lookup(K key) Lookup a cached resolution.
void	store(K key, File artifactFile, ExternalResourceMetaData externalResourceMetaData) Adds a resolution to the index.
void	storeMissing(K key) Record that the artifact with the given key was missing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCachedExternalResourceIndex

public DefaultCachedExternalResourceIndex(File persistentCacheFile,
                                  Class<K> keyType,
                                  TimeProvider timeProvider,
                                  CacheLockingManager cacheLockingManager)

Method Detail

store

public void store(K key,
         File artifactFile,
         ExternalResourceMetaData externalResourceMetaData)

Description copied from interface: CachedExternalResourceIndex

Adds a resolution to the index. The incoming file is expected to be in the persistent local. This method will not move/copy the file there.

Specified by:

store in interface CachedExternalResourceIndex<K extends Serializable>

Parameters:

key - The key to cache this resolution under in the index. Cannot be null.

artifactFile - The artifact file in the persistent file store. Cannot be null

externalResourceMetaData - Information about this resource at its source

See Also:

CachedExternalResourceIndex.storeMissing(Object)

storeMissing

public void storeMissing(K key)

Description copied from interface: CachedExternalResourceIndex

Record that the artifact with the given key was missing.

Specified by:

storeMissing in interface CachedExternalResourceIndex<K extends Serializable>

Parameters:

key - The key to cache this resolution under in the index.

lookup

public CachedExternalResource lookup(K key)

Description copied from interface: CachedExternalResourceIndex

Lookup a cached resolution. The CachedExternalResource.getCachedFile() is guaranteed to exist at the time that the entry is returned from this method.

Specified by:

lookup in interface CachedExternalResourceIndex<K extends Serializable>

Parameters:

key - The key to search the index for

Returns:

The cached artifact resolution if one exists, otherwise null.

clear

public void clear(K key)

Description copied from interface: CachedExternalResourceIndex

Remove the entry for the given key if it exists.

Specified by:

clear in interface CachedExternalResourceIndex<K extends Serializable>

Parameters:

key - The key of the item to remove.