com.couchbase.client.java.datastructures

Class CouchbaseQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

com.couchbase.client.java.datastructures.CouchbaseQueue<E>

Type Parameters:

E - the type of values in the queue.

All Implemented Interfaces:

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

@Stability.Committed
public class CouchbaseQueue<E>
extends AbstractQueue<E>

A CouchbaseQueue is a Queue backed by a Couchbase document (more specifically a JSON array). Note that as such, a CouchbaseQueue is restricted to the types that a JSON array can contain. JSON objects and sub-arrays can be represented as JsonObject and JsonArray respectively. Null values are not allowed as they have special meaning for the peek() and AbstractQueue.remove() methods of a queue.

Since:

2.3.6

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CouchbaseQueue.CouchbaseQueueIterator<E>

Constructor Summary

Constructors

Constructor and Description
CouchbaseQueue(String id, Collection collection, Class<E> entityType, QueueOptions options) Create a new Couchbase-backed Queue, backed by the document identified by id in bucket.

Method Summary

Modifier and Type	Method and Description
void	clear()
Iterator<E>	iterator()
boolean	offer(E e)
E	peek()
E	poll()
int	size()

Methods inherited from class java.util.AbstractQueue

add, addAll, 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.Collection

contains, containsAll, equals, hashCode, isEmpty, parallelStream, remove, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

CouchbaseQueue

public CouchbaseQueue(String id,
                      Collection collection,
                      Class<E> entityType,
                      QueueOptions options)

Create a new Couchbase-backed Queue, backed by the document identified by id in bucket. Note that if the document already exists, its content will be used as initial content for this collection. Otherwise it is created empty.

Parameters:

id - the id of the Couchbase document to back the queue.

collection - the Collection through which to interact with the document.

entityType - a Class describing the type of objects in this Set.

options - a CommonDatastructureOptions to use for all operations on this instance of the queue.

Method Detail

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in class AbstractCollection<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in class AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractQueue<E>

offer

public boolean offer(E e)

poll

public E poll()

peek

public E peek()