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>
@Committed public class CouchbaseQueue<E> extends AbstractQueue<E>
A CouchbaseQueue is aQueuebacked by aCouchbasedocument (more specifically aJSON array). Note that as such, a CouchbaseQueue is restricted to the types that aJSON arraycan contain. JSON objects and sub-arrays can be represented asJsonObjectandJsonArrayrespectively. Null values are not allowed as they have special meaning for thepeek()andAbstractQueue.remove()methods of a queue.- Since:
- 2.3.6
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classCouchbaseQueue.CouchbaseQueueIterator<E>
-
Constructor Summary
Constructors Constructor Description CouchbaseQueue(String id, Collection collection, Class<E> entityType, QueueOptions options)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Iterator<E>iterator()booleanoffer(E e)Epeek()Epoll()intsize()-
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, toArray
-
-
-
-
Constructor Detail
-
CouchbaseQueue
public CouchbaseQueue(String id, Collection collection, Class<E> entityType, QueueOptions options)
Create a newCouchbase-backedQueue, backed by the document identified byidinbucket. 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- theCollectionthrough which to interact with the document.entityType- aClassdescribing the type of objects in this Set.options- aCommonDatastructureOptionsto use for all operations on this instance of the queue.
-
-
Method Detail
-
iterator
public Iterator<E> iterator()
- Specified by:
iteratorin interfaceCollection<E>- Specified by:
iteratorin interfaceIterable<E>- Specified by:
iteratorin classAbstractCollection<E>
-
size
public int size()
- Specified by:
sizein interfaceCollection<E>- Specified by:
sizein classAbstractCollection<E>
-
clear
public void clear()
- Specified by:
clearin interfaceCollection<E>- Overrides:
clearin classAbstractQueue<E>
-
offer
public boolean offer(E e)
-
poll
public E poll()
-
peek
public E peek()
-
-