Package org.verapdf.processor

Interface ProcessorResult

public interface ProcessorResult

Method Summary

Modifier and Type	Method	Description
FeaturesReport	getFeaturesReport()
MetadataFixerResult	getFixerResult()
ItemDetails	getProcessedItem()
TaskResult	getResultForTask(TaskType taskType)
EnumMap<TaskType,TaskResult>	getResults()
Collection<TaskResult>	getResultSet()
EnumSet<TaskType>	getTaskTypes()
ValidationResult	getValidationResult()
boolean	hasException()
boolean	isEncryptedPdf()
boolean	isOutOfMemory()
boolean	isPdf()

Method Details

getProcessedItem

ItemDetails getProcessedItem()

Returns:

the ItemDetails for the item processed

getResults

EnumMap<TaskType,TaskResult> getResults()

Returns:

an EnumMap of TaskTypes and TaskResults for the TaskResults held in this ProcessorResult

getTaskTypes

EnumSet<TaskType> getTaskTypes()

Returns:

an EnumSet of the TaskTypes carried in this result.

getResultSet

Collection<TaskResult> getResultSet()

Returns:

the Collection of TaskResults for this ProcessorResult

getResultForTask

TaskResult getResultForTask(TaskType taskType)

Parameters:

taskType - the TaskType to retrieve the TaskResult for

Returns:

the TaskResult result for taskType

getValidationResult

ValidationResult getValidationResult()

Returns:

the ValidationResult or ValidationResults.defaultResult() if validation not performed.

getFeaturesReport

FeaturesReport getFeaturesReport()

Returns:

the FeaturesReport.

getFixerResult

MetadataFixerResult getFixerResult()

Returns:

the MetadataFixerResult

isPdf

boolean isPdf()

Returns:

true if the parsed file was a valid PDF, false if the PDF parser failed to parse the document and couldn't continue to process it.

isEncryptedPdf

boolean isEncryptedPdf()

Returns:

true if the parser detected that the PDF was encrypted and could not continue to process it.

isOutOfMemory

boolean isOutOfMemory()

Returns:

true if the parser detected OutOfMemoryException and could not continue to process PDF.

hasException

boolean hasException()

Returns:

true if processed PDF has VeraPDFException.