Class InMemoryIndexTaskQueue<T extends IndexTask>
- All Implemented Interfaces:
IndexTaskQueue<T>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a new task to this queue.void
enqueueAll
(Collection<T> tasks) Add a collection of tasks to this queue.int
flushAndExecute
(Consumer<T> action) Flush the contents of the queue, applying the given action to each flushed entry.int
flushAndExecute
(Consumer<T> action, int numberOfEntries) Flush the contents of the queue, applying the given action to each flushed entry.Flush the contents of the queue, returning those elements currently queued as the result.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.Retrieve a list of all queued entries.getQueuedEntries
(int limit) Retrieve a list of the N of queued entries.int
getSize()
Retrieve the number of elements in the queue.void
reset()
Remove all queued index tasks from this queue.
-
Constructor Details
-
InMemoryIndexTaskQueue
public InMemoryIndexTaskQueue()
-
-
Method Details
-
getSize
public int getSize()Description copied from interface:IndexTaskQueue
Retrieve the number of elements in the queue.- Specified by:
getSize
in interfaceIndexTaskQueue<T extends IndexTask>
- Returns:
- size of the queue.
-
getQueuedEntries
Description copied from interface:IndexTaskQueue
Retrieve a list of all queued entries.- Specified by:
getQueuedEntries
in interfaceIndexTaskQueue<T extends IndexTask>
- Returns:
- a list of IndexTask instances.
-
getQueuedEntries
Description copied from interface:IndexTaskQueue
Retrieve a list of the N of queued entries.- Specified by:
getQueuedEntries
in interfaceIndexTaskQueue<T extends IndexTask>
- Parameters:
limit
- first N entries to retrieve.- Returns:
- a list of IndexTask instances.
-
enqueue
Description copied from interface:IndexTaskQueue
Add a new task to this queue.- Specified by:
enqueue
in interfaceIndexTaskQueue<T extends IndexTask>
-
enqueueAll
Description copied from interface:IndexTaskQueue
Add a collection of tasks to this queue.- Specified by:
enqueueAll
in interfaceIndexTaskQueue<T extends IndexTask>
-
flushQueue
Returns ALL entries in the queue.- Specified by:
flushQueue
in interfaceIndexTaskQueue<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 interfaceIndexTaskQueue<T extends IndexTask>
-
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 interfaceIndexTaskQueue<T extends IndexTask>
- Returns:
- the list of entries on the queue when it was flushed.
-
flushAndExecute
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.flushAndExecute(Consumer, int)
for an alternative.- Specified by:
flushAndExecute
in interfaceIndexTaskQueue<T extends IndexTask>
- Parameters:
action
- action to perform for each entry- Returns:
- the number of entries that were flushed.
-
flushAndExecute
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.flushAndExecute(Consumer)
for an alternative.- Specified by:
flushAndExecute
in interfaceIndexTaskQueue<T extends IndexTask>
- Parameters:
action
- action to perform for each entrynumberOfEntries
- 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.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 interfaceIndexTaskQueue<T extends IndexTask>
- Parameters:
actionOnIterableOfTasks
- action on iterable of tasksnumberOfTasks
- the maximum number of tasks to retrieve from the queue- Returns:
- the number of tasks that were flushed to the index.
-