Package software.amazon.awssdk.core.document

Interface Document.MapBuilder

    • Method Detail

      • putString

        Document.MapBuilder putString​(String key,
                              String stringValue)
        Inserts a Key Value pair to a Document Map with String key and a Document created from the given String.
        Parameters:
        key - Map Key for the Document.
        stringValue - String value which will be used to create a Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putNumber

        Document.MapBuilder putNumber​(String key,
                              SdkNumber numberValue)
        Inserts a Key Value pair to a Document Map with String key and a Document created from the given Number.
        Parameters:
        key - Map Key for the Document.
        numberValue - Number value which will be used to create a Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putNumber

        Document.MapBuilder putNumber​(String key,
                              int numberValue)
        Inserts a Key Value pair to a Document Map with String key and a Document created from the given integer.
        Parameters:
        key - Map Key for the Document.
        numberValue - Integer value which will be used to create a Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putNumber

        Document.MapBuilder putNumber​(String key,
                              long numberValue)
        Inserts a Key Value pair to a Document Map with String key and a Document created from the given long.
        Parameters:
        key - Map Key for the Document.
        numberValue - long value which will be used to create a Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putNumber

        Document.MapBuilder putNumber​(String key,
                              double numberValue)
        Inserts a Key Value pair to a Document Map with String key and a Document created from the given double.
        Parameters:
        key - Map Key for the Document.
        numberValue - double value which will be used to create a Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putNumber

        Document.MapBuilder putNumber​(String key,
                              float numberValue)
        Inserts a Key Value pair to a Document Map with String key and a Document created from the given float.
        Parameters:
        key - Map Key for the Document.
        numberValue - float value which will be used to create a Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putNumber

        Document.MapBuilder putNumber​(String key,
                              BigDecimal numberValue)
        Inserts a Key Value pair to a Document Map with String key and a Document created from the given BigDecimal.
        Parameters:
        key - Map Key for the Document.
        numberValue - BigDecimal value which will be used to create a Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putNumber

        Document.MapBuilder putNumber​(String key,
                              BigInteger numberValue)
        Inserts a Key Value pair to a Document Map with String key and a Document created from the given BigInteger.
        Parameters:
        key - Map Key for the Document.
        numberValue - BigInteger value which will be used to create a Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putNumber

        Document.MapBuilder putNumber​(String key,
                              String numberValue)
        Inserts a Key Value pair to a Document Map with String key and a Document created from the given String.
        Parameters:
        key - Map Key for the Document.
        numberValue - String value which will be used to create a Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putBoolean

        Document.MapBuilder putBoolean​(String key,
                               boolean booleanValue)
        Inserts a Key Value pair to a Document Map with String key and a Document created from the given boolean.
        Parameters:
        key - Map Key for the Document.
        booleanValue - Boolean value which will be used to create a Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putDocument

        Document.MapBuilder putDocument​(String key,
                                Document document)
        Inserts a Key Value pair to a Document Map with String key and the given Document.
        Parameters:
        key - Map Key for the Document.
        document - Document to be inserted in a DocumentMap.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putNull

        Document.MapBuilder putNull​(String key)
        Inserts a Key Value pair to a Document Map with String key and value with Null Document.
        Parameters:
        key - Map Key for the Document.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putList

        Document.MapBuilder putList​(String key,
                            List<Document> documentList)
        Inserts a Key Value pair to a Document Map with String key and value as List of Document.
        Parameters:
        key - Map Key for the Document.
        documentList - List of Documents.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • putMap

        Document.MapBuilder putMap​(String key,
                           Map<String,​Document> documentMap)
        Inserts a Key Value pair to a Document Map with String key and Document constructed from Document Map.
        Parameters:
        key - Map Key for the Document.
        documentMap - Map of Document.
        Returns:
        Builder which provides APIs to put Key Value pair to a Document Map.

      • build

        Document build()
        Creates a new Document with the key value pair pair inserted using put method.
        Returns:
        The new Document.