com.google.android.exoplayer2.util

Class PriorityTaskManager

java.lang.Object

com.google.android.exoplayer2.util.PriorityTaskManager

public final class PriorityTaskManager
extends java.lang.Object

Allows tasks with associated priorities to control how they proceed relative to one another.

A task should call add(int) to register with the manager and remove(int) to unregister. A registered task will prevent tasks of lower priority from proceeding, and should call proceed(int), proceedNonBlocking(int) or proceedOrThrow(int) each time it wishes to check whether it is itself allowed to proceed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PriorityTaskManager.PriorityTooLowException Thrown when task attempts to proceed when another registered task has a higher priority.

Constructor Summary

Constructors

Constructor and Description
PriorityTaskManager()

Method Summary

Modifier and Type	Method and Description
void	add(int priority) Register a new task.
void	proceed(int priority) Blocks until the task is allowed to proceed.
boolean	proceedNonBlocking(int priority) A non-blocking variant of proceed(int).
void	proceedOrThrow(int priority) A throwing variant of proceed(int).
void	remove(int priority) Unregister a task.

Methods inherited from class java.lang.Object

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

Constructor Detail

PriorityTaskManager

public PriorityTaskManager()

Method Detail

add

public void add(int priority)

Register a new task. The task must call remove(int) when done.

Parameters:

priority - The priority of the task. Larger values indicate higher priorities.

proceed

public void proceed(int priority)
             throws java.lang.InterruptedException

Blocks until the task is allowed to proceed.

Parameters:

priority - The priority of the task.

Throws:

java.lang.InterruptedException - If the thread is interrupted.

proceedNonBlocking

public boolean proceedNonBlocking(int priority)

A non-blocking variant of proceed(int).

Parameters:

priority - The priority of the task.

Returns:

Whether the task is allowed to proceed.

proceedOrThrow

public void proceedOrThrow(int priority)
                    throws PriorityTaskManager.PriorityTooLowException

A throwing variant of proceed(int).

Parameters:

priority - The priority of the task.

Throws:

PriorityTaskManager.PriorityTooLowException - If the task is not allowed to proceed.

remove

public void remove(int priority)

Unregister a task.

Parameters:

priority - The priority of the task.