Package com.broadleafcommerce.search.index.core.queue

Class AbstractDelegatingQueue<T>

java.lang.Object

com.broadleafcommerce.search.index.core.queue.AbstractDelegatingQueue<T>

Type Parameters:

T - The type that will be on the ReindexQueue.

All Implemented Interfaces:

Distributable, IndexableTypeAware, ReindexQueue<T>, Iterable<T>, Collection<T>, BlockingQueue<T>, Queue<T>

Direct Known Subclasses:

DefaultLocalArrayBlockingDelegatingQueue

public abstract class AbstractDelegatingQueue<T>
extends Object
implements ReindexQueue<T>

Abstract implementation of a ReindexQueue that delegates its work to any implementation of a BlockingQueue.

Author:

Kelly Tisdell

Constructor Summary

Constructors

Constructor	Description
AbstractDelegatingQueue(@NonNull com.broadleafcommerce.search.api.type.IndexableType type, @NonNull BlockingQueue<T> delegate)

Method Summary

Modifier and Type	Method	Description
boolean	add(T e)
boolean	addAll(Collection<? extends T> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
int	drainTo(Collection<? super T> c)
int	drainTo(Collection<? super T> c, int maxElements)
T	element()
BlockingQueue<T>	getDelegate()	The underlying queue which all work is delegated to.
com.broadleafcommerce.search.api.type.IndexableType	getIndexableType()	Components that implement this method should return the same, non-null value on each invocation.
String	getQueueName()	Any arbitrary Queue name.
boolean	isEmpty()
boolean	isLoaded()	Indicates whether more data will be added to the Queue.
Iterator<T>	iterator()
void	markLoaded()	Mark that there is no more data to add to this queue.
boolean	offer(T e)
boolean	offer(T e, long timeout, TimeUnit unit)
T	peek()
T	poll()
T	poll(long timeout, TimeUnit unit)
void	put(T e)
int	remainingCapacity()
T	remove()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
T	take()
Object[]	toArray()
<E> E[]	toArray(E[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface com.broadleafcommerce.search.index.core.Distributable

isDistributed

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AbstractDelegatingQueue

public AbstractDelegatingQueue(@NonNull
                               @NonNull com.broadleafcommerce.search.api.type.IndexableType type,
                               @NonNull
                               @NonNull BlockingQueue<T> delegate)

Method Detail

getQueueName

public final String getQueueName()

Description copied from interface: ReindexQueue

Any arbitrary Queue name.

Specified by:

getQueueName in interface ReindexQueue<T>

Returns:

the name for the queue

isLoaded

public final boolean isLoaded()

Description copied from interface: ReindexQueue

Indicates whether more data will be added to the Queue. Returns true if there is no more data to add.

Specified by:

isLoaded in interface ReindexQueue<T>

Returns:

whether the queue is fully loaded and no more data will be added

markLoaded

public final void markLoaded()

Description copied from interface: ReindexQueue

Mark that there is no more data to add to this queue.

Specified by:

markLoaded in interface ReindexQueue<T>

getIndexableType

public final com.broadleafcommerce.search.api.type.IndexableType getIndexableType()

Description copied from interface: IndexableTypeAware

Components that implement this method should return the same, non-null value on each invocation. This should basically return a constant value.

Specified by:

getIndexableType in interface IndexableTypeAware

Returns:

the associated indexable type

add

public boolean add(T e)

Specified by:

add in interface BlockingQueue<T>

Specified by:

add in interface Collection<T>

Specified by:

add in interface Queue<T>

offer

public boolean offer(T e)

Specified by:

offer in interface BlockingQueue<T>

Specified by:

offer in interface Queue<T>

put

public void put(T e)
         throws InterruptedException

Specified by:

put in interface BlockingQueue<T>

Throws:

InterruptedException

offer

public boolean offer(T e,
                     long timeout,
                     TimeUnit unit)
              throws InterruptedException

Specified by:

offer in interface BlockingQueue<T>

Throws:

InterruptedException

take

public T take()
       throws InterruptedException

Specified by:

take in interface BlockingQueue<T>

Throws:

InterruptedException

poll

public T poll(long timeout,
              TimeUnit unit)
       throws InterruptedException

Specified by:

poll in interface BlockingQueue<T>

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface BlockingQueue<T>

Specified by:

remove in interface Collection<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface BlockingQueue<T>

Specified by:

contains in interface Collection<T>

drainTo

public int drainTo(Collection<? super T> c)

Specified by:

drainTo in interface BlockingQueue<T>

drainTo

public int drainTo(Collection<? super T> c,
                   int maxElements)

Specified by:

drainTo in interface BlockingQueue<T>

remove

public T remove()

Specified by:

remove in interface Queue<T>

poll

public T poll()

Specified by:

poll in interface Queue<T>

element

public T element()

Specified by:

element in interface Queue<T>

peek

public T peek()

Specified by:

peek in interface Queue<T>

size

public int size()

Specified by:

size in interface Collection<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

toArray

public <E> E[] toArray(E[] a)

Specified by:

toArray in interface Collection<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

getDelegate

public BlockingQueue<T> getDelegate()

The underlying queue which all work is delegated to.

Returns:

the underlying delegate queue