org.verapdf.processor

Interface BatchProcessor

All Superinterfaces:

AutoCloseable, Closeable, Component, Processor

All Known Implementing Classes:

AbstractBatchProcessor, BatchFileProcessor

public interface BatchProcessor
extends Processor

The veraPDF batch processor, used to process multiple files.

Version:

0.1 Created 8 Nov 2016:22:55:35

Author:

Carl Wilson carlwilson AT github

Method Summary

Modifier and Type	Method and Description
BatchSummary	process(File toProcess, boolean recurse, BatchProcessingHandler resutlHandler) Process all .pdf files in a directory, optionally recursively.
BatchSummary	process(List<? extends File> toProcess, BatchProcessingHandler resutlHandler) Process a list of PDF files

Methods inherited from interface org.verapdf.processor.Processor

getConfig, getDependencies

Methods inherited from interface org.verapdf.component.Component

getDetails

Methods inherited from interface java.io.Closeable

close

Method Detail

process

BatchSummary process(List<? extends File> toProcess,
                     BatchProcessingHandler resutlHandler)
              throws VeraPDFException

Process a list of PDF files

Parameters:

toProcess - a List of Files to process

resutlHandler - the BatchProcessingHandler that will be used to process the results

Returns:

a BatchSummary that reports the details of the batch process

Throws:

VeraPDFException - when an error occurs during processing.

process

BatchSummary process(File toProcess,
                     boolean recurse,
                     BatchProcessingHandler resutlHandler)
              throws VeraPDFException

Process all .pdf files in a directory, optionally recursively.

Parameters:

toProcess - a File that denotes a directory to process

recurse - set true to recurse into sub-directories, false if recursion not required.

resutlHandler - the BatchProcessingHandler that will be used to process the results

Returns:

a BatchSummary that reports the details of the batch process

Throws:

VeraPDFException - when an error occurs during processing.