Package org.apache.pdfbox.preflight

Class PreflightDocument

java.lang.Object

org.apache.pdfbox.pdmodel.PDDocument

org.apache.pdfbox.preflight.PreflightDocument

All Implemented Interfaces:

Closeable, AutoCloseable

public class PreflightDocument
extends PDDocument

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	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 config)	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	Description
void	addValidationError(ValidationResult.ValidationError error)
PreflightContext	getContext()
ValidationResult	getResult()
Format	getSpecification()	Returns the format which is used to validate the pdf document.
private void	initConfiguration(Format format)
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, addSignature, addSignature, addSignatureField, close, getCurrentAccessPermission, getDocument, getDocumentCatalog, getDocumentId, getDocumentInformation, getEncryption, getLastSignatureDictionary, getNumberOfPages, getPage, getPages, getResourceCache, getSignatureDictionaries, getSignatureFields, getVersion, importPage, isAllSecurityToBeRemoved, isEncrypted, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, protect, registerTrueTypeFontForClosing, removePage, removePage, save, save, save, saveIncremental, saveIncremental, saveIncrementalForExternalSigning, setAllSecurityToBeRemoved, setDocumentId, setDocumentInformation, setEncryptionDictionary, setResourceCache, setVersion

Methods inherited from class java.lang.Object

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

Field Details

result

private ValidationResult result

config

private PreflightConfiguration config

context

private PreflightContext context

specification

private final Format specification

Constructor Details

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 config)

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 -

config -

Method Details

initConfiguration

private void initConfiguration(Format format)

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()

Returns the format which is used to validate the pdf document.

Returns:

the format used for validation