public static final class

IndexingOptions.Builder

extends Object
java.lang.Object
   ↳ com.pspdfkit.document.library.IndexingOptions.Builder

Class Overview

Builder for creating IndexingOptions that can be used with enqueueDocuments(List, IndexingOptions).

Summary

Public Constructors
Builder()
Public Methods
IndexingOptions build()
Creates the immutable IndexingOptions object.
IndexingOptions.Builder setIgnoreAnnotations(boolean ignoreAnnotations)
Sets whether annotations should be ignored while indexing or not.
IndexingOptions.Builder setIgnoreDocumentText(boolean ignoreDocumentText)
Sets whether document text (i.e.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Builder ()

Public Methods

public IndexingOptions build ()

Creates the immutable IndexingOptions object.

Returns

public IndexingOptions.Builder setIgnoreAnnotations (boolean ignoreAnnotations)

Sets whether annotations should be ignored while indexing or not. This defaults to false, which means annotations are added to the index.

Parameters
ignoreAnnotations true to disable annotation indexing, or false to enable it. Defaults to false.
Returns
  • This builder for further actions.

public IndexingOptions.Builder setIgnoreDocumentText (boolean ignoreDocumentText)

Sets whether document text (i.e. text in the page body) should be ignored while indexing or not. This defaults to false, which means document text is added to the index.

Parameters
ignoreDocumentText true to disable document text indexing, or false to enable it. Defaults to false.
Returns
  • This builder for further actions.