Skip to content

Commit

Permalink
Fix incorrect javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
prdoyle committed Jan 19, 2025
1 parent 45684ff commit e770e3f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
9 changes: 9 additions & 0 deletions bosk-bson/src/main/java/works/bosk/bson/BsonFormatter.java
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,15 @@ public enum DocumentFields {
/**
* The location of this document's state within the conceptual giant document.
* A pipe-separated list of BSON field names.
*
* <p>
* We put the whole path in _id so that it will be present in change stream documents.
*/
_id,

/**
* The {@link Path#urlEncoded() url encoded} {@link Path path} of the location of
* this document's state within the bosk tree.
*/
path,

Expand Down
8 changes: 3 additions & 5 deletions bosk-bson/src/main/java/works/bosk/bson/BsonSurgeon.java
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,7 @@ public GraftPoint boundTo(Identifier id) {
}
}

/**
* We put the whole path in _id so that it will be present in change stream documents
*/
private static final String BSON_PATH_FIELD = "_id";
private static final String BSON_PATH_FIELD = DocumentFields._id.name();

private static final String STATE_FIELD = DocumentFields.state.name();

Expand Down Expand Up @@ -197,7 +194,8 @@ private static BsonDocument lookup(BsonDocument entireDoc, List<String> segments
*
* <p>
* <code>partsList</code> is a list of "instructions" for assembling a larger document.
* Each part contains a {@link DocumentFields#path path} field containing a {@link BsonFormatter#docBsonPath BSON path}
* Each part contains a {@link DocumentFields#_id _id} field containing
* a {@link BsonFormatter#docBsonPath BSON path}
* that indicates where that part fits into the larger document;
* and a {@link DocumentFields#state state} field with the contents of the part.
*
Expand Down

0 comments on commit e770e3f

Please sign in to comment.