Skip to content

Commit 962304f

Browse files
committed
fix #247-clarify that newPatchBuilder works differently for xml or json than other formats
1 parent 228ae89 commit 962304f

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/main/java/com/marklogic/client/document/DocumentManager.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,12 @@ public enum Metadata {
8585
public DocumentUriTemplate newDocumentUriTemplate(String extension);
8686

8787
/**
88-
* Creates a builder for specifying changes to the metadata of a document.
89-
* @param pathFormat whether the patch specifies metadata with JSON or XML paths
88+
* For XMLDocumentManager or JSONDocumentManager, creates a builder for specifying changes
89+
* to the document and metadata of a document. For GenericDocumentManager,
90+
* TextDocumentManager, and BinaryDocumentManager, creates a builder for specifying
91+
* changes to only the metadata of a document since binary and text documents cannot
92+
* be changed with patches.
93+
* @param pathFormat whether the patch specifies with JSON or XML paths
9094
* @return the patch builder
9195
*/
9296
public DocumentMetadataPatchBuilder newPatchBuilder(Format pathFormat);

0 commit comments

Comments
 (0)