com.facebook.buck.artifact_cache

Class CacheResult

java.lang.Object

com.facebook.buck.artifact_cache.CacheResult

public abstract class CacheResult
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static CacheResult	SKIPPED_RESULT

Constructor Summary

Constructors

Constructor and Description
CacheResult()

Method Summary

Modifier and Type	Method and Description
abstract Optional<Long>	artifactSizeBytes()
abstract Optional<String>	cacheError()
abstract Optional<ArtifactCacheMode>	cacheMode()
protected abstract Optional<String>	cacheSource()
protected void	check()
static CacheResult	contains(String cacheSource, ArtifactCacheMode cacheMode)
static CacheResult	error(String cacheSource, ArtifactCacheMode cacheMode, String cacheError)
long	getArtifactSizeBytes()
String	getCacheError()
String	getCacheSource()
com.google.common.collect.ImmutableMap<String,String>	getMetadata()
abstract CacheResultType	getType()
static CacheResult	hit(String cacheSource, ArtifactCacheMode cacheMode)
static CacheResult	hit(String cacheSource, ArtifactCacheMode cacheMode, com.google.common.collect.ImmutableMap<String,String> metadata, long artifactSize)
static CacheResult	ignored()
static CacheResult	localKeyUnchangedHit()
abstract Optional<com.google.common.collect.ImmutableMap<String,String>>	metadata()
static CacheResult	miss()
static CacheResult	miss(String cacheSource, ArtifactCacheMode cacheMode)
String	name()
static CacheResult	of(CacheResultType type, String cacheSource)
static CacheResult	skipped()
static CacheResult	softError(String cacheSource, ArtifactCacheMode cacheMode, String cacheError)
String	toString()
abstract Optional<String>	twoLevelContentHashKey()
static CacheResult	valueOf(String val)
CacheResult	withArtifactSizeBytes(Optional<Long> artifactSizeBytes)
CacheResult	withCacheError(Optional<String> cacheError)
CacheResult	withMetadata(Optional<com.google.common.collect.ImmutableMap<String,String>> metadata)
CacheResult	withTwoLevelContentHashKey(Optional<String> twoLevelContentHashKey)

Methods inherited from class java.lang.Object

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

Field Detail

SKIPPED_RESULT

public static final CacheResult SKIPPED_RESULT

Constructor Detail

CacheResult

public CacheResult()

Method Detail

getType

public abstract CacheResultType getType()

cacheSource

protected abstract Optional<String> cacheSource()

cacheMode

public abstract Optional<ArtifactCacheMode> cacheMode()

cacheError

public abstract Optional<String> cacheError()

metadata

public abstract Optional<com.google.common.collect.ImmutableMap<String,String>> metadata()

artifactSizeBytes

public abstract Optional<Long> artifactSizeBytes()

twoLevelContentHashKey

public abstract Optional<String> twoLevelContentHashKey()

getCacheSource

public String getCacheSource()

getCacheError

public String getCacheError()

getMetadata

public com.google.common.collect.ImmutableMap<String,String> getMetadata()

getArtifactSizeBytes

public long getArtifactSizeBytes()

name

public String name()

hit

public static CacheResult hit(String cacheSource,
                              ArtifactCacheMode cacheMode,
                              com.google.common.collect.ImmutableMap<String,String> metadata,
                              long artifactSize)

hit

public static CacheResult hit(String cacheSource,
                              ArtifactCacheMode cacheMode)

miss

public static CacheResult miss(String cacheSource,
                               ArtifactCacheMode cacheMode)

error

public static CacheResult error(String cacheSource,
                                ArtifactCacheMode cacheMode,
                                String cacheError)

softError

public static CacheResult softError(String cacheSource,
                                    ArtifactCacheMode cacheMode,
                                    String cacheError)

of

public static CacheResult of(CacheResultType type,
                             String cacheSource)

skipped

public static CacheResult skipped()

miss

public static CacheResult miss()

ignored

public static CacheResult ignored()

contains

public static CacheResult contains(String cacheSource,
                                   ArtifactCacheMode cacheMode)

localKeyUnchangedHit

public static CacheResult localKeyUnchangedHit()

valueOf

public static CacheResult valueOf(String val)

Returns:

a CacheResult constructed from trying to parse the given string representation. This is mainly available for backwards compatibility for when this class was an enum.

toString

public String toString()

Overrides:

toString in class Object

check

@Value.Check
protected void check()

withCacheError

public CacheResult withCacheError(Optional<String> cacheError)

withTwoLevelContentHashKey

public CacheResult withTwoLevelContentHashKey(Optional<String> twoLevelContentHashKey)

withMetadata

public CacheResult withMetadata(Optional<com.google.common.collect.ImmutableMap<String,String>> metadata)

withArtifactSizeBytes

public CacheResult withArtifactSizeBytes(Optional<Long> artifactSizeBytes)