Package org.bson

Interface BSONObject

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsField​(java.lang.String s)
      Checks if this object contains a field with the given name.
      boolean containsKey​(java.lang.String key)
      Deprecated.
      Please use containsField(String) instead
      java.lang.Object get​(java.lang.String key)
      Gets a field from this object by a given name.
      java.util.Set<java.lang.String> keySet()
      Returns this object's fields' names
      java.lang.Object put​(java.lang.String key, java.lang.Object v)
      Sets a name/value pair in this object.
      void putAll​(java.util.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
      java.lang.Object removeField​(java.lang.String key)
      Removes a field with a given name from this object.
      java.util.Map toMap()
      Returns a map representing this BSONObject.

    • Method Detail

      • put

        java.lang.Object put​(java.lang.String key,
                     java.lang.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​(java.util.Map m)
        Sets all key/value pairs from a map into this object
        Parameters:
        m - the map

      • get

        java.lang.Object get​(java.lang.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

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

      • removeField

        java.lang.Object removeField​(java.lang.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

      • containsKey

        @Deprecated
boolean containsKey​(java.lang.String key)
        Deprecated.
        Please use containsField(String) instead
        Deprecated
        Parameters:
        key - the key to check
        Returns:
        True if the key is present

      • containsField

        boolean containsField​(java.lang.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

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