Package ai.preferred.venom.job

Class AbstractJobQueue

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<Job>

ai.preferred.venom.job.AbstractJobQueue

All Implemented Interfaces:

Iterable<Job>, Collection<Job>, BlockingQueue<Job>, Queue<Job>

Direct Known Subclasses:

AbstractPriorityJobQueue, FIFOJobQueue

public abstract class AbstractJobQueue
extends AbstractQueue<Job>
implements BlockingQueue<Job>

Author:

Ween Jiann Lee, Maksim Tkachenko

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJobQueue(BlockingQueue<Job> queue)	Constructs an instance of AbstractJobQueue.

Method Summary

Modifier and Type	Method	Description
int	drainTo(Collection<? super Job> c)
int	drainTo(Collection<? super Job> c, int maxElements)
protected BlockingQueue<Job>	getQueue()	Get the BlockingQueue backing this scheduler.
Iterator<Job>	iterator()
Job	peek()
int	remainingCapacity()
int	size()
Job	take()

Methods inherited from class java.util.AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class java.util.AbstractCollection

contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.BlockingQueue

add, contains, offer, offer, poll, put, remove

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Queue

element, poll, remove

Constructor Detail

AbstractJobQueue

protected AbstractJobQueue(BlockingQueue<Job> queue)

Constructs an instance of AbstractJobQueue.

Parameters:

queue - an instance of BlockingQueue

Method Detail

iterator

@Nonnull
public final Iterator<Job> iterator()

Specified by:

iterator in interface Collection<Job>

Specified by:

iterator in interface Iterable<Job>

Specified by:

iterator in class AbstractCollection<Job>

size

public final int size()

Specified by:

size in interface Collection<Job>

Specified by:

size in class AbstractCollection<Job>

take

@Nonnull
public final Job take()
               throws InterruptedException

Specified by:

take in interface BlockingQueue<Job>

Throws:

InterruptedException

remainingCapacity

public final int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<Job>

drainTo

public final int drainTo(@Nonnull
                         Collection<? super Job> c)

Specified by:

drainTo in interface BlockingQueue<Job>

drainTo

public final int drainTo(@Nonnull
                         Collection<? super Job> c,
                         int maxElements)

Specified by:

drainTo in interface BlockingQueue<Job>

peek

public final Job peek()

Specified by:

peek in interface Queue<Job>

getQueue

protected final BlockingQueue<Job> getQueue()

Get the BlockingQueue backing this scheduler.

Returns:

an instance of BlockingQueue