org.gradle.api.internal.externalresource.cached

Interface CachedExternalResourceIndex<K>

Type Parameters:

K - The type of the key to the index

All Known Implementing Classes:

ArtifactAtRepositoryCachedExternalResourceIndex, ByUrlCachedExternalResourceIndex, DefaultCachedExternalResourceIndex

public interface CachedExternalResourceIndex<K>

Provides an indexed view into cached artifacts and a record of resolution attempts, successful or not. Maintains references to the location of files in the persistent local. Does not deal with moving files into the local.

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 metaData) Adds a resolution to the index.
void	storeMissing(K key) Record that the artifact with the given key was missing.

Method Detail

store

void store(K key,
         File artifactFile,
         @Nullable
         ExternalResourceMetaData metaData)

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.

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

metaData - Information about this resource at its source

See Also:

storeMissing(Object)

storeMissing

void storeMissing(K key)

Record that the artifact with the given key was missing.

Parameters:

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

lookup

@Nullable
CachedExternalResource lookup(K key)

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

Parameters:

key - The key to search the index for

Returns:

The cached artifact resolution if one exists, otherwise null.

clear

void clear(K key)

Remove the entry for the given key if it exists.

Parameters:

key - The key of the item to remove.