Skip to content

Commit dc9888e

Browse files
pjfanningcowtowncoder
authored andcommitted
update docs about maxDocumentLength to say the check is not exact (#1430)
1 parent 431db5b commit dc9888e

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/main/java/com/fasterxml/jackson/core/StreamReadConstraints.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,11 @@ public Builder maxNestingDepth(final int maxNestingDepth) {
150150
* indicate that any length is acceptable ({@code 0} or negative number).
151151
* The length is in input units of the input source, that is, in
152152
* {@code byte}s or {@code char}s.
153-
*
153+
* <p>
154+
* The check is not done after every byte or character but checked when a
155+
* new chunk of data is read. This means that the check is not likely to be exact
156+
* but that documents smaller than this limit will be treated as valid.
157+
* </p>
154158
* @param maxDocLen the maximum allowed document length if positive number above 0; otherwise
155159
* ({@code 0} or negative number) means "unlimited".
156160
*

0 commit comments

Comments
 (0)