Package org.verapdf.pdfa

Class AbstractFoundry

java.lang.Object

org.verapdf.pdfa.AbstractFoundry

All Implemented Interfaces:

Closeable, AutoCloseable, Component, VeraPDFFoundry

public abstract class AbstractFoundry
extends Object
implements VeraPDFFoundry

Version:

0.1 Created 26 Oct 2016:21:25:17

Author:

Carl Wilson carlwilson AT github

Constructor Summary

Constructors

Constructor	Description
AbstractFoundry()

Method Summary

Modifier and Type	Method	Description
void	close()
PDFAValidator	createFailFastValidator(PDFAFlavour flavour, int maxFailures)	Creates a new PDFAValidator initialised with the passed profile, requested fast failing behaviour and configured NOT to log passed checks.
PDFAValidator	createFailFastValidator(ValidationProfile profile, int maxFailures)	Creates a new PDFAValidator initialised with the passed profile, requested fast failing behaviour and configured NOT to log passed checks.
PDFAValidator	createValidator(PDFAFlavour flavour, boolean logSuccess)	Creates a new PDFAValidator instance that uses one of the ValidationProfiles packaged as a core library resource.
PDFAValidator	createValidator(PDFAFlavour flavour, int maxNumberOfDisplayedFailedChecks, boolean logSuccess, boolean showErrorMessages)
PDFAValidator	createValidator(ValidationProfile profile, boolean logSuccess)	Creates a new PDFAValidator initialised with the passed profile and chosen passed test logging.
PDFAValidator	createValidator(ValidationProfile profile, int maxNumberOfDisplayedFailedChecks, boolean logSuccess, boolean showErrorMessages)
PDFAValidator	createValidator(ValidatorConfig config)	Obtain a new PDFAValidator instance.
PDFAValidator	createValidator(ValidatorConfig config, PDFAFlavour flavour)	Obtain a new PDFAValidator instance that uses a custom PDFAFlavour.
PDFAValidator	createValidator(ValidatorConfig config, ValidationProfile profile)	Obtain a new PDFAValidator instance that uses a custom ValidationProfile instance.
PDFAFlavour	defaultFlavour()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.verapdf.component.Component

getDetails

Methods inherited from interface org.verapdf.pdfa.VeraPDFFoundry

createMetadataFixer, createParser, createParser, createParser, createParser, createParser, getParserId

Constructor Detail

AbstractFoundry

public AbstractFoundry()

Method Detail

createValidator

public PDFAValidator createValidator(ValidatorConfig config)

Description copied from interface: VeraPDFFoundry

Obtain a new PDFAValidator instance.

Specified by:

createValidator in interface VeraPDFFoundry

Parameters:

config - a ValidatorConfig instance used to configure the PDFAValidator

Returns:

an appropriately configured PDFAValidator instance.

createValidator

public PDFAValidator createValidator(ValidatorConfig config,
                                     PDFAFlavour flavour)

Description copied from interface: VeraPDFFoundry

Obtain a new PDFAValidator instance that uses a custom PDFAFlavour.

Specified by:

createValidator in interface VeraPDFFoundry

Parameters:

config - a ValidatorConfig instance used to configure the PDFAValidator

flavour - the particular PDFAFlavour to validated against.

Returns:

an appropriately configured PDFAValidator instance.

createValidator

public PDFAValidator createValidator(ValidatorConfig config,
                                     ValidationProfile profile)

Description copied from interface: VeraPDFFoundry

Obtain a new PDFAValidator instance that uses a custom ValidationProfile instance.

Specified by:

createValidator in interface VeraPDFFoundry

Parameters:

config - a ValidatorConfig instance used to configure the PDFAValidator

Returns:

an appropriately configured PDFAValidator instance.

createValidator

public PDFAValidator createValidator(PDFAFlavour flavour,
                                     boolean logSuccess)

Description copied from interface: VeraPDFFoundry

Creates a new PDFAValidator instance that uses one of the ValidationProfiles packaged as a core library resource. While these profiles are not guaranteed to be up to date, they are available when offline. A ProfileDirectory populated with the pre-loaded profiles can be obtained by calling Profiles#getVeraProfileDirectory().

Specified by:

createValidator in interface VeraPDFFoundry

Parameters:

flavour - the PDFAFlavour that's associated with the ValidationProfile to used to initialise the PDFAValidator.

logSuccess - boolean used to configure logging of passed tests by the PDFAValidator. Pass true to log passed tests, false to only log tests that don't pass.

Returns:

a PDFAValidator instance initialised from the passed parameters

createValidator

public PDFAValidator createValidator(ValidationProfile profile,
                                     boolean logSuccess)

Description copied from interface: VeraPDFFoundry

Creates a new PDFAValidator initialised with the passed profile and chosen passed test logging.

Specified by:

createValidator in interface VeraPDFFoundry

Parameters:

profile - the ValidationProfile to be enforced by the returned PDFAValidator.

logSuccess - boolean used to configure logging of passed tests by the PDFAValidator. Pass true to log passed tests, false to only log tests that don't pass.

Returns:

a PDFAValidator instance initialised from the passed parameters

createValidator

public PDFAValidator createValidator(PDFAFlavour flavour,
                                     int maxNumberOfDisplayedFailedChecks,
                                     boolean logSuccess,
                                     boolean showErrorMessages)

Specified by:

createValidator in interface VeraPDFFoundry

createValidator

public PDFAValidator createValidator(ValidationProfile profile,
                                     int maxNumberOfDisplayedFailedChecks,
                                     boolean logSuccess,
                                     boolean showErrorMessages)

Specified by:

createValidator in interface VeraPDFFoundry

createFailFastValidator

public PDFAValidator createFailFastValidator(PDFAFlavour flavour,
                                             int maxFailures)

Description copied from interface: VeraPDFFoundry

Creates a new PDFAValidator initialised with the passed profile, requested fast failing behaviour and configured NOT to log passed checks.

Specified by:

createFailFastValidator in interface VeraPDFFoundry

Parameters:

flavour - the PDFAFlavour that's associated with the ValidationProfile to used to initialise the PDFAValidator.

maxFailures - an int value that configures the PDFAValidator to abort validation after maxFailures failed tests. If maxFailures is less than 1 then the PDFAValidator will complete the full validation process.

Returns:

a PDFAValidator instance initialised from the passed parameters

createFailFastValidator

public PDFAValidator createFailFastValidator(ValidationProfile profile,
                                             int maxFailures)

Description copied from interface: VeraPDFFoundry

Creates a new PDFAValidator initialised with the passed profile, requested fast failing behaviour and configured NOT to log passed checks.

Specified by:

createFailFastValidator in interface VeraPDFFoundry

Parameters:

profile - the ValidationProfile to be enforced by the returned PDFAValidator.

maxFailures - an int value that configures the PDFAValidator to abort validation after maxFailures failed tests. If maxFailures is less than 1 then the PDFAValidator will complete the full validation process.

Returns:

a PDFAValidator instance initialised from the passed parameters

defaultFlavour

public PDFAFlavour defaultFlavour()

Specified by:

defaultFlavour in interface VeraPDFFoundry

Returns:

the default PDFAFlavour set for this VeraPDFFoundry

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable