Package org.bson.types
Class BasicBSONList
- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractList<E>
-
- java.util.ArrayList<Object>
-
- org.bson.types.BasicBSONList
-
- All Implemented Interfaces:
Serializable,Cloneable,Iterable<Object>,Collection<Object>,List<Object>,RandomAccess,BSONObject
- Direct Known Subclasses:
BasicDBList
public class BasicBSONList extends ArrayList<Object> implements BSONObject
Utility class to allow array
DBObjects to be created.Note: MongoDB will also create arrays from
java.util .Lists.BSONObject obj = new BasicBSONList(); obj.put( "0", value1 ); obj.put( "4", value2 ); obj.put( 2, value3 );
This simulates the array [ value1, null, value3, null, value2 ] by creating the
DBObject{ "0" : value1, "1" : null, "2" : value3, "3" : null, "4" : value2 }.BasicBSONList only supports numeric keys. Passing strings that cannot be converted to ints will cause an IllegalArgumentException.
BasicBSONList list = new BasicBSONList(); list.put("1", "bar"); // ok list.put("1E1", "bar"); // throws exception- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class java.util.AbstractList
modCount
-
-
Constructor Summary
Constructors Constructor Description BasicBSONList()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsField(String key)Checks if this object contains a field with the given name.booleancontainsKey(String key)Deprecated.Objectget(String key)Gets a value at an index.Set<String>keySet()Returns this object's fields' namesObjectput(int key, Object value)Puts a value at an index.Objectput(String key, Object v)Puts a value at an index.voidputAll(Map m)Sets all key/value pairs from a map into this objectvoidputAll(BSONObject o)Sets all key/value pairs from an object into this objectObjectremoveField(String key)Removes a field with a given name from this object.MaptoMap()Returns a map representing this BSONObject.-
Methods inherited from class java.util.AbstractCollection
containsAll, toString
-
Methods inherited from class java.util.AbstractList
equals, hashCode
-
Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
-
Methods inherited from interface java.util.Collection
parallelStream, stream
-
-
-
-
Method Detail
-
put
public Object put(String key, Object v)
Puts a value at an index. For interface compatibility. Must be passed a String that is parsable to an int.- Specified by:
putin interfaceBSONObject- Parameters:
key- the index at which to insert the valuev- the value to insert- Returns:
- the value
- Throws:
IllegalArgumentException- ifkeycannot be parsed into anint
-
put
public Object put(int key, Object value)
Puts a value at an index. This will fill any unset indexes less thanindexwithnull.- Parameters:
key- the index at which to insert the valuevalue- the value to insert- Returns:
- the value
-
putAll
public void putAll(Map m)
Description copied from interface:BSONObjectSets all key/value pairs from a map into this object- Specified by:
putAllin interfaceBSONObject- Parameters:
m- the map
-
putAll
public void putAll(BSONObject o)
Description copied from interface:BSONObjectSets all key/value pairs from an object into this object- Specified by:
putAllin interfaceBSONObject- Parameters:
o- the object
-
get
public Object get(String key)
Gets a value at an index. For interface compatibility. Must be passed a String that is parsable to an int.- Specified by:
getin interfaceBSONObject- Parameters:
key- the index- Returns:
- the value, if found, or null
- Throws:
IllegalArgumentException- ifkeycannot be parsed into anint
-
removeField
public Object removeField(String key)
Description copied from interface:BSONObjectRemoves a field with a given name from this object.- Specified by:
removeFieldin interfaceBSONObject- Parameters:
key- The name of the field to remove- Returns:
- The value removed from this object
-
containsKey
@Deprecated public boolean containsKey(String key)
Deprecated.Description copied from interface:BSONObjectDeprecated- Specified by:
containsKeyin interfaceBSONObject- Parameters:
key- the key to check- Returns:
- True if the key is present
-
containsField
public boolean containsField(String key)
Description copied from interface:BSONObjectChecks if this object contains a field with the given name.- Specified by:
containsFieldin interfaceBSONObject- Parameters:
key- Field name for which to check- Returns:
- True if the field is present
-
keySet
public Set<String> keySet()
Description copied from interface:BSONObjectReturns this object's fields' names- Specified by:
keySetin interfaceBSONObject- Returns:
- The names of the fields in this object
-
toMap
public Map toMap()
Description copied from interface:BSONObjectReturns a map representing this BSONObject.- Specified by:
toMapin interfaceBSONObject- Returns:
- the map
-
-