Javadoc for Document Context Handling #1030
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✨ What’s new in this PR
A focused documentation pass over Chronicle Wire’s document-context stack plus one tiny API convenience method.
Brand-new
DocumentContext#isOpen()
default method– a friendly alias that mirrors
isNotComplete()
and reads more intuitively in client code.Thorough, consistent Javadoc across the read/write context family
(
DocumentContext
,WriteDocumentContext
,ReadDocumentContext
,Text*DocumentContext
,Binary*DocumentContext
,DocumentContextHolder
,WrappedDocumentContext
,NoDocumentContext
,DocumentWritten
).No behavioural changes – only comments and the small, backwards-compatible addition of
isOpen()
.Commit guide
isOpen()
(defaults toisNotComplete()
) + stub Javadoc.DocumentContext
Javadoc (#1021)WriteDocumentContext
Javadoc (#1022)ReadDocumentContext
behaviour (#1023)TextReadDocumentContext
Javadoc (#1024)---/…
parsing helpers.TextWriteDocumentContext
Javadoc (#1025)BinaryReadDocumentContext
Javadoc (#1026)BinaryWriteDocumentContext
Javadoc (#1027)NoDocumentContext
,WrappedDocumentContext
).