org.ldaptive.pool

Class Queue<T>

java.lang.Object

org.ldaptive.pool.Queue<T>

Type Parameters:

T - type of object in the queue

All Implemented Interfaces:

java.lang.Iterable<T>

public class Queue<T>
extends java.lang.Object
implements java.lang.Iterable<T>

Provides a wrapper around a Deque to support LIFO and FIFO operations.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Deque<T>	queue Underlying queue.
private QueueType	queueType How will objects be inserted into the queue.

Constructor Summary

Constructors

Constructor and Description
Queue(QueueType type) Creates a new queue.

Method Summary

Modifier and Type	Method and Description
void	add(T t) Adds an object to the queue based on the queue type.
boolean	contains(T t) Returns whether t is in the queue.
T	element() Retrieves, but does not remove, the first element in the queue.
boolean	isEmpty() Returns whether or not the queue is empty.
java.util.Iterator<T>	iterator()
T	remove() Removes the first element in the queue.
boolean	remove(T t) Removes the supplied element from the queue.
int	size() Returns the number of elements in the queue.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

queueType

private final QueueType queueType

How will objects be inserted into the queue.

queue

private final java.util.Deque<T> queue

Underlying queue.

Constructor Detail

Queue

public Queue(QueueType type)

Creates a new queue.

Parameters:

type - how will objects be inserted into the queue

Method Detail

add

public void add(T t)

Adds an object to the queue based on the queue type. See Deque.offerFirst(Object) and Deque.offerLast(Object).

Parameters:

t - to add

remove

public T remove()

Removes the first element in the queue. See Deque.removeFirst().

Returns:

first element in the queue

remove

public boolean remove(T t)

Removes the supplied element from the queue. See Deque.remove(Object).

Parameters:

t - to remove

Returns:

whether t was removed

element

public T element()

Retrieves, but does not remove, the first element in the queue. See Deque.getFirst().

Returns:

first element in the queue

contains

public boolean contains(T t)

Returns whether t is in the queue. See Deque.contains(Object).

Parameters:

t - that may be in the queue

Returns:

whether t is in the queue

isEmpty

public boolean isEmpty()

Returns whether or not the queue is empty. See Collection.isEmpty()}.

Returns:

whether the queue is empty

size

public int size()

Returns the number of elements in the queue. See Deque.size().

Returns:

number of elements in the queue

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object