CacheDataSource.Factory

@MonotonicNonNull
public @MonotonicNonNull Cache cache

public CacheKeyFactory cacheKeyFactory

public @Nullable PriorityTaskManager upstreamPriorityTaskManager

public Factory()

public CacheDataSource createDataSource()

Creates a DataSource instance.

public CacheDataSource createDataSourceForDownloading()

Returns an instance suitable for downloading content. The created instance is equivalent to one that would be created by createDataSource, except:

• The FLAG_BLOCK_ON_CACHE is always set.
• The task priority is overridden to be PRIORITY_DOWNLOAD.

public CacheDataSource createDataSourceForRemovingDownload()

Returns an instance suitable for reading cached content as part of removing a download. The created instance is equivalent to one that would be created by createDataSource, except:

• The upstream is overridden to be null, since when removing content we don't want to request anything that's not already cached.
• The FLAG_BLOCK_ON_CACHE is always set.
• The task priority is overridden to be PRIORITY_DOWNLOAD.

public @Nullable Cache getCache()

Returns the cache that will be used, or null if setCache has yet to be called.

public CacheKeyFactory getCacheKeyFactory()

Returns the CacheKeyFactory that will be used.

public @Nullable PriorityTaskManager getUpstreamPriorityTaskManager()

Returns the PriorityTaskManager that will bs used when requesting data from upstream, or null if there is none.

@CanIgnoreReturnValue
public CacheDataSource.Factory setCache(Cache cache)

Sets the cache that will be used.

Must be called before the factory is used.

@CanIgnoreReturnValue
public CacheDataSource.Factory setCacheKeyFactory(CacheKeyFactory cacheKeyFactory)

Sets the CacheKeyFactory.

The default is DEFAULT.

@CanIgnoreReturnValue
public CacheDataSource.Factory setCacheReadDataSourceFactory(
    DataSource.Factory cacheReadDataSourceFactory
)

Sets the DataSource.Factory for DataSources for reading from the cache.

The default is a FileDataSource.Factory in its default configuration.

@CanIgnoreReturnValue
public CacheDataSource.Factory setCacheWriteDataSinkFactory(
    @Nullable DataSink.Factory cacheWriteDataSinkFactory
)

Sets the DataSink.Factory for generating DataSinks for writing data to the cache. Passing null causes the cache to be read-only.

The default is a CacheDataSink.Factory in its default configuration.

@CanIgnoreReturnValue
public CacheDataSource.Factory setEventListener(@Nullable CacheDataSource.EventListener eventListener)

Sets the {link EventListener} to which events are delivered.

The default is null.

@CanIgnoreReturnValue
public CacheDataSource.Factory setFlags(@CacheDataSource.Flags int flags)

Sets the CacheDataSource.Flags.

The default is 0.

@CanIgnoreReturnValue
public CacheDataSource.Factory setUpstreamDataSourceFactory(
    @Nullable DataSource.Factory upstreamDataSourceFactory
)

Sets the DataSource.Factory for upstream DataSources, which are used to read data in the case of a cache miss.

The default is null, and so this method must be called before the factory is used in order for data to be read from upstream in the case of a cache miss.

@CanIgnoreReturnValue
public CacheDataSource.Factory setUpstreamPriority(int upstreamPriority)

Sets the priority to use when requesting data from upstream. The priority is only used if a PriorityTaskManager is set by calling setUpstreamPriorityTaskManager.

The default is PRIORITY_PLAYBACK.

@CanIgnoreReturnValue
public CacheDataSource.Factory setUpstreamPriorityTaskManager(
    @Nullable PriorityTaskManager upstreamPriorityTaskManager
)

Sets an optional PriorityTaskManager to use when requesting data from upstream.

If set, reads from the upstream DataSource will only be allowed to proceed if there are no higher priority tasks registered to the PriorityTaskManager. If there exists a higher priority task then PriorityTaskManager.PriorityTooLowException will be thrown instead.

Note that requests to CacheDataSource instances are intended to be used as parts of (possibly larger) tasks that are registered with the PriorityTaskManager, and hence CacheDataSource does not register a task by itself. This must be done by the surrounding code that uses the CacheDataSource instances.

The default is null.