Package org.bson

Interface BSONObject

All Known Implementing Classes:
BasicBSONList, BasicBSONObject, LazyBSONList, LazyBSONObject
public interface BSONObject
A key-value map that can be saved to the database.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsField(String s)
    Checks if this object contains a field with the given name.
    Object
    get(String key)
    Gets a field from this object by a given name.
    Set<String>
    keySet()
    Returns this object's fields' names
    Object
    put(String key, Object v)
    Sets a name/value pair in this object.
    void
    putAll(Map m)
    Sets all key/value pairs from a map into this object
    void
    putAll(BSONObject o)
    Sets all key/value pairs from an object into this object
    Object
    removeField(String key)
    Removes a field with a given name from this object.
    Map
    toMap()
    Returns a map representing this BSONObject.

  • Method Details

    • put

      Object put(String key, Object v)
      Sets a name/value pair in this object.
      Parameters:
      key - Name to set
      v - Corresponding value
      Returns:
      the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key.)

    • putAll

      void putAll(BSONObject o)
      Sets all key/value pairs from an object into this object
      Parameters:
      o - the object

    • putAll

      void putAll(Map m)
      Sets all key/value pairs from a map into this object
      Parameters:
      m - the map

    • get

      Object get(String key)
      Gets a field from this object by a given name.
      Parameters:
      key - The name of the field fetch
      Returns:
      The field, if found

    • toMap

      Map toMap()
      Returns a map representing this BSONObject.
      Returns:
      the map

    • removeField

      Object removeField(String key)
      Removes a field with a given name from this object.
      Parameters:
      key - The name of the field to remove
      Returns:
      The value removed from this object

    • containsField

      boolean containsField(String s)
      Checks if this object contains a field with the given name.
      Parameters:
      s - Field name for which to check
      Returns:
      True if the field is present

    • keySet

      Set<String> keySet()
      Returns this object's fields' names
      Returns:
      The names of the fields in this object