Package com.couchbase.client.java.datastructures

Class CouchbaseArraySet<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<T>

com.couchbase.client.java.datastructures.CouchbaseArraySet<T>

Type Parameters:

T - the type of values in the set.

All Implemented Interfaces:

Iterable<T>, Collection<T>, Set<T>

@Committed
public class CouchbaseArraySet<T>
extends AbstractSet<T>

A CouchbaseArraySet is a Set backed by a Couchbase document (more specifically a JSON array). Note that a CouchbaseArraySet is restricted to primitive types (the types that a JSON array can contain, except JsonObject and JsonArray). null entries are supported.

Since:

2.3.6

Constructor Summary

Constructors

Constructor	Description
CouchbaseArraySet(String id, Collection collection, Class<T> entityType)	Create a new CouchbaseArraySet, backed by the document identified by id in the given Couchbase bucket.
CouchbaseArraySet(String id, Collection collection, Class<T> entityType, ArraySetOptions options)	Create a new CouchbaseArraySet, backed by the document identified by id in the given Couchbase bucket.

Method Summary

Modifier and Type	Method	Description
boolean	add(T t)
void	clear()
boolean	contains(Object t)
protected void	enforcePrimitive(Object t)	Verify that the type of object t is compatible with CouchbaseArraySet storage.
boolean	isEmpty()
Iterator<T>	iterator()
boolean	remove(Object t)
protected boolean	safeEquals(Object expected, Object tested)
int	size()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

addAll, containsAll, retainAll, spliterator, toArray, toArray

Constructor Detail

CouchbaseArraySet

public CouchbaseArraySet(String id,
                         Collection collection,
                         Class<T> entityType,
                         ArraySetOptions options)

Create a new CouchbaseArraySet, backed by the document identified by id in the given Couchbase 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 set.

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

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

options - a ArraySetOptions to use for all operations on this instance of the list.

CouchbaseArraySet

public CouchbaseArraySet(String id,
                         Collection collection,
                         Class<T> entityType)

Create a new CouchbaseArraySet, backed by the document identified by id in the given Couchbase 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 set.

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

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

Method Detail

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface Set<T>

Specified by:

size in class AbstractCollection<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface Set<T>

Overrides:

isEmpty in class AbstractCollection<T>

contains

public boolean contains(Object t)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface Set<T>

Overrides:

contains in class AbstractCollection<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Set<T>

Specified by:

iterator in class AbstractCollection<T>

add

public boolean add(T t)

Specified by:

add in interface Collection<T>

Specified by:

add in interface Set<T>

Overrides:

add in class AbstractCollection<T>

remove

public boolean remove(Object t)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface Set<T>

Overrides:

remove in class AbstractCollection<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface Set<T>

Overrides:

clear in class AbstractCollection<T>

enforcePrimitive

protected void enforcePrimitive(Object t)
                         throws ClassCastException

Verify that the type of object t is compatible with CouchbaseArraySet storage.

Parameters:

t - the object to check.

Throws:

ClassCastException - if the object is incompatible.

safeEquals

protected boolean safeEquals(Object expected,
                             Object tested)