Skip to content

Commit 27da233

Browse files
committed
Add documentation to PdfReader#setMemorySavingMode()
DEVSIX-3594
1 parent 4260762 commit 27da233

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfReader.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,16 @@ public PdfReader setUnethicalReading(boolean unethicalReading) {
203203
return this;
204204
}
205205

206+
/**
207+
* Defines if memory saving mode is enabled.
208+
* <p>
209+
* By default memory saving mode is disabled for the sake of time–memory trade-off.
210+
* <p>
211+
* If memory saving mode is enabled, document processing might slow down, but reading will be less memory demanding.
212+
*
213+
* @param memorySavingMode true to enable memory saving mode, false to disable it.
214+
* @return this {@link PdfReader} instance.
215+
*/
206216
public PdfReader setMemorySavingMode(boolean memorySavingMode) {
207217
this.memorySavingMode = memorySavingMode;
208218
return this;

0 commit comments

Comments
 (0)