org.archive.bdb

Class StoredQueue<E extends Serializable>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.archive.bdb.StoredQueue<E>

Type Parameters:

E -

All Implemented Interfaces:

Iterable<E>, Collection<E>, Queue<E>

public class StoredQueue<E extends Serializable>
extends AbstractQueue<E>

Queue backed by a JE Collections StoredSortedMap.

Author:

gojomo

Field Summary

Fields

Modifier and Type	Field and Description
protected E	peekItem
protected com.sleepycat.je.Database	queueDb
protected com.sleepycat.collections.StoredSortedMap<Long,E>	queueMap
protected AtomicLong	tailIndex

Constructor Summary

Constructors

Constructor and Description
StoredQueue(com.sleepycat.je.Database db, Class<E> clsOrNull, com.sleepycat.bind.serial.StoredClassCatalog classCatalog) Create a StoredQueue backed by the given Database.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
static BdbModule.BdbConfig	databaseConfig() A suitable DatabaseConfig for the Database backing a StoredQueue.
void	hookupDatabase(com.sleepycat.je.Database db, Class<E> clsOrNull, com.sleepycat.bind.serial.StoredClassCatalog classCatalog)
boolean	isEmpty()
Iterator<E>	iterator()
boolean	offer(E o)
E	peek()
E	poll()
int	size()

Methods inherited from class java.util.AbstractQueue

add, addAll, clear, element, remove

Methods inherited from class java.util.AbstractCollection

contains, containsAll, 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.Collection

contains, containsAll, equals, hashCode, remove, removeAll, retainAll, toArray, toArray

Field Detail

queueMap

protected transient com.sleepycat.collections.StoredSortedMap<Long,E extends Serializable> queueMap

queueDb

protected transient com.sleepycat.je.Database queueDb

tailIndex

protected AtomicLong tailIndex

peekItem

protected transient volatile E extends Serializable peekItem

Constructor Detail

StoredQueue

public StoredQueue(com.sleepycat.je.Database db,
           Class<E> clsOrNull,
           com.sleepycat.bind.serial.StoredClassCatalog classCatalog)

Create a StoredQueue backed by the given Database. The Class of values to be queued may be provided; there is only a benefit when a primitive type is specified. A StoredClassCatalog must be provided if a primitive type is not supplied.

Parameters:

db -

clsOrNull -

classCatalog -

Method Detail

hookupDatabase

public void hookupDatabase(com.sleepycat.je.Database db,
                  Class<E> clsOrNull,
                  com.sleepycat.bind.serial.StoredClassCatalog classCatalog)

Parameters:

db -

clsOrNull -

classCatalog -

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E extends Serializable>

Specified by:

iterator in interface Collection<E extends Serializable>

Specified by:

iterator in class AbstractCollection<E extends Serializable>

size

public int size()

Specified by:

size in interface Collection<E extends Serializable>

Specified by:

size in class AbstractCollection<E extends Serializable>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E extends Serializable>

Overrides:

isEmpty in class AbstractCollection<E extends Serializable>

offer

public boolean offer(E o)

peek

public E peek()

poll

public E poll()

databaseConfig

public static BdbModule.BdbConfig databaseConfig()

A suitable DatabaseConfig for the Database backing a StoredQueue. (However, it is not necessary to use these config options.)

Returns:

DatabaseConfig suitable for queue

close

public void close()