A C E F G I O P Q R S T

A

add(T) - Method in class com.squareup.tape.FileObjectQueue

add(T) - Method in class com.squareup.tape.InMemoryObjectQueue

add(T) - Method in interface com.squareup.tape.ObjectQueue

Enqueues an entry that can be processed at any time.

add(byte[]) - Method in class com.squareup.tape.QueueFile

Adds an element to the end of the queue.

add(byte[], int, int) - Method in class com.squareup.tape.QueueFile

Adds an element to the end of the queue.

add(T) - Method in class com.squareup.tape.TaskQueue

asList() - Method in class com.squareup.tape.FileObjectQueue

C

clear() - Method in class com.squareup.tape.QueueFile

Clears this queue.

close() - Method in class com.squareup.tape.FileObjectQueue

close() - Method in class com.squareup.tape.QueueFile

Closes the underlying file.

com.squareup.tape - package com.squareup.tape

E

execute(T) - Method in interface com.squareup.tape.Task

Executes this task.

F

FileException - Exception in com.squareup.tape

Encapsulates an IOException in an extension of RuntimeException.

FileException(String, IOException, File) - Constructor for exception com.squareup.tape.FileException

FileObjectQueue<T> - Class in com.squareup.tape

Base queue class, implements common functionality for a QueueFile-backed queue manager.

FileObjectQueue(File, FileObjectQueue.Converter<T>) - Constructor for class com.squareup.tape.FileObjectQueue

FileObjectQueue.Converter<T> - Interface in com.squareup.tape

Convert a byte stream to and from a concrete type.

forEach(QueueFile.ElementReader) - Method in class com.squareup.tape.QueueFile

Deprecated.

use QueueFile.forEach(ElementVisitor)

forEach(QueueFile.ElementVisitor) - Method in class com.squareup.tape.QueueFile

Invokes the given reader once for each element in the queue, from eldest to most recently added.

from(byte[]) - Method in interface com.squareup.tape.FileObjectQueue.Converter

Converts bytes to an object.

from(byte[]) - Method in class com.squareup.tape.SerializedConverter

Deserialize bytes to an object.

G

getFile() - Method in exception com.squareup.tape.FileException

I

injectMembers(T) - Method in interface com.squareup.tape.TaskInjector

InMemoryObjectQueue<T> - Class in com.squareup.tape

A queue for objects that are not serious enough to be written to disk.

InMemoryObjectQueue() - Constructor for class com.squareup.tape.InMemoryObjectQueue

isEmpty() - Method in class com.squareup.tape.QueueFile

Returns true if this queue contains no entries.

O

ObjectQueue<T> - Interface in com.squareup.tape

A queue of objects.

ObjectQueue.Listener<T> - Interface in com.squareup.tape

Listens for changes to the queue.

onAdd(ObjectQueue<T>, T) - Method in interface com.squareup.tape.ObjectQueue.Listener

Called after an entry is added.

onRemove(ObjectQueue<T>) - Method in interface com.squareup.tape.ObjectQueue.Listener

Called after an entry is removed.

P

peek() - Method in class com.squareup.tape.FileObjectQueue

peek(int) - Method in class com.squareup.tape.FileObjectQueue

Reads up to max entries from the head of the queue without removing the entries.

peek() - Method in class com.squareup.tape.InMemoryObjectQueue

peek() - Method in interface com.squareup.tape.ObjectQueue

Returns the head of the queue, or null if the queue is empty.

peek() - Method in class com.squareup.tape.QueueFile

Reads the eldest element.

peek(QueueFile.ElementReader) - Method in class com.squareup.tape.QueueFile

Deprecated.

use QueueFile.peek(ElementVisitor)

peek(QueueFile.ElementVisitor) - Method in class com.squareup.tape.QueueFile

Invokes visitor with the eldest element, if an element is available.

peek() - Method in class com.squareup.tape.TaskQueue

Returns the head of the queue, or null if the queue is empty.

Q

QueueFile - Class in com.squareup.tape

A reliable, efficient, file-based, FIFO queue.

QueueFile(File) - Constructor for class com.squareup.tape.QueueFile

Constructs a new queue backed by the given file.

QueueFile.ElementReader - Interface in com.squareup.tape

Deprecated.

use QueueFile.ElementVisitor instead.

QueueFile.ElementVisitor - Interface in com.squareup.tape

Reads queue elements.

R

read(InputStream, int) - Method in interface com.squareup.tape.QueueFile.ElementReader

Deprecated.

Called once per element.

read(InputStream, int) - Method in interface com.squareup.tape.QueueFile.ElementVisitor

Called once per element.

remove() - Method in class com.squareup.tape.FileObjectQueue

remove(int) - Method in class com.squareup.tape.FileObjectQueue

remove() - Method in class com.squareup.tape.InMemoryObjectQueue

remove() - Method in interface com.squareup.tape.ObjectQueue

Removes the head of the queue.

remove() - Method in class com.squareup.tape.QueueFile

Removes the eldest element.

remove(int) - Method in class com.squareup.tape.QueueFile

Removes the eldest n elements.

remove() - Method in class com.squareup.tape.TaskQueue

S

SerializedConverter<T extends Serializable> - Class in com.squareup.tape

Serialized object queue converter.

SerializedConverter() - Constructor for class com.squareup.tape.SerializedConverter

setListener(ObjectQueue.Listener<T>) - Method in class com.squareup.tape.FileObjectQueue

setListener(ObjectQueue.Listener<T>) - Method in class com.squareup.tape.InMemoryObjectQueue

setListener(ObjectQueue.Listener<T>) - Method in interface com.squareup.tape.ObjectQueue

Sets a listener on this queue.

setListener(ObjectQueue.Listener<T>) - Method in class com.squareup.tape.TaskQueue

size() - Method in class com.squareup.tape.FileObjectQueue

size() - Method in class com.squareup.tape.InMemoryObjectQueue

size() - Method in interface com.squareup.tape.ObjectQueue

Returns the number of entries in the queue.

size() - Method in class com.squareup.tape.QueueFile

Returns the number of elements in this queue.

size() - Method in class com.squareup.tape.TaskQueue

T

Task<T> - Interface in com.squareup.tape

An idempotent task that can be enqueued, persisted (using serialization), and executed at a later time.

TaskInjector<T extends Task> - Interface in com.squareup.tape

Inject dependencies into tasks of any kind.

TaskQueue<T extends Task> - Class in com.squareup.tape

Persistent task queue.

TaskQueue(ObjectQueue<T>) - Constructor for class com.squareup.tape.TaskQueue

TaskQueue(ObjectQueue<T>, TaskInjector<T>) - Constructor for class com.squareup.tape.TaskQueue

toStream(T, OutputStream) - Method in interface com.squareup.tape.FileObjectQueue.Converter

Converts o to bytes written to the specified stream.

toStream(T, OutputStream) - Method in class com.squareup.tape.SerializedConverter

Serializes o to bytes.

toString() - Method in class com.squareup.tape.QueueFile

A C E F G I O P Q R S T