org.apache.pdfbox.preflight

Class PreflightDocument

java.lang.Object

org.apache.pdfbox.pdmodel.PDDocument

org.apache.pdfbox.preflight.PreflightDocument

All Implemented Interfaces:

Pageable, Closeable, AutoCloseable

public class PreflightDocument
extends PDDocument

Field Summary

Fields

Modifier and Type	Field and Description
protected PreflightConfiguration	config
protected PreflightContext	context
protected ValidationResult	result
protected Format	specification

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Constructor Summary

Constructors

Constructor and Description
PreflightDocument(COSDocument doc, Format format) Create a preflight document based on the COSDocument and load the default configuration for the given format.
PreflightDocument(COSDocument doc, Format format, PreflightConfiguration cfg) Create a preflight document based on the COSDocument that will use the given configuration bean to process the validation.
PreflightDocument(Format format) Create an empty preflight document and load the default configuration for the given format.
PreflightDocument(Format format, PreflightConfiguration cfg) Create an empty preflight document that will use the given configuration bean to process the validation.

Method Summary

Modifier and Type	Method and Description
void	addValidationError(ValidationResult.ValidationError error)
PreflightContext	getContext()
ValidationResult	getResult()
Format	getSpecification()
void	setContext(PreflightContext context)
void	setResult(ValidationResult _result)
void	validate() Check that PDDocument is a valid file according to the format given during the object creation.

Methods inherited from class org.apache.pdfbox.pdmodel.PDDocument

addPage, addSignature, addSignature, addSignatureField, clearWillEncryptWhenSaving, close, decrypt, encrypt, getCurrentAccessPermission, getDocument, getDocumentCatalog, getDocumentId, getDocumentInformation, getEncryptionDictionary, getLastSignatureDictionary, getNumberOfPages, getOwnerPasswordForEncryption, getPageCount, getPageFormat, getPageMap, getPrintable, getSecurityHandler, getSignatureDictionaries, getSignatureDictionary, getSignatureFields, getUserPasswordForEncryption, importPage, isAllSecurityToBeRemoved, isEncrypted, isOwnerPassword, isUserPassword, load, load, load, load, load, load, load, load, load, load, load, load, loadNonSeq, loadNonSeq, loadNonSeq, loadNonSeq, openProtection, print, print, protect, removePage, removePage, save, save, save, saveIncremental, saveIncremental, setAllSecurityToBeRemoved, setDocumentId, setDocumentInformation, setEncryptionDictionary, setSecurityHandler, silentPrint, silentPrint, wasDecryptedWithOwnerPassword, willEncryptWhenSaving

Methods inherited from class java.lang.Object

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

Field Detail

result

protected ValidationResult result

config

protected PreflightConfiguration config

context

protected PreflightContext context

specification

protected final Format specification

Constructor Detail

PreflightDocument

public PreflightDocument(Format format)
                  throws IOException

Create an empty preflight document and load the default configuration for the given format.

Parameters:

format -

Throws:

IOException

PreflightDocument

public PreflightDocument(COSDocument doc,
                         Format format)

Create a preflight document based on the COSDocument and load the default configuration for the given format.

Parameters:

doc -

format -

PreflightDocument

public PreflightDocument(Format format,
                         PreflightConfiguration cfg)
                  throws IOException

Create an empty preflight document that will use the given configuration bean to process the validation. if the configuration is null, a default configuration will be load using the given format.

Parameters:

format -

cfg -

Throws:

IOException

PreflightDocument

public PreflightDocument(COSDocument doc,
                         Format format,
                         PreflightConfiguration cfg)

Create a preflight document based on the COSDocument that will use the given configuration bean to process the validation. if the configuration is null, a default configuration will be load using the given format.

Parameters:

doc -

format -

cfg -

Throws:

IOException

Method Detail

getResult

public ValidationResult getResult()

setResult

public void setResult(ValidationResult _result)

addValidationError

public void addValidationError(ValidationResult.ValidationError error)

getContext

public PreflightContext getContext()

setContext

public void setContext(PreflightContext context)

validate

public void validate()
              throws ValidationException

Check that PDDocument is a valid file according to the format given during the object creation.

Throws:

ValidationException

getSpecification

public Format getSpecification()