org.gradle.api.internal.externalresource.cached

Interface CachedExternalResource

All Known Implementing Classes:

DefaultCachedExternalResource

public interface CachedExternalResource

A record of some kind of external resource that has been cached locally (typically into the filestore). Note that this is not a kind of ExternalResource. There is an adapter that can represent a cached resource as an external resource as CachedExternalResourceAdapter.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCachedAt() The timestamp of when this cache entry was created.
File	getCachedFile() The cached version of the external resource as a local file.
long	getContentLength() Always the actual content length of the cached file, not the external source.
Date	getExternalLastModified() Null safe shortcut for getExternalResourceMetaData().getLastModified();
long	getExternalLastModifiedAsTimestamp() Null safe shortcut for getExternalResourceMetaData().getLastModified() as a timestamp.
ExternalResourceMetaData	getExternalResourceMetaData()
HashValue	getSha1() Always the actual checksum of the cached file, not the external source.
boolean	isMissing() True if this cache entry represents that the resource does not exist.

Method Detail

isMissing

boolean isMissing()

True if this cache entry represents that the resource does not exist. For a missing resource, all of the values will be null or similar ?non? values.

Returns:

Whether this is a ?missing? entry or not.

getCachedFile

@Nullable
File getCachedFile()

The cached version of the external resource as a local file.

Returns:

The cached version of the external resource as a local file, or null if this isMissing().

getCachedAt

long getCachedAt()

The timestamp of when this cache entry was created.

Returns:

The timestamp of when this cache entry was created.

getContentLength

long getContentLength()

Always the actual content length of the cached file, not the external source.

Returns:

The content length of the cached file.

getSha1

HashValue getSha1()

Always the actual checksum of the cached file, not the external source.

Returns:

The hash of the cached file.

getExternalResourceMetaData

@Nullable
ExternalResourceMetaData getExternalResourceMetaData()

getExternalLastModified

Date getExternalLastModified()

Null safe shortcut for getExternalResourceMetaData().getLastModified();

Returns:

The external last modified, or null if unavailable.

getExternalLastModifiedAsTimestamp

long getExternalLastModifiedAsTimestamp()

Null safe shortcut for getExternalResourceMetaData().getLastModified() as a timestamp.

Returns:

The external last modified as a timestamp, or < 0 if unavailable.