PdfA1Checker (iText 7 7.2.4 API)

java.lang.Object
- com.itextpdf.pdfa.checker.PdfAChecker
- - com.itextpdf.pdfa.checker.PdfA1Checker

Direct Known Subclasses:

PdfA2Checker
```
public class PdfA1Checker
extends PdfAChecker
```
PdfA1Checker defines the requirements of the PDF/A-1 standard and contains method implementations from the abstract PdfAChecker class.
The specification implemented by this class is ISO 19005-1

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Set<PdfName>`	`allowedNamedActions`
`protected static Set<PdfName>`	`allowedRenderingIntents`
`protected static Set<PdfName>`	`contentAnnotations`
`protected static Set<PdfName>`	`forbiddenActions`
`protected static Set<PdfName>`	`forbiddenAnnotations`

Fields inherited from class com.itextpdf.pdfa.checker.PdfAChecker
checkedObjects, checkedObjectsColorspace, cmykIsUsed, conformanceLevel, grayIsUsed, gsStackDepth, ICC_COLOR_SPACE_CMYK, ICC_COLOR_SPACE_GRAY, ICC_COLOR_SPACE_RGB, ICC_DEVICE_CLASS_MONITOR_PROFILE, ICC_DEVICE_CLASS_OUTPUT_PROFILE, maxGsStackDepth, pdfAOutputIntentColorSpace, rgbIsUsed

Constructor Summary

Constructors
Constructor and Description
`PdfA1Checker(PdfAConformanceLevel conformanceLevel)` Creates a PdfA1Checker with the required conformance level

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkAction(PdfDictionary action)` Checks if the action is allowed.
`protected void`	`checkAnnotation(PdfDictionary annotDic)` Verify the conformity of the annotation dictionary.
`void`	`checkCanvasStack(char stackOperation)` This method checks compliance with the graphics state architectural limitation, explained by `PdfAChecker.maxGsStackDepth`.
`protected void`	`checkCatalogValidEntries(PdfDictionary catalogDict)` Checks if entries in catalog dictionary are valid.
`void`	`checkColor(Color color, PdfDictionary currentColorSpaces, Boolean fill, PdfStream stream)` This method checks compliance with the color restrictions imposed by the available color spaces in the document.
`void`	`checkColorSpace(PdfColorSpace colorSpace, PdfDictionary currentColorSpaces, boolean checkAlternate, Boolean fill)` This method performs a range of checks on the given color space, depending on the type and properties of that color space.
`protected void`	`checkColorsUsages()` Verify the conformity of used color spaces.
`protected void`	`checkContentStream(PdfStream contentStream)` Attest content stream conformance with appropriate specification.
`protected void`	`checkContentStreamObject(PdfObject object)` Verify the conformity of the operand of content stream with appropriate specification.
`void`	`checkExtGState(CanvasGraphicsState extGState, PdfStream contentStream)` Performs a number of checks on the graphics state, among others ISO 19005-1 section 6.2.8 and 6.4 and ISO 19005-2 section 6.2.5 and 6.2.10.
`protected void`	`checkFileSpec(PdfDictionary fileSpec)` Verify the conformity of the file specification dictionary.
`void`	`checkFont(PdfFont pdfFont)` Performs a number of checks on the font.
`void`	`checkFontGlyphs(PdfFont font, PdfStream contentStream)` Performs a check of the each font glyph as a Form XObject.
`protected void`	`checkForm(PdfDictionary form)` Verify the conformity of the form dictionary.
`protected void`	`checkFormXObject(PdfStream form)` Verify the conformity of the form XObject dictionary.
`protected void`	`checkImage(PdfStream image, PdfDictionary currentColorSpaces)` Verify the conformity of the given image.
`void`	`checkInlineImage(PdfStream inlineImage, PdfDictionary currentColorSpaces)` This method checks compliance with the inline image restrictions in the PDF/A specs, specifically filter parameters.
`protected void`	`checkLogicalStructure(PdfDictionary catalog)` Performs a number of checks on the logical structure of the document.
`protected void`	`checkMetaData(PdfDictionary catalog)` Performs a number of checks on the metadata of the document.
`protected void`	`checkNonSymbolicTrueTypeFont(PdfTrueTypeFont trueTypeFont)` Verify the conformity of the non-symbolic TrueType font.
`protected void`	`checkOutputIntents(PdfDictionary catalog)` Verify the conformity of the output intents array in the catalog dictionary.
`protected void`	`checkPageObject(PdfDictionary pageDict, PdfDictionary pageResources)` Verify the conformity of the page dictionary.
`protected void`	`checkPageSize(PdfDictionary page)` Checks the allowable size of the page.
`protected void`	`checkPageTransparency(PdfDictionary pageDict, PdfDictionary pageResources)` Verify the conformity of the page transparency.
`protected void`	`checkPdfArray(PdfArray array)` Verify the conformity of the PDF array.
`protected void`	`checkPdfDictionary(PdfDictionary dictionary)` Verify the conformity of the PDF dictionary.
`protected void`	`checkPdfName(PdfName name)` Verify the conformity of the PDF name.
`protected void`	`checkPdfNumber(PdfNumber number)` Verify the conformity of the PDF number.
`protected void`	`checkPdfStream(PdfStream stream)` Verify the conformity of the PDF stream.
`protected void`	`checkPdfString(PdfString string)` Verify the conformity of the PDF string.
`void`	`checkRenderingIntent(PdfName intent)` Checks whether the rendering intent of the document is within the allowed range of intents.
`protected void`	`checkSymbolicTrueTypeFont(PdfTrueTypeFont trueTypeFont)` Verify the conformity of the symbolic TrueType font.
`protected void`	`checkTrailer(PdfDictionary trailer)` Verify the conformity of the trailer dictionary.
`void`	`checkXrefTable(PdfXrefTable xrefTable)` Verify the conformity of the cross-reference table.
`protected Set<PdfName>`	`getAllowedNamedActions()` Retrieve allowed actions in conforming document.
`protected Set<PdfName>`	`getForbiddenActions()` Retrieve forbidden actions in conforming document.
`protected PdfArray`	`getFormFields(PdfArray array)` Gets a `PdfArray` of fields with kids from a `PdfArray` of `PdfDictionary` objects.
`protected long`	`getMaxIntegerValue()` Retrieve maximal allowed integer value.
`protected int`	`getMaxNameLength()` Retrieve maximum allowed length of the name object.
`protected long`	`getMaxNumberOfIndirectObjects()` Retrieve maximum allowed number of indirect objects in conforming document.
`protected double`	`getMaxRealValue()` Retrieve maximum allowed real value.
`protected int`	`getMaxStringLength()` Returns maximum allowed bytes length of the string in a PDF document.
`protected long`	`getMinIntegerValue()` Retrieve minimal allowed integer value.

Methods inherited from class com.itextpdf.pdfa.checker.PdfAChecker
checkAppearanceStream, checkDocument, checkFlag, checkPdfObject, checkResources, checkResourcesOfAppearanceStreams, checkSignature, checkSinglePage, checkStructure, checkTagStructureElement, getConformanceLevel, isAlreadyChecked, isContainsTransparencyGroup, isFullCheckMode, objectIsChecked, setFullCheckMode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - forbiddenAnnotations
```
protected static final Set<PdfName> forbiddenAnnotations
```
  - contentAnnotations
```
protected static final Set<PdfName> contentAnnotations
```
  - forbiddenActions
```
protected static final Set<PdfName> forbiddenActions
```
  - allowedNamedActions
```
protected static final Set<PdfName> allowedNamedActions
```
  - allowedRenderingIntents
```
protected static final Set<PdfName> allowedRenderingIntents
```
- Constructor Detail
  - PdfA1Checker
```
public PdfA1Checker(PdfAConformanceLevel conformanceLevel)
```
    Creates a PdfA1Checker with the required conformance level
    
    Parameters:
    
    conformanceLevel - the required conformance level, a or b
- Method Detail
  - checkCanvasStack
```
public void checkCanvasStack(char stackOperation)
```
    Description copied from class: PdfAChecker
    
    This method checks compliance with the graphics state architectural limitation, explained by PdfAChecker.maxGsStackDepth.
    
    Specified by:
    
    checkCanvasStack in class PdfAChecker
    
    Parameters:
    
    stackOperation - the operation to check the graphics state counter for
  - checkInlineImage
```
public void checkInlineImage(PdfStream inlineImage,
                             PdfDictionary currentColorSpaces)
```
    Description copied from class: PdfAChecker
    
    This method checks compliance with the inline image restrictions in the PDF/A specs, specifically filter parameters.
    
    Specified by:
    
    checkInlineImage in class PdfAChecker
    
    Parameters:
    
    inlineImage - a PdfStream containing the inline image
    
    currentColorSpaces - a PdfDictionary containing the color spaces used in the document
  - checkColor
```
public void checkColor(Color color,
                       PdfDictionary currentColorSpaces,
                       Boolean fill,
                       PdfStream stream)
```
    Description copied from class: PdfAChecker
    
    This method checks compliance with the color restrictions imposed by the available color spaces in the document. This method will be abstract in update 7.2
    
    Specified by:
    
    checkColor in class PdfAChecker
    
    Parameters:
    
    color - the color to check
    
    currentColorSpaces - a PdfDictionary containing the color spaces used in the document
    
    fill - whether the color is used for fill or stroke operations
    
    stream - current content stream
  - checkColorSpace
```
public void checkColorSpace(PdfColorSpace colorSpace,
                            PdfDictionary currentColorSpaces,
                            boolean checkAlternate,
                            Boolean fill)
```
    Description copied from class: PdfAChecker
    
    This method performs a range of checks on the given color space, depending on the type and properties of that color space.
    
    Specified by:
    
    checkColorSpace in class PdfAChecker
    
    Parameters:
    
    colorSpace - the color space to check
    
    currentColorSpaces - a PdfDictionary containing the color spaces used in the document
    
    checkAlternate - whether or not to also check the parent color space
    
    fill - whether the color space is used for fill or stroke operations
  - checkXrefTable
```
public void checkXrefTable(PdfXrefTable xrefTable)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the cross-reference table.
    
    Specified by:
    
    checkXrefTable in class PdfAChecker
    
    Parameters:
    
    xrefTable - is the Xref table
  - getForbiddenActions
```
protected Set<PdfName> getForbiddenActions()
```
    Description copied from class: PdfAChecker
    
    Retrieve forbidden actions in conforming document.
    
    Specified by:
    
    getForbiddenActions in class PdfAChecker
    
    Returns:
    
    set of PdfName with forbidden actions
  - getAllowedNamedActions
```
protected Set<PdfName> getAllowedNamedActions()
```
    Description copied from class: PdfAChecker
    
    Retrieve allowed actions in conforming document.
    
    Specified by:
    
    getAllowedNamedActions in class PdfAChecker
    
    Returns:
    
    set of PdfName with allowed named actions
  - getMaxNumberOfIndirectObjects
```
protected long getMaxNumberOfIndirectObjects()
```
    Description copied from class: PdfAChecker
    
    Retrieve maximum allowed number of indirect objects in conforming document.
    
    Specified by:
    
    getMaxNumberOfIndirectObjects in class PdfAChecker
    
    Returns:
    
    maximum allowed number of indirect objects
  - checkColorsUsages
```
protected void checkColorsUsages()
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of used color spaces.
    
    Specified by:
    
    checkColorsUsages in class PdfAChecker
  - checkExtGState
```
public void checkExtGState(CanvasGraphicsState extGState,
                           PdfStream contentStream)
```
    Description copied from class: PdfAChecker
    
    Performs a number of checks on the graphics state, among others ISO 19005-1 section 6.2.8 and 6.4 and ISO 19005-2 section 6.2.5 and 6.2.10. This method will be abstract in the update 7.2
    
    Specified by:
    
    checkExtGState in class PdfAChecker
    
    Parameters:
    
    extGState - the graphics state to be checked
    
    contentStream - current content stream
  - checkFontGlyphs
```
public void checkFontGlyphs(PdfFont font,
                            PdfStream contentStream)
```
    Description copied from class: PdfAChecker
    
    Performs a check of the each font glyph as a Form XObject. See ISO 19005-2 Annex A.5. This only applies to type 3 fonts. This method will be abstract in update 7.2
    
    Specified by:
    
    checkFontGlyphs in class PdfAChecker
    
    Parameters:
    
    font - PdfFont to be checked
    
    contentStream - stream containing checked font
  - checkRenderingIntent
```
public void checkRenderingIntent(PdfName intent)
```
    Description copied from class: PdfAChecker
    
    Checks whether the rendering intent of the document is within the allowed range of intents. This is defined in ISO 19005-1 section 6.2.9, and unchanged in newer generations of the PDF/A specification.
    
    Specified by:
    
    checkRenderingIntent in class PdfAChecker
    
    Parameters:
    
    intent - the intent to be analyzed
  - checkFont
```
public void checkFont(PdfFont pdfFont)
```
    Description copied from class: PdfAChecker
    
    Performs a number of checks on the font. See ISO 19005-1 section 6.3, ISO 19005-2 and ISO 19005-3 section 6.2.11. Be aware that not all constraints defined in the ISO are checked in this method, for most of them we consider that iText always creates valid fonts.
    
    Specified by:
    
    checkFont in class PdfAChecker
    
    Parameters:
    
    pdfFont - font to be checked
  - checkPageTransparency
```
protected void checkPageTransparency(PdfDictionary pageDict,
                                     PdfDictionary pageResources)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the page transparency.
    
    Specified by:
    
    checkPageTransparency in class PdfAChecker
    
    Parameters:
    
    pageDict - the PdfDictionary contains contents for transparency to be checked
    
    pageResources - the PdfDictionary contains resources for transparency to be checked
  - checkContentStream
```
protected void checkContentStream(PdfStream contentStream)
```
    Description copied from class: PdfAChecker
    
    Attest content stream conformance with appropriate specification. Throws PdfAConformanceException if any discrepancy was found
    
    Specified by:
    
    checkContentStream in class PdfAChecker
    
    Parameters:
    
    contentStream - is a content stream to validate
  - checkContentStreamObject
```
protected void checkContentStreamObject(PdfObject object)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the operand of content stream with appropriate specification. Throws PdfAConformanceException if any discrepancy was found
    
    Specified by:
    
    checkContentStreamObject in class PdfAChecker
    
    Parameters:
    
    object - is an operand of content stream to validate
  - checkNonSymbolicTrueTypeFont
```
protected void checkNonSymbolicTrueTypeFont(PdfTrueTypeFont trueTypeFont)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the non-symbolic TrueType font.
    
    Specified by:
    
    checkNonSymbolicTrueTypeFont in class PdfAChecker
    
    Parameters:
    
    trueTypeFont - the PdfTrueTypeFont to check
  - checkSymbolicTrueTypeFont
```
protected void checkSymbolicTrueTypeFont(PdfTrueTypeFont trueTypeFont)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the symbolic TrueType font.
    
    Specified by:
    
    checkSymbolicTrueTypeFont in class PdfAChecker
    
    Parameters:
    
    trueTypeFont - the PdfTrueTypeFont to check
  - checkImage
```
protected void checkImage(PdfStream image,
                          PdfDictionary currentColorSpaces)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the given image.
    
    Specified by:
    
    checkImage in class PdfAChecker
    
    Parameters:
    
    image - the image to check
    
    currentColorSpaces - the PdfDictionary containing the color spaces used in the document
  - checkFormXObject
```
protected void checkFormXObject(PdfStream form)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the form XObject dictionary.
    
    Specified by:
    
    checkFormXObject in class PdfAChecker
    
    Parameters:
    
    form - the PdfStream to check
  - checkLogicalStructure
```
protected void checkLogicalStructure(PdfDictionary catalog)
```
    Description copied from class: PdfAChecker
    
    Performs a number of checks on the logical structure of the document.
    
    Specified by:
    
    checkLogicalStructure in class PdfAChecker
    
    Parameters:
    
    catalog - the catalog PdfDictionary to check
  - checkMetaData
```
protected void checkMetaData(PdfDictionary catalog)
```
    Description copied from class: PdfAChecker
    
    Performs a number of checks on the metadata of the document.
    
    Specified by:
    
    checkMetaData in class PdfAChecker
    
    Parameters:
    
    catalog - the catalog PdfDictionary to check
  - checkOutputIntents
```
protected void checkOutputIntents(PdfDictionary catalog)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the output intents array in the catalog dictionary.
    
    Specified by:
    
    checkOutputIntents in class PdfAChecker
    
    Parameters:
    
    catalog - the PdfDictionary to check
  - checkPdfNumber
```
protected void checkPdfNumber(PdfNumber number)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the PDF number.
    
    Specified by:
    
    checkPdfNumber in class PdfAChecker
    
    Parameters:
    
    number - the PdfNumber to check
  - getMaxRealValue
```
protected double getMaxRealValue()
```
    Retrieve maximum allowed real value.
    
    Returns:
    
    maximum allowed real number
  - getMaxIntegerValue
```
protected long getMaxIntegerValue()
```
    Retrieve maximal allowed integer value.
    
    Returns:
    
    maximal allowed integer number
  - getMinIntegerValue
```
protected long getMinIntegerValue()
```
    Retrieve minimal allowed integer value.
    
    Returns:
    
    minimal allowed integer number
  - checkPdfArray
```
protected void checkPdfArray(PdfArray array)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the PDF array.
    
    Specified by:
    
    checkPdfArray in class PdfAChecker
    
    Parameters:
    
    array - the PdfArray to check
  - checkPdfDictionary
```
protected void checkPdfDictionary(PdfDictionary dictionary)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the PDF dictionary.
    
    Specified by:
    
    checkPdfDictionary in class PdfAChecker
    
    Parameters:
    
    dictionary - the PdfDictionary to check
  - checkPdfStream
```
protected void checkPdfStream(PdfStream stream)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the PDF stream.
    
    Specified by:
    
    checkPdfStream in class PdfAChecker
    
    Parameters:
    
    stream - the PdfStream to check
  - checkPdfName
```
protected void checkPdfName(PdfName name)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the PDF name.
    
    Specified by:
    
    checkPdfName in class PdfAChecker
    
    Parameters:
    
    name - the PdfName to check
  - getMaxNameLength
```
protected int getMaxNameLength()
```
    Retrieve maximum allowed length of the name object.
    
    Returns:
    
    maximum allowed length of the name
  - checkPdfString
```
protected void checkPdfString(PdfString string)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the PDF string.
    
    Specified by:
    
    checkPdfString in class PdfAChecker
    
    Parameters:
    
    string - the PdfString to check
  - getMaxStringLength
```
protected int getMaxStringLength()
```
    Returns maximum allowed bytes length of the string in a PDF document.
    
    Returns:
    
    maximum string length
  - checkPageSize
```
protected void checkPageSize(PdfDictionary page)
```
    Description copied from class: PdfAChecker
    
    Checks the allowable size of the page.
    
    Specified by:
    
    checkPageSize in class PdfAChecker
    
    Parameters:
    
    page - the PdfDictionary of page which size being checked
  - checkFileSpec
```
protected void checkFileSpec(PdfDictionary fileSpec)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the file specification dictionary.
    
    Specified by:
    
    checkFileSpec in class PdfAChecker
    
    Parameters:
    
    fileSpec - the PdfDictionary containing file specification to be checked
  - checkAnnotation
```
protected void checkAnnotation(PdfDictionary annotDic)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the annotation dictionary.
    
    Specified by:
    
    checkAnnotation in class PdfAChecker
    
    Parameters:
    
    annotDic - the annotation PdfDictionary to be checked
  - checkForm
```
protected void checkForm(PdfDictionary form)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the form dictionary.
    
    Specified by:
    
    checkForm in class PdfAChecker
    
    Parameters:
    
    form - the form PdfDictionary to be checked
  - checkAction
```
protected void checkAction(PdfDictionary action)
```
    Description copied from class: PdfAChecker
    
    Checks if the action is allowed.
    
    Specified by:
    
    checkAction in class PdfAChecker
    
    Parameters:
    
    action - to be checked
  - checkCatalogValidEntries
```
protected void checkCatalogValidEntries(PdfDictionary catalogDict)
```
    Description copied from class: PdfAChecker
    
    Checks if entries in catalog dictionary are valid.
    
    Specified by:
    
    checkCatalogValidEntries in class PdfAChecker
    
    Parameters:
    
    catalogDict - the catalog PdfDictionary to be checked
  - checkPageObject
```
protected void checkPageObject(PdfDictionary pageDict,
                               PdfDictionary pageResources)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the page dictionary.
    
    Specified by:
    
    checkPageObject in class PdfAChecker
    
    Parameters:
    
    pageDict - the PdfDictionary to check
    
    pageResources - the page's resources dictionary
  - checkTrailer
```
protected void checkTrailer(PdfDictionary trailer)
```
    Description copied from class: PdfAChecker
    
    Verify the conformity of the trailer dictionary.
    
    Specified by:
    
    checkTrailer in class PdfAChecker
    
    Parameters:
    
    trailer - the PdfDictionary of trailer to check
  - getFormFields
```
protected PdfArray getFormFields(PdfArray array)
```
    Gets a PdfArray of fields with kids from a PdfArray of PdfDictionary objects.
    
    Parameters:
    
    array - the PdfArray of form fields PdfDictionary objects
    
    Returns:
    
    the PdfArray of form fields

Class PdfA1Checker

Field Summary

Fields inherited from class com.itextpdf.pdfa.checker.PdfAChecker

Constructor Summary

Method Summary

Methods inherited from class com.itextpdf.pdfa.checker.PdfAChecker

Methods inherited from class java.lang.Object

Field Detail

forbiddenAnnotations

contentAnnotations

forbiddenActions

allowedNamedActions

allowedRenderingIntents

Constructor Detail

PdfA1Checker

Method Detail

checkCanvasStack

checkInlineImage

checkColor

checkColorSpace

checkXrefTable

getForbiddenActions

getAllowedNamedActions

getMaxNumberOfIndirectObjects

checkColorsUsages

checkExtGState

checkFontGlyphs

checkRenderingIntent

checkFont

checkPageTransparency

checkContentStream

checkContentStreamObject

checkNonSymbolicTrueTypeFont

checkSymbolicTrueTypeFont

checkImage

checkFormXObject

checkLogicalStructure

checkMetaData

checkOutputIntents

checkPdfNumber

getMaxRealValue

getMaxIntegerValue

getMinIntegerValue

checkPdfArray

checkPdfDictionary

checkPdfStream

checkPdfName

getMaxNameLength

checkPdfString

getMaxStringLength

checkPageSize

checkFileSpec

checkAnnotation

checkForm

checkAction

checkCatalogValidEntries

checkPageObject

checkTrailer

getFormFields