Interface ReindexQueue<T>
-
- Type Parameters:
T
- The type of item that this Queue will hold.
- All Superinterfaces:
BlockingQueue<T>
,Collection<T>
,Distributable
,IndexableTypeAware
,Iterable<T>
,Queue<T>
- All Known Implementing Classes:
AbstractDelegatingQueue
,DefaultLocalArrayBlockingDelegatingQueue
public interface ReindexQueue<T> extends BlockingQueue<T>, Distributable, IndexableTypeAware
Interface to define a Queue. The Queue can be an in-memory,ArrayBlockingQueue
, for example, or it can be a reference to a Kafka Queue, or an Apache Ignite Queue, or some other distributedBlockingQueue
.- Author:
- Kelly Tisdell (ktisdell)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getQueueName()
Any arbitrary Queue name.boolean
isLoaded()
Indicates whether more data will be added to the Queue.void
markLoaded()
Mark that there is no more data to add to this queue.-
Methods inherited from interface java.util.concurrent.BlockingQueue
add, contains, drainTo, drainTo, offer, offer, poll, put, remainingCapacity, remove, take
-
Methods inherited from interface java.util.Collection
addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray
-
Methods inherited from interface com.broadleafcommerce.search.index.core.Distributable
isDistributed
-
Methods inherited from interface com.broadleafcommerce.search.index.core.IndexableTypeAware
getIndexableType
-
-
-
-
Method Detail
-
getQueueName
String getQueueName()
Any arbitrary Queue name.- Returns:
- the name for the queue
-
isLoaded
boolean isLoaded()
Indicates whether more data will be added to the Queue. Returns true if there is no more data to add.- Returns:
- whether the queue is fully loaded and no more data will be added
-
markLoaded
void markLoaded()
Mark that there is no more data to add to this queue.
-
-