org.apache.pdfbox.preflight.process

Class BookmarkValidationProcess

java.lang.Object

org.apache.pdfbox.preflight.process.AbstractProcess

org.apache.pdfbox.preflight.process.BookmarkValidationProcess

All Implemented Interfaces:

ValidationProcess

public class BookmarkValidationProcess
extends AbstractProcess

Constructor Summary

Constructors

Constructor and Description
BookmarkValidationProcess()

Method Summary

Modifier and Type	Method and Description
protected boolean	exploreOutlineLevel(PreflightContext ctx, PDOutlineItem inputItem) This method explores the Outline Item Level and call a validation method on each Outline Item.
void	validate(PreflightContext ctx)
protected boolean	validateItem(PreflightContext ctx, PDOutlineItem inputItem) This method checks the inputItem dictionary and call the exploreOutlineLevel method on the first child if it is not null.

Methods inherited from class org.apache.pdfbox.preflight.process.AbstractProcess

addValidationError, addValidationErrors

Methods inherited from class java.lang.Object

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

Constructor Detail

BookmarkValidationProcess

public BookmarkValidationProcess()

Method Detail

validate

public void validate(PreflightContext ctx)
              throws ValidationException

Throws:

ValidationException

exploreOutlineLevel

protected boolean exploreOutlineLevel(PreflightContext ctx,
                                      PDOutlineItem inputItem)
                               throws ValidationException

This method explores the Outline Item Level and call a validation method on each Outline Item. If an invalid outline item is found, the result list is updated.

Parameters:

inputItem - The first outline item of the level

ctx - The document handler which provides useful data for the level exploration (ex : access to the PDDocument)

Returns:

true if all items are valid in this level.

Throws:

ValidationException

validateItem

protected boolean validateItem(PreflightContext ctx,
                               PDOutlineItem inputItem)
                        throws ValidationException

This method checks the inputItem dictionary and call the exploreOutlineLevel method on the first child if it is not null.

Parameters:

inputItem - outline item to validate

ctx - The document handler which provides useful data for the level exploration (ex : access to the PDDocument)

result -

Returns:

Throws:

ValidationException