Package org.bson

Class BasicBSONObject

    • Constructor Detail

      • BasicBSONObject

        public BasicBSONObject​()
        Creates an empty object.
      • BasicBSONObject

        public BasicBSONObject​(int size)
        Creates an empty object.
        Parameters:
        size - the initial capacity for the Map storing this document.
      • BasicBSONObject

        public BasicBSONObject​(String key,
                               Object value)
        Creates a BSONObject initialised with a single key/value pair.
        Parameters:
        key - key under which to store
        value - value to store
      • BasicBSONObject

        public BasicBSONObject​(Map map)
        Creates a DBObject from a map.
        Parameters:
        map - map to convert
    • Method Detail

      • toMap

        public Map toMap​()
        Converts a DBObject to a map.
        Specified by:
        toMap in interface BSONObject
        Returns:
        the DBObject
      • removeField

        public Object removeField​(String key)
        Deletes a field from this object.
        Specified by:
        removeField in interface BSONObject
        Parameters:
        key - the field name to remove
        Returns:
        the object removed
      • containsField

        public boolean containsField​(String field)
        Checks if this object contains a given field
        Specified by:
        containsField in interface BSONObject
        Parameters:
        field - field name
        Returns:
        if the field exists
      • containsKey

        @Deprecated
        public boolean containsKey​(String key)
        Deprecated. 
        Description copied from interface: BSONObject
        Deprecated
        Specified by:
        containsKey in interface BSONObject
        Parameters:
        key - the key to check
        Returns:
        True if the key is present
      • get

        public Object get​(String key)
        Gets a value from this object
        Specified by:
        get in interface BSONObject
        Parameters:
        key - field name
        Returns:
        the value
      • getInt

        public int getInt​(String key)
        Returns the value of a field as an int.
        Parameters:
        key - the field to look for
        Returns:
        the field value (or default)
      • getInt

        public int getInt​(String key,
                          int def)
        Returns the value of a field as an int.
        Parameters:
        key - the field to look for
        def - the default to return
        Returns:
        the field value (or default)
      • getLong

        public long getLong​(String key)
        Returns the value of a field as a long.
        Parameters:
        key - the field to return
        Returns:
        the field value
      • getLong

        public long getLong​(String key,
                            long def)
        Returns the value of a field as an long.
        Parameters:
        key - the field to look for
        def - the default to return
        Returns:
        the field value (or default)
      • getDouble

        public double getDouble​(String key)
        Returns the value of a field as a double.
        Parameters:
        key - the field to return
        Returns:
        the field value
      • getDouble

        public double getDouble​(String key,
                                double def)
        Returns the value of a field as an double.
        Parameters:
        key - the field to look for
        def - the default to return
        Returns:
        the field value (or default)
      • getString

        public String getString​(String key)
        Returns the value of a field as a string
        Parameters:
        key - the field to look up
        Returns:
        the value of the field, converted to a string
      • getString

        public String getString​(String key,
                                String def)
        Returns the value of a field as a string
        Parameters:
        key - the field to look up
        def - the default to return
        Returns:
        the value of the field, converted to a string
      • getBoolean

        public boolean getBoolean​(String key)
        Returns the value of a field as a boolean.
        Parameters:
        key - the field to look up
        Returns:
        the value of the field, or false if field does not exist
      • getBoolean

        public boolean getBoolean​(String key,
                                  boolean def)
        Returns the value of a field as a boolean
        Parameters:
        key - the field to look up
        def - the default value in case the field is not found
        Returns:
        the value of the field, converted to a string
      • getObjectId

        public ObjectId getObjectId​(String field)
        Returns the object id or null if not set.
        Parameters:
        field - The field to return
        Returns:
        The field object value or null if not found (or if null :-^).
      • getObjectId

        public ObjectId getObjectId​(String field,
                                    ObjectId def)
        Returns the object id or def if not set.
        Parameters:
        field - The field to return
        def - the default value in case the field is not found
        Returns:
        The field object value or def if not set.
      • getDate

        public Date getDate​(String field)
        Returns the date or null if not set.
        Parameters:
        field - The field to return
        Returns:
        The field object value or null if not found.
      • getDate

        public Date getDate​(String field,
                            Date def)
        Returns the date or def if not set.
        Parameters:
        field - The field to return
        def - the default value in case the field is not found
        Returns:
        The field object value or def if not set.
      • putAll

        public void putAll​(BSONObject o)
        Description copied from interface: BSONObject
        Sets all key/value pairs from an object into this object
        Specified by:
        putAll in interface BSONObject
        Parameters:
        o - the object
      • append

        public BasicBSONObject append​(String key,
                                      Object val)
        Add a key/value pair to this object
        Parameters:
        key - the field name
        val - the field value
        Returns:
        this
      • equals

        public boolean equals​(Object o)
        Compares two documents according to their serialized form, ignoring the order of keys.
        Specified by:
        equals in interface Map<String,Object>
        Overrides:
        equals in class AbstractMap<String,Object>
        Parameters:
        o - the document to compare to, which must be an instance of BSONObject.
        Returns:
        true if the documents have the same serialized form, ignoring key order.