org.verapdf.pdfa

Interface VeraPDFFoundry

All Superinterfaces:

AutoCloseable, Closeable, Component

public interface VeraPDFFoundry
extends Component

The veraPDFFoundry interface provides methods for creating implementations of the classes provided by a PDF Parser and Metadata Fixer implementations.

Version:

0.1 Created 21 Sep 2016:12:37:55

Author:

Carl Wilson carlwilson AT github

Method Summary

Methods

Modifier and Type	Method and Description
PDFAValidator	createFailFastValidator(PDFAFlavour flavour, int maxFailures)
PDFAValidator	createFailFastValidator(ValidationProfile profile, int maxFailures)
MetadataFixer	createMetadataFixer()
PDFAParser	createParser(InputStream pdfStream) Method that returns a PDFParser instance, parsing the passed pdfStream parameter.
PDFAParser	createParser(InputStream pdfStream, PDFAFlavour flavour) Method that returns a PDFParser instance, parsing the passed pdfStream parameter.
PDFAValidator	createValidator(PDFAFlavour flavour, boolean logSuccess)
PDFAValidator	createValidator(ValidationProfile profile, boolean logSuccess)
PDFAValidator	createValidator(ValidatorConfig config)
PDFAValidator	createValidator(ValidatorConfig config, PDFAFlavour flavour)
PDFAValidator	createValidator(ValidatorConfig config, ValidationProfile profile)
PDFAFlavour	defaultFlavour()

Methods inherited from interface org.verapdf.component.Component

getDetails

Methods inherited from interface java.io.Closeable

close

Method Detail

createParser

PDFAParser createParser(InputStream pdfStream)
                        throws ModelParsingException,
                               EncryptedPdfException

Method that returns a PDFParser instance, parsing the passed pdfStream parameter. The parser or parser provider will detect the flavour of the PDF document stream and provide an appropriate parser.

Parameters:

pdfStream - InputStream for the PDF document to be parsed.

Returns:

a PDFParser instance created from the supplied InputStream.

Throws:

ModelParsingException - when there's a problem parsing the PDF file

EncryptedPdfException - if the PDF to be parsed is encrypted

createParser

PDFAParser createParser(InputStream pdfStream,
                      PDFAFlavour flavour)
                        throws ModelParsingException,
                               EncryptedPdfException

Method that returns a PDFParser instance, parsing the passed pdfStream parameter. The caller must explicitly state the flavour of the PDF document stream.

Parameters:

pdfStream - InputStream for the PDF document to be parsed.

flavour - a PDFAFlavour instance indicating parser configuration (PDF/A part and conformance level) to be assumed when parsing the document.

Returns:

a PDFParser instance created from the supplied InputStream.

Throws:

ModelParsingException - when there's a problem parsing the PDF file

EncryptedPdfException - if the PDF to be parsed is encrypted

createValidator

PDFAValidator createValidator(ValidatorConfig config)

createValidator

PDFAValidator createValidator(ValidatorConfig config,
                            ValidationProfile profile)

createValidator

PDFAValidator createValidator(ValidatorConfig config,
                            PDFAFlavour flavour)

createValidator

PDFAValidator createValidator(PDFAFlavour flavour,
                            boolean logSuccess)

createValidator

PDFAValidator createValidator(ValidationProfile profile,
                            boolean logSuccess)

createFailFastValidator

PDFAValidator createFailFastValidator(PDFAFlavour flavour,
                                    int maxFailures)

createFailFastValidator

PDFAValidator createFailFastValidator(ValidationProfile profile,
                                    int maxFailures)

createMetadataFixer

MetadataFixer createMetadataFixer()

defaultFlavour

PDFAFlavour defaultFlavour()