Package com.couchbase.client.java.datastructures.collections

Class CouchbaseArrayList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

com.couchbase.client.java.datastructures.collections.CouchbaseArrayList<E>

Type Parameters:

E - the type of values in the list.

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>

@Committed
@Public
public class CouchbaseArrayList<E>
extends AbstractList<E>

A CouchbaseArrayList is a List backed by a Couchbase document (more specifically a JSON array). Note that as such, a CouchbaseArrayList is restricted to the types that a JSON array can contain. JSON objects and sub-arrays can be represented as JsonObject and JsonArray respectively.

Since:

2.3.6

Author:

Simon Baslé, Subhashni Balakrishnan

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
CouchbaseArrayList(String id, Bucket bucket)	Create a new Couchbase-backed List, backed by the document identified by id in bucket.
CouchbaseArrayList(String id, Bucket bucket, E... content)	Create a new Couchbase-backed List, backed by the document identified by id in bucket.
CouchbaseArrayList(String id, Bucket bucket, Collection<? extends E> content)	Create a new Couchbase-backed List, backed by the document identified by id in bucket.

Method Summary

Modifier and Type	Method	Description
void	add(int index, E element)
void	clear()
boolean	contains(Object o)
E	get(int index)
boolean	isEmpty()
Iterator<E>	iterator()
ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int index)
E	remove(int index)
E	set(int index, E element)
int	size()

Methods inherited from class java.util.AbstractList

add, addAll, equals, hashCode, indexOf, lastIndexOf, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, remove, removeAll, 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.List

addAll, containsAll, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Constructor Detail

CouchbaseArrayList

public CouchbaseArrayList(String id,
                          Bucket bucket)

Create a new Couchbase-backed List, 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 list.

bucket - the Bucket through which to interact with the document.

CouchbaseArrayList

public CouchbaseArrayList(String id,
                          Bucket bucket,
                          E... content)

Create a new Couchbase-backed List, backed by the document identified by id in bucket. Note that if the document already exists, its content is reset to the values provided. Note that if you don't provide any value as a vararg, the CouchbaseArrayList(String, Bucket) constructor will be invoked instead, which will use pre-existing values as content. To create a new List and force it to be empty, use CouchbaseArrayList(String, Bucket, Collection) with an empty collection.

Parameters:

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

bucket - the Bucket through which to interact with the document.

content - vararg of the elements to initially store in the List.

CouchbaseArrayList

public CouchbaseArrayList(String id,
                          Bucket bucket,
                          Collection<? extends E> content)

Create a new Couchbase-backed List, backed by the document identified by id in bucket. Note that if the document already exists, its content is reset to the values provided in the content Collection.

Parameters:

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

bucket - the Bucket through which to interact with the document.

content - collection of the elements to initially store in the List.

Method Detail

get

public E get(int index)

Specified by:

get in interface List<E>

Specified by:

get in class AbstractList<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

Specified by:

size in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

Overrides:

isEmpty in class AbstractCollection<E>

set

public E set(int index,
             E element)

Specified by:

set in interface List<E>

Overrides:

set in class AbstractList<E>

add

public void add(int index,
                E element)

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

remove

public E remove(int index)

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractList<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface List<E>

Overrides:

contains in class AbstractCollection<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface List<E>

Overrides:

iterator in class AbstractList<E>

listIterator

public ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class AbstractList<E>

listIterator

public ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class AbstractList<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class AbstractList<E>