com.squareup.tape

Class TaskQueue<T extends Task>

java.lang.Object

com.squareup.tape.TaskQueue<T>

Type Parameters:

T - The type of tasks in the queue.

All Implemented Interfaces:

ObjectQueue<T>

public class TaskQueue<T extends Task>
extends Object
implements ObjectQueue<T>

Persistent task queue. Not safe for concurrent use.

Nested Class Summary

Nested classes/interfaces inherited from interface com.squareup.tape.ObjectQueue

ObjectQueue.Listener<T>

Constructor Summary

Constructors

Constructor and Description
TaskQueue(ObjectQueue<T> delegate)
TaskQueue(ObjectQueue<T> delegate, TaskInjector<T> taskInjector)

Method Summary

Modifier and Type	Method and Description
void	add(T entry) Enqueues an entry that can be processed at any time.
T	peek() Returns the head of the queue, or null if the queue is empty.
void	remove() Removes the head of the queue.
void	setListener(ObjectQueue.Listener<T> listener) Sets a listener on this queue.
int	size() Returns the number of entries in the queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskQueue

public TaskQueue(ObjectQueue<T> delegate)

TaskQueue

public TaskQueue(ObjectQueue<T> delegate,
                 TaskInjector<T> taskInjector)

Method Detail

peek

public T peek()

Returns the head of the queue, or null if the queue is empty. Does not modify the queue. Overridden to inject members into Tasks.

Specified by:

peek in interface ObjectQueue<T extends Task>

size

public int size()

Description copied from interface: ObjectQueue

Returns the number of entries in the queue.

Specified by:

size in interface ObjectQueue<T extends Task>

add

public void add(T entry)

Description copied from interface: ObjectQueue

Enqueues an entry that can be processed at any time.

Specified by:

add in interface ObjectQueue<T extends Task>

remove

public void remove()

Description copied from interface: ObjectQueue

Removes the head of the queue.

Specified by:

remove in interface ObjectQueue<T extends Task>

setListener

public void setListener(ObjectQueue.Listener<T> listener)

Description copied from interface: ObjectQueue

Sets a listener on this queue. Invokes ObjectQueue.Listener.onAdd(com.squareup.tape.ObjectQueue<T>, T) once for each entry that's already in the queue. If an error occurs while reading the data, the listener will not receive further notifications.

Specified by:

setListener in interface ObjectQueue<T extends Task>