com.google.android.exoplayer2.upstream

Class Loader

java.lang.Object

com.google.android.exoplayer2.upstream.Loader

All Implemented Interfaces:

LoaderErrorThrower

public final class Loader
extends java.lang.Object
implements LoaderErrorThrower

Manages the background loading of Loader.Loadables.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Loader.Callback<T extends Loader.Loadable> A callback to be notified of Loader events.
static interface	Loader.Loadable An object that can be loaded using a Loader.
static class	Loader.LoadErrorAction Action that can be taken in response to Callback#onLoadError(Loadable, long, long, IOException, int).
static interface	Loader.ReleaseCallback A callback to be notified when a Loader has finished being released.
static class	Loader.UnexpectedLoaderException Thrown when an unexpected exception or error is encountered during loading.

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.upstream.LoaderErrorThrower

LoaderErrorThrower.Dummy

Field Summary

Fields

Modifier and Type	Field and Description
static Loader.LoadErrorAction	DONT_RETRY Discards the failed loading task and ignores any errors that have occurred.
static Loader.LoadErrorAction	DONT_RETRY_FATAL Discards the failed load.
static Loader.LoadErrorAction	RETRY Retries the load using the default delay.
static Loader.LoadErrorAction	RETRY_RESET_ERROR_COUNT Retries the load using the default delay and resets the error count.

Constructor Summary

Constructors

Constructor and Description
Loader(java.lang.String threadName)

Method Summary

Modifier and Type	Method and Description
void	cancelLoading() Cancels the current load.
static Loader.LoadErrorAction	createRetryAction(boolean resetErrorCount, long retryDelayMillis) Creates a Loader.LoadErrorAction for retrying with the given parameters.
boolean	isLoading() Returns whether the Loader is currently loading a Loader.Loadable.
void	maybeThrowError() Throws a fatal error, or a non-fatal error if loading is currently backed off and the current Loader.Loadable has incurred a number of errors greater than the Loaders default minimum number of retries.
void	maybeThrowError(int minRetryCount) Throws a fatal error, or a non-fatal error if loading is currently backed off and the current Loader.Loadable has incurred a number of errors greater than the specified minimum number of retries.
void	release() Releases the Loader.
void	release(Loader.ReleaseCallback callback) Releases the Loader.
<T extends Loader.Loadable> long	startLoading(T loadable, Loader.Callback<T> callback, int defaultMinRetryCount) Starts loading a Loader.Loadable.

Methods inherited from class java.lang.Object

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

Field Detail

RETRY

public static final Loader.LoadErrorAction RETRY

Retries the load using the default delay.

RETRY_RESET_ERROR_COUNT

public static final Loader.LoadErrorAction RETRY_RESET_ERROR_COUNT

Retries the load using the default delay and resets the error count.

DONT_RETRY

public static final Loader.LoadErrorAction DONT_RETRY

Discards the failed loading task and ignores any errors that have occurred.

DONT_RETRY_FATAL

public static final Loader.LoadErrorAction DONT_RETRY_FATAL

Discards the failed load. The next call to maybeThrowError() will throw the last load error.

Constructor Detail

Loader

public Loader(java.lang.String threadName)

Parameters:

threadName - A name for the loader's thread.

Method Detail

createRetryAction

public static Loader.LoadErrorAction createRetryAction(boolean resetErrorCount,
                                                       long retryDelayMillis)

Creates a Loader.LoadErrorAction for retrying with the given parameters.

Parameters:

resetErrorCount - Whether the previous error count should be set to zero.

retryDelayMillis - The number of milliseconds to wait before retrying.

Returns:

A Loader.LoadErrorAction for retrying with the given parameters.

startLoading

public <T extends Loader.Loadable> long startLoading(T loadable,
                                                     Loader.Callback<T> callback,
                                                     int defaultMinRetryCount)

Starts loading a Loader.Loadable.

The calling thread must be a Looper thread, which is the thread on which the Loader.Callback will be called.

Type Parameters:

T - The type of the loadable.

Parameters:

loadable - The Loader.Loadable to load.

callback - A callback to be called when the load ends.

defaultMinRetryCount - The minimum number of times the load must be retried before maybeThrowError() will propagate an error.

Returns:

SystemClock.elapsedRealtime() when the load started.

Throws:

java.lang.IllegalStateException - If the calling thread does not have an associated Looper.

isLoading

public boolean isLoading()

Returns whether the Loader is currently loading a Loader.Loadable.

cancelLoading

public void cancelLoading()

Cancels the current load. This method should only be called when a load is in progress.

release

public void release()

Releases the Loader. This method should be called when the Loader is no longer required.

release

public void release(@Nullable
                    Loader.ReleaseCallback callback)

Releases the Loader. This method should be called when the Loader is no longer required.

Parameters:

callback - An optional callback to be called on the loading thread once the loader has been released.

maybeThrowError

public void maybeThrowError()
                     throws java.io.IOException

Description copied from interface: LoaderErrorThrower

Throws a fatal error, or a non-fatal error if loading is currently backed off and the current Loader.Loadable has incurred a number of errors greater than the Loaders default minimum number of retries. Else does nothing.

Specified by:

maybeThrowError in interface LoaderErrorThrower

Throws:

java.io.IOException - The error.

maybeThrowError

public void maybeThrowError(int minRetryCount)
                     throws java.io.IOException

Description copied from interface: LoaderErrorThrower

Throws a fatal error, or a non-fatal error if loading is currently backed off and the current Loader.Loadable has incurred a number of errors greater than the specified minimum number of retries. Else does nothing.

Specified by:

maybeThrowError in interface LoaderErrorThrower

Parameters:

minRetryCount - A minimum retry count that must be exceeded for a non-fatal error to be thrown. Should be non-negative.

Throws:

java.io.IOException - The error.