public static class

DocumentSaveOptions.Builder

extends Object
java.lang.Object
   ↳ com.pspdfkit.api.DocumentSaveOptions.Builder

Class Overview

A builder to help create the DocumentSaveOptions.

Summary

Public Constructors
Builder()
Public Methods
DocumentSaveOptions.Builder applyRedactionAnnotations(boolean applyRedactionAnnotations)
Sets whether to apply redaction annotations.
DocumentSaveOptions build()
Creates the DocumentSaveOptions with the builder options.
DocumentSaveOptions.Builder flattenAnnotations(boolean flattenAnnotations)
Sets whether to flatten the annotations into the document or not.
DocumentSaveOptions.Builder forceSave(boolean forceSave)
Forces PSPDFKit to save the document even if unmodified.
DocumentSaveOptions.Builder incrementalSave(boolean incremental)
Sets whether to save incrementally.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Builder ()

Public Methods

public DocumentSaveOptions.Builder applyRedactionAnnotations (boolean applyRedactionAnnotations)

Sets whether to apply redaction annotations. It is not possible to apply redaction annotations incrementally therefore a full save will be performed.

Parameters
applyRedactionAnnotations If to apply redaction annotations.
Returns
  • The build with incremental changed.

public DocumentSaveOptions build ()

Creates the DocumentSaveOptions with the builder options.

Returns

public DocumentSaveOptions.Builder flattenAnnotations (boolean flattenAnnotations)

Sets whether to flatten the annotations into the document or not. If enabled, incremental save will be ignored.

Parameters
flattenAnnotations If to flatten the annotations or not.
Returns
  • The build with incremental changed.

public DocumentSaveOptions.Builder forceSave (boolean forceSave)

Forces PSPDFKit to save the document even if unmodified.

Parameters
forceSave Set force save.
Returns
  • The build with force save changed.

public DocumentSaveOptions.Builder incrementalSave (boolean incremental)

Sets whether to save incrementally. An incremental save will not be performed if applyRedactionAnnotations(boolean) is set.

Parameters
incremental If to save incrementally.
Returns
  • The build with incremental changed.