CacheEvent
| com.facebook.cache.common.CacheEvent |
 Known Indirect Subclasses
|
Class Overview
Interface to provide details of an individual cache event.
All values may be null depending on the kind of event. See the docs for each method to see when to expect values to be available.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract CacheKey |
getCacheKey()
Gets the cache key related to this event.
| ||||||||||
| abstract long |
getCacheLimit()
Gets the current size limit for the cache, in bytes.
| ||||||||||
| abstract long |
getCacheSize()
Gets the total size of the resources currently in storage, in bytes.
| ||||||||||
| abstract CacheEventListener.EvictionReason |
getEvictionReason()
Gets the reason for an item's eviction in eviction events.
| ||||||||||
| abstract IOException |
getException()
Gets the exception which occurred to trigger a read or write exception event.
| ||||||||||
| abstract long |
getItemSize()
Gets the size of the new resource in storage, in bytes.
| ||||||||||
| abstract String |
getResourceId()
Gets the resource ID for the cached item.
| ||||||||||
Public Methods
public abstract CacheKey getCacheKey ()
Gets the cache key related to this event.
This should be present for all events other than eviction.
public abstract long getCacheLimit ()
Gets the current size limit for the cache, in bytes.
This is present in eviction events where the eviction is due to the need to trim for size.
public abstract long getCacheSize ()
Gets the total size of the resources currently in storage, in bytes.
This is present in write success and eviction events.
public abstract CacheEventListener.EvictionReason getEvictionReason ()
Gets the reason for an item's eviction in eviction events.
public abstract IOException getException ()
Gets the exception which occurred to trigger a read or write exception event.
public abstract long getItemSize ()
Gets the size of the new resource in storage, in bytes.
This is present in write success and eviction events.
public abstract String getResourceId ()
Gets the resource ID for the cached item.
This is present in cache hit, write success, read and write exceptions and evictions.
It may also be present in cache miss events if an ID was found in the cache's index but the resource wasn't then found in storage.