com.atlassian.confluence.search.lucene.queue

Class InMemoryIndexTaskQueue<T extends IndexTask>

java.lang.Object

com.atlassian.confluence.search.lucene.queue.InMemoryIndexTaskQueue<T>

All Implemented Interfaces:

IndexTaskQueue<T>

public class InMemoryIndexTaskQueue<T extends IndexTask>
extends Object
implements IndexTaskQueue<T>

An in memory implementation of the Index Task Queue.

Constructor Summary

Constructors

Constructor and Description
InMemoryIndexTaskQueue()

Method Summary

Modifier and Type	Method and Description
void	enqueue(T task) Add a new task to this queue.
void	enqueueAll(Collection<T> tasks) Add a collection of tasks to this queue.
List<T>	flushQueue() Flush the contents of the queue, returning those elements currently queued as the result.
int	flushQueue(com.atlassian.fugue.Effect<T> action) Flush the contents of the queue, applying the given action to each flushed entry.
int	flushQueue(com.atlassian.fugue.Effect<T> action, int numberOfEntries) Flush the contents of the queue, applying the given action to each flushed entry.
List<T>	flushQueue(int numberOfEntries) Returns ALL entries in the queue.
int	flushQueueWithActionOnIterableOfTasks(Consumer<Iterable<T>> actionOnIterableOfTasks, int numberOfTasks) Flush the contents of the queue, applying the given action to an iterable of tasks.
List<T>	getQueuedEntries() Retrieve a list of all of the queued entries.
List<T>	getQueuedEntries(int size)
int	getSize() Retrieve the number of elements in the queue.
void	reset() Remove all queued index tasks from this queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryIndexTaskQueue

public InMemoryIndexTaskQueue()

Method Detail

getSize

public int getSize()

Description copied from interface: IndexTaskQueue

Retrieve the number of elements in the queue.

Specified by:

getSize in interface IndexTaskQueue<T extends IndexTask>

Returns:

size of the queue.

getQueuedEntries

public List<T> getQueuedEntries()

Description copied from interface: IndexTaskQueue

Retrieve a list of all of the queued entries.

Specified by:

getQueuedEntries in interface IndexTaskQueue<T extends IndexTask>

Returns:

a list of IndexTask instances.

getQueuedEntries

public List<T> getQueuedEntries(int size)

enqueue

public void enqueue(T task)

Description copied from interface: IndexTaskQueue

Add a new task to this queue.

Specified by:

enqueue in interface IndexTaskQueue<T extends IndexTask>

enqueueAll

public void enqueueAll(Collection<T> tasks)

Description copied from interface: IndexTaskQueue

Add a collection of tasks to this queue.

Specified by:

enqueueAll in interface IndexTaskQueue<T extends IndexTask>

flushQueue

public List<T> flushQueue(int numberOfEntries)

Returns ALL entries in the queue.

Specified by:

flushQueue in interface IndexTaskQueue<T extends IndexTask>

Parameters:

numberOfEntries - the maximum number of entries to return. This should return the n first entries in the queue.

Returns:

the list of entries on the queue when it was flushed.

reset

public void reset()

Description copied from interface: IndexTaskQueue

Remove all queued index tasks from this queue.

Specified by:

reset in interface IndexTaskQueue<T extends IndexTask>

flushQueue

public List<T> flushQueue()

Description copied from interface: IndexTaskQueue

Flush the contents of the queue, returning those elements currently queued as the result.

This method waits until tasks that we added immediately before calling this method are available. See IndexTaskQueue.flushQueue(int) for an alternative.

Specified by:

flushQueue in interface IndexTaskQueue<T extends IndexTask>

Returns:

the list of entries on the queue when it was flushed.

flushQueue

public int flushQueue(com.atlassian.fugue.Effect<T> action)

Description copied from interface: IndexTaskQueue

Flush the contents of the queue, applying the given action to each flushed entry.

This method waits until tasks that we added immediately before calling this method are available. See IndexTaskQueue.flushQueue(com.atlassian.fugue.Effect, int) for an alternative.

Specified by:

flushQueue in interface IndexTaskQueue<T extends IndexTask>

Parameters:

action - action to perform for each entry

Returns:

the number of entries that were flushed.

flushQueue

public int flushQueue(com.atlassian.fugue.Effect<T> action,
                      int numberOfEntries)

Description copied from interface: IndexTaskQueue

Flush the contents of the queue, applying the given action to each flushed entry.

Tasks that were added immediately before calling this method are not returned. See IndexTaskQueue.flushQueue(com.atlassian.fugue.Effect) for an alternative.

Specified by:

flushQueue in interface IndexTaskQueue<T extends IndexTask>

Parameters:

action - action to perform for each entry

numberOfEntries - the maximum number of entries to flush. This should flush the n first entries in the queue.

Returns:

the number of entries that were flushed.

flushQueueWithActionOnIterableOfTasks

public int flushQueueWithActionOnIterableOfTasks(Consumer<Iterable<T>> actionOnIterableOfTasks,
                                                 int numberOfTasks)

Description copied from interface: IndexTaskQueue

Flush the contents of the queue, applying the given action to an iterable of tasks.

IndexTaskQueue.flushQueue(Effect, int) applys an action to an individual task. In contrast, this method applies an action to an iterable of tasks.

If the specified action throws a RuntimeException, tasks are returned to the queue so that they can be processed again. The exception will be propagated so clients must handle it accordingly.

Specified by:

flushQueueWithActionOnIterableOfTasks in interface IndexTaskQueue<T extends IndexTask>

Parameters:

actionOnIterableOfTasks - action on iterable of tasks

numberOfTasks - the maximum number of tasks to retrieve from the queue

Returns:

the number of tasks that were flushed to the index.