Package com.adobe.pdfservices.operation.pdfjobs.params.extractpdf

Class ExtractPDFParams.Builder

java.lang.Object

com.adobe.pdfservices.operation.pdfjobs.params.extractpdf.ExtractPDFParams.Builder

Enclosing class:

ExtractPDFParams

public static class ExtractPDFParams.Builder
extends Object

Static Builder class for Extract PDF Params

Method Summary

Modifier and Type	Method	Description
ExtractPDFParams.Builder	addCharInfo(Boolean addCharInfo)	Boolean specifying whether to add character level bounding boxes to output json
ExtractPDFParams.Builder	addElementsToExtract(List<ExtractElementType> elementsToExtract)	Adds ExtractElementType to the list of elements to be extracted.
ExtractPDFParams.Builder	addElementsToExtractRenditions(List<ExtractRenditionsElementType> elementsToExtractRenditions)	Adds ExtractRenditionsElementType to the list of elements to be extracted.
ExtractPDFParams.Builder	addElementToExtract(ExtractElementType elementToExtract)	Adds an ExtractElementType to the list of elements to be extracted.
ExtractPDFParams.Builder	addElementToExtractRenditions(ExtractRenditionsElementType elementToExtractRenditions)	Adds a ExtractRenditionsElementType
ExtractPDFParams.Builder	addGetStylingInfo(Boolean getStylingInfo)	Boolean specifying whether to add styling information to output json
ExtractPDFParams.Builder	addTableStructureFormat(TableStructureType tableStructureType)	Adds the TableStructureType for table renditions
ExtractPDFParams	build()	Returns a new ExtractPDFParams instance built from the current state of this builder.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addElementToExtract

public ExtractPDFParams.Builder addElementToExtract(ExtractElementType elementToExtract)

Adds an ExtractElementType to the list of elements to be extracted.

Parameters:

elementToExtract - ExtractElementType parameter

Returns:

this Builder instance to add any additional parameters

addElementsToExtract

public ExtractPDFParams.Builder addElementsToExtract(List<ExtractElementType> elementsToExtract)

Adds ExtractElementType to the list of elements to be extracted.

Parameters:

elementsToExtract - The list of ExtractElementType to extract

Returns:

this Builder instance to add any additional parameters

addElementToExtractRenditions

public ExtractPDFParams.Builder addElementToExtractRenditions(ExtractRenditionsElementType elementToExtractRenditions)

Adds a ExtractRenditionsElementType

Parameters:

elementToExtractRenditions - the ExtractRenditionsElementType parameter

Returns:

this Builder instance to add any additional parameters

addElementsToExtractRenditions

public ExtractPDFParams.Builder addElementsToExtractRenditions(List<ExtractRenditionsElementType> elementsToExtractRenditions)

Adds ExtractRenditionsElementType to the list of elements to be extracted.

Parameters:

elementsToExtractRenditions - The list of ExtractRenditionsElementType to extract

Returns:

this Builder instance to add any additional parameters

addTableStructureFormat

public ExtractPDFParams.Builder addTableStructureFormat(TableStructureType tableStructureType)

Adds the TableStructureType for table renditions

Parameters:

tableStructureType - TableStructureType for output type of table structure.

Returns:

this Builder instance to add any additional parameters

addCharInfo

public ExtractPDFParams.Builder addCharInfo(Boolean addCharInfo)

Boolean specifying whether to add character level bounding boxes to output json

Parameters:

addCharInfo - Boolean

Returns:

this Builder instance to add any additional parameters

addGetStylingInfo

public ExtractPDFParams.Builder addGetStylingInfo(Boolean getStylingInfo)

Boolean specifying whether to add styling information to output json

Parameters:

getStylingInfo - Boolean

Returns:

this Builder instance to add any additional parameters

build

public ExtractPDFParams build()

Returns a new ExtractPDFParams instance built from the current state of this builder.

Returns:

a new ExtractPDFParams instance