org.verapdf.pdfa.validation.profiles

Interface ProfileDirectory

public interface ProfileDirectory

A ProfileDirectory provides access to a set of ValidationProfiles that can be retrieved by String id or PDFAFlavour.

This interface provides a simple directory of ValidationProfiles that is intentionally restricted by the enum type PDFAFlavour.

Author:

Carl Wilson

Method Summary

Modifier and Type	Method and Description
Set<PDFAFlavour>	getPDFAFlavours()
ValidationProfile	getValidationProfileByFlavour(PDFAFlavour flavour)
ValidationProfile	getValidationProfileById(String profileID)
Set<String>	getValidationProfileIds()
Set<ValidationProfile>	getValidationProfiles()

Method Detail

getValidationProfileIds

Set<String> getValidationProfileIds()

Returns:

the Set of ValidationProfile String identifiers for the profiles held in the directory.

getPDFAFlavours

Set<PDFAFlavour> getPDFAFlavours()

Returns:

the Set of PDFAFlavour enum instances that identify the profiles held in the directory.

getValidationProfileById

ValidationProfile getValidationProfileById(String profileID)

Parameters:

profileID - a two character String that uniquely identifies a particular PDFAFlavour, e.g. 1a, 1b, 2a, etc.

Returns:

the ValidationProfile associated with the profileId

Throws:

NoSuchElementException - when there is no profile associated with the profileID string IllegalArgumentException if the profileID parameter is null

IllegalArgumentException - if profileID is null

getValidationProfileByFlavour

ValidationProfile getValidationProfileByFlavour(PDFAFlavour flavour)

Parameters:

flavour - a PDFAFlavour instance that identifies a ValidationProfile

Returns:

the ValidationProfile associated with the flavour

Throws:

NoSuchElementException - when there is no profile associated with the flavour IllegalArgumentException if the flavour parameter is null

IllegalArgumentException - if flavour is null

getValidationProfiles

Set<ValidationProfile> getValidationProfiles()

Returns:

the full set of ValidationProfiles held in the directory.