Apache PDFBox 3.0.4 · org.apache.pdfbox.preflight.PreflightContext

Field Summary

Modifier and Type	Field and Description
private PreflightConfiguration	config
private Integer	currentPageNumber
private PreflightDocument	document The PDFbox object representation of the PDF source.
private long	fileLen
private final Map<COSBase, FontContainer<?>>	fontContainers Contains the list of font name embedded in the PDF document.
private boolean	iccProfileAlreadySearched
private ICCProfileWrapper	iccProfileWrapper This wrapper contains the ICCProfile used by the PDF file.
private XMPMetadata	metadata MetaData of the current pdf file.
private final Set<COSObjectable>	processedSet
private PreflightPath	validationPath
private XrefTrailerResolver	xrefTrailerResolver Contains all Xref/trailer objects and resolves them into single object using startxref reference.

Constructor Summary

Access	Constructor and Description
public	PreflightContext() Create the DocumentHandler using the DataSource which represent the PDF file to check.
public	PreflightContext(PreflightConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
public void	addFontContainer(COSBase the COSBase for the font container. cBase, FontContainer<?> the font container. fc) Add a FontContainer to allow TextObject validation.
public void	addToProcessedSet(COSObjectable cos) Add the argument to the set of processed elements,
public void	addValidationError(ValidationResult.ValidationError error) Add the given error the PreflightDocument
public void	addValidationErrors(List<ValidationResult.ValidationError> the list of validation errors. errors) Add the given errors the PreflightDocument
public void	close() Implements java.io.Closeable.close. Close all opened resources
public PreflightConfiguration	getConfig()
public Integer	getCurrentPageNumber() Returns the current page number or null if none is known.
public PreflightDocument	Returns: the PDFBox object representation of the document getDocument()
public long	getFileLen()
public FontContainer<?>	Returns: the font container. getFontContainer(COSBase the COSBase for the font container cBase) Return the FontContainer identified by the COSBase.
public ICCProfileWrapper	Returns: the iccProfileWrapper getIccProfileWrapper()
public XMPMetadata	Returns: the metadata getMetadata()
public PreflightPath	getValidationPath()
public XrefTrailerResolver	getXrefTrailerResolver()
public boolean	isIccProfileAlreadySearched()
public boolean	Returns: true if in the set, false if not. isInProcessedSet(COSObjectable cos) Tell if the argument is in the set of processed elements.
public void	setConfig(PreflightConfiguration config)
public void	setCurrentPageNumber(Integer zero based page number or null if none is known. currentPageNumber) Sets or resets the current page number.
public void	setDocument(PreflightDocument document) Initialize the PDFBox object which present the PDF File.
public void	setFileLen(long fileLen)
public void	setIccProfileAlreadySearched(boolean iccProfileAlreadySearched)
public void	setIccProfileWrapper(ICCProfileWrapper the iccProfileWrapper to set iccProfileWrapper)
public void	setMetadata(XMPMetadata the metadata to set metadata)
public void	setValidationPath(PreflightPath validationPath)
public void	setXrefTrailerResolver(XrefTrailerResolver xrefTrailerResolver)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

config	back to summary
private PreflightConfiguration config

currentPageNumber	back to summary
private Integer currentPageNumber

document	back to summary
private PreflightDocument document The PDFbox object representation of the PDF source.

fileLen	back to summary
private long fileLen

fontContainers	back to summary
private final Map<COSBase, FontContainer<?>> fontContainers Contains the list of font name embedded in the PDF document.

iccProfileAlreadySearched	back to summary
private boolean iccProfileAlreadySearched

iccProfileWrapper	back to summary
private ICCProfileWrapper iccProfileWrapper This wrapper contains the ICCProfile used by the PDF file.

metadata	back to summary
private XMPMetadata metadata MetaData of the current pdf file.

processedSet	back to summary
private final Set<COSObjectable> processedSet

validationPath	back to summary
private PreflightPath validationPath

xrefTrailerResolver	back to summary
private XrefTrailerResolver xrefTrailerResolver Contains all Xref/trailer objects and resolves them into single object using startxref reference.

Constructor Detail

PreflightContext	back to summary
public PreflightContext() Create the DocumentHandler using the DataSource which represent the PDF file to check.

PreflightContext	back to summary
public PreflightContext(PreflightConfiguration configuration)

Method Detail

addFontContainer	back to summary
public void addFontContainer(COSBase cBase, FontContainer<?> fc) Add a FontContainer to allow TextObject validation. Parameters cBase:COSBase the COSBase for the font container. fc:FontContainer<?> the font container.

addFontContainer

back to summary

public void addFontContainer(COSBase cBase, FontContainer<?> fc)

Add a FontContainer to allow TextObject validation.

Parameters

cBase:COSBase: the COSBase for the font container.
fc:FontContainer<?>: the font container.

addToProcessedSet	back to summary
public void addToProcessedSet(COSObjectable cos) Add the argument to the set of processed elements,

addValidationError	back to summary
public void addValidationError(ValidationResult.ValidationError error) Add the given error the PreflightDocument

addValidationErrors	back to summary
public void addValidationErrors(List<ValidationResult.ValidationError> errors) Add the given errors the PreflightDocument Parameters errors:List<ValidationResult.ValidationError> the list of validation errors.

addValidationErrors

back to summary

public void addValidationErrors(List<ValidationResult.ValidationError> errors)

Add the given errors the PreflightDocument

Parameters

errors:List<ValidationResult.ValidationError>: the list of validation errors.

close	back to summary
public void close() Implements java.io.Closeable.close. Close all opened resources Annotations @Override

back to summary

public void close()

Implements java.io.Closeable.close.

Close all opened resources

Annotations

@Override

getConfig	back to summary
public PreflightConfiguration getConfig()

getCurrentPageNumber	back to summary
public Integer getCurrentPageNumber() Returns the current page number or null if none is known.

getDocument	back to summary
public PreflightDocument getDocument() Returns:PreflightDocument the PDFBox object representation of the document

getFileLen	back to summary
public long getFileLen()

getFontContainer back to summary

getFontContainer	back to summary
public FontContainer<?> getFontContainer(COSBase cBase) Return the FontContainer identified by the COSBase. If the given object is missing from the `fontContainers` map, the null value is returned. Parameters cBase:COSBase the COSBase for the font container Returns:FontContainer<?> the font container.

public FontContainer<?> getFontContainer(COSBase cBase)

Return the FontContainer identified by the COSBase. If the given object is missing from the fontContainers map, the null value is returned.

Parameters

cBase:COSBase: the COSBase for the font container

Returns:FontContainer<?>

the font container.

getIccProfileWrapper	back to summary
public ICCProfileWrapper getIccProfileWrapper() Returns:ICCProfileWrapper the iccProfileWrapper

getMetadata	back to summary
public XMPMetadata getMetadata() Returns:XMPMetadata the metadata

getValidationPath	back to summary
public PreflightPath getValidationPath()

getXrefTrailerResolver	back to summary
public XrefTrailerResolver getXrefTrailerResolver()

isIccProfileAlreadySearched	back to summary
public boolean isIccProfileAlreadySearched()

isInProcessedSet	back to summary
public boolean isInProcessedSet(COSObjectable cos) Tell if the argument is in the set of processed elements. Returns:boolean true if in the set, false if not.

isInProcessedSet

back to summary

public boolean isInProcessedSet(COSObjectable cos)

Tell if the argument is in the set of processed elements.

Returns:boolean: true if in the set, false if not.

setConfig	back to summary
public void setConfig(PreflightConfiguration config)

setCurrentPageNumber	back to summary
public void setCurrentPageNumber(Integer currentPageNumber) Sets or resets the current page number. Parameters currentPageNumber:Integer zero based page number or null if none is known.

setCurrentPageNumber

back to summary

public void setCurrentPageNumber(Integer currentPageNumber)

Sets or resets the current page number.

Parameters

currentPageNumber:Integer: zero based page number or null if none is known.

setDocument	back to summary
public void setDocument(PreflightDocument document) Initialize the PDFBox object which present the PDF File.

setFileLen	back to summary
public void setFileLen(long fileLen)

setIccProfileAlreadySearched	back to summary
public void setIccProfileAlreadySearched(boolean iccProfileAlreadySearched)

setIccProfileWrapper	back to summary
public void setIccProfileWrapper(ICCProfileWrapper iccProfileWrapper) Parameters iccProfileWrapper:ICCProfileWrapper the iccProfileWrapper to set

setMetadata	back to summary
public void setMetadata(XMPMetadata metadata) Parameters metadata:XMPMetadata the metadata to set

setValidationPath	back to summary
public void setValidationPath(PreflightPath validationPath)

setXrefTrailerResolver	back to summary
public void setXrefTrailerResolver(XrefTrailerResolver xrefTrailerResolver)

public Class PreflightContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail