Package org.bson

Class BsonArray

java.lang.Object

org.bson.BsonValue

org.bson.BsonArray

All Implemented Interfaces:

Cloneable, Iterable<BsonValue>, Collection<BsonValue>, List<BsonValue>

Direct Known Subclasses:

RawBsonArray

public class BsonArray
extends BsonValue
implements List<BsonValue>, Cloneable

A type-safe representation of the BSON array type.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
BsonArray()	Construct an empty BsonArray
BsonArray(int initialCapacity)	Construct an empty BsonArray with the specified initial capacity.
BsonArray(List<? extends BsonValue> values)	Construct an instance with the given list of values.

Method Summary

Modifier and Type	Method	Description
void	add(int index, BsonValue element)
boolean	add(BsonValue bsonValue)
boolean	addAll(int index, Collection<? extends BsonValue> c)
boolean	addAll(Collection<? extends BsonValue> c)
void	clear()
BsonArray	clone()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
BsonValue	get(int index)
BsonType	getBsonType()	Gets the BSON type of this value.
List<BsonValue>	getValues()	Gets the values in this array as a list of BsonValue objects.
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<BsonValue>	iterator()
int	lastIndexOf(Object o)
ListIterator<BsonValue>	listIterator()
ListIterator<BsonValue>	listIterator(int index)
static BsonArray	parse(String json)	Parses a string in MongoDB Extended JSON format to a BsonArray
BsonValue	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
BsonValue	set(int index, BsonValue element)
int	size()
List<BsonValue>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()

Methods inherited from class org.bson.BsonValue

asArray, asBinary, asBoolean, asDateTime, asDBPointer, asDecimal128, asDocument, asDouble, asInt32, asInt64, asJavaScript, asJavaScriptWithScope, asNumber, asObjectId, asRegularExpression, asString, asSymbol, asTimestamp, isArray, isBinary, isBoolean, isDateTime, isDBPointer, isDecimal128, isDocument, isDouble, isInt32, isInt64, isJavaScript, isJavaScriptWithScope, isNull, isNumber, isObjectId, isRegularExpression, isString, isSymbol, isTimestamp

Methods inherited from class java.lang.Object

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

replaceAll, sort, spliterator

Constructor Details

BsonArray

public BsonArray(List<? extends BsonValue> values)

Construct an instance with the given list of values.

Parameters:

values - the list of values, none of whose members may be null.

BsonArray

public BsonArray()

Construct an empty BsonArray

BsonArray

public BsonArray(int initialCapacity)

Construct an empty BsonArray with the specified initial capacity.

Parameters:

initialCapacity - the initial capacity of the BsonArray

Throws:

IllegalArgumentException - if the specified initial capacity is negative

Since:

4.3

Method Details

parse

public static BsonArray parse(String json)

Parses a string in MongoDB Extended JSON format to a BsonArray

Parameters:

json - the JSON string

Returns:

a corresponding BsonArray object

Since:

3.4

See Also:

• JsonReader

MongoDB documentation

MongoDB Extended JSON

getValues

public List<BsonValue> getValues()

Gets the values in this array as a list of BsonValue objects.

Returns:

the values in this array.

getBsonType

public BsonType getBsonType()

Description copied from class: BsonValue

Gets the BSON type of this value.

Specified by:

getBsonType in class BsonValue

Returns:

the BSON type, which may not be null (but may be BSONType.NULL)

size

public int size()

Specified by:

size in interface Collection<BsonValue>

Specified by:

size in interface List<BsonValue>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<BsonValue>

Specified by:

isEmpty in interface List<BsonValue>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<BsonValue>

Specified by:

contains in interface List<BsonValue>

iterator

public Iterator<BsonValue> iterator()

Specified by:

iterator in interface Collection<BsonValue>

Specified by:

iterator in interface Iterable<BsonValue>

Specified by:

iterator in interface List<BsonValue>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<BsonValue>

Specified by:

toArray in interface List<BsonValue>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<BsonValue>

Specified by:

toArray in interface List<BsonValue>

add

public boolean add(BsonValue bsonValue)

Specified by:

add in interface Collection<BsonValue>

Specified by:

add in interface List<BsonValue>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<BsonValue>

Specified by:

remove in interface List<BsonValue>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<BsonValue>

Specified by:

containsAll in interface List<BsonValue>

addAll

public boolean addAll(Collection<? extends BsonValue> c)

Specified by:

addAll in interface Collection<BsonValue>

Specified by:

addAll in interface List<BsonValue>

addAll

public boolean addAll(int index,
 Collection<? extends BsonValue> c)

Specified by:

addAll in interface List<BsonValue>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<BsonValue>

Specified by:

removeAll in interface List<BsonValue>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<BsonValue>

Specified by:

retainAll in interface List<BsonValue>

clear

public void clear()

Specified by:

clear in interface Collection<BsonValue>

Specified by:

clear in interface List<BsonValue>

get

public BsonValue get(int index)

Specified by:

get in interface List<BsonValue>

set

public BsonValue set(int index,
 BsonValue element)

Specified by:

set in interface List<BsonValue>

add

public void add(int index,
 BsonValue element)

Specified by:

add in interface List<BsonValue>

remove

public BsonValue remove(int index)

Specified by:

remove in interface List<BsonValue>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<BsonValue>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<BsonValue>

listIterator

public ListIterator<BsonValue> listIterator()

Specified by:

listIterator in interface List<BsonValue>

listIterator

public ListIterator<BsonValue> listIterator(int index)

Specified by:

listIterator in interface List<BsonValue>

subList

public List<BsonValue> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<BsonValue>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<BsonValue>

Specified by:

equals in interface List<BsonValue>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<BsonValue>

Specified by:

hashCode in interface List<BsonValue>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public BsonArray clone()

Overrides:

clone in class Object