org.verapdf.processor

Class AbstractBatchProcessor

java.lang.Object

org.verapdf.processor.AbstractBatchProcessor

All Implemented Interfaces:

Closeable, AutoCloseable, Component, BatchProcessor, Processor

Direct Known Subclasses:

BatchFileProcessor

public abstract class AbstractBatchProcessor
extends Object
implements BatchProcessor

Version:

0.1 Created 8 Nov 2016:22:58:09

Author:

Carl Wilson carlwilson AT github

Field Summary

Fields

Modifier and Type	Field and Description
protected ItemProcessor	processor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBatchProcessor(ItemProcessor processor)

Method Summary

Modifier and Type	Method and Description
void	close()
ProcessorConfig	getConfig()
Collection<ReleaseDetails>	getDependencies()
ComponentDetails	getDetails()
BatchSummary	process(File toProcess, boolean recurse, BatchProcessingHandler resultHandler) Process all .pdf files in a directory, optionally recursively.
BatchSummary	process(List<? extends File> toProcess, BatchProcessingHandler resultHandler) Process a list of PDF files
protected abstract void	processContainer(File container, boolean recurse)
protected abstract void	processList(List<? extends File> toProcess)
protected void	processResult(ProcessorResult result)

Methods inherited from class java.lang.Object

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

Field Detail

processor

protected final ItemProcessor processor

Constructor Detail

AbstractBatchProcessor

protected AbstractBatchProcessor(ItemProcessor processor)

See Also:

org.verapdf.processor.BatchProcessor#process(java.io.File, boolean, org.verapdf.processor.ProcessorResultHandler)

Method Detail

getConfig

public ProcessorConfig getConfig()

Specified by:

getConfig in interface Processor

Returns:

the ProcessorConfig that holds the details for the configuration of this Processor

See Also:

Processor.getConfig()

getDependencies

public Collection<ReleaseDetails> getDependencies()

Specified by:

getDependencies in interface Processor

Returns:

a Collection of ReleaseDetails for the Processor's dependencies, for auditing.

See Also:

Processor.getDependencies()

getDetails

public ComponentDetails getDetails()

Specified by:

getDetails in interface Component

See Also:

Component.getDetails()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

See Also:

Closeable.close()

process

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

Description copied from interface: BatchProcessor

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

Specified by:

process in interface BatchProcessor

Parameters:

toProcess - a File that denotes a directory to process

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

resultHandler - 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

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

Description copied from interface: BatchProcessor

Process a list of PDF files

Specified by:

process in interface BatchProcessor

Parameters:

toProcess - a List of Files to process

resultHandler - 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.

processContainer

protected abstract void processContainer(File container,
                                         boolean recurse)
                                  throws VeraPDFException

Throws:

VeraPDFException

processList

protected abstract void processList(List<? extends File> toProcess)
                             throws VeraPDFException

Throws:

VeraPDFException

processResult

protected void processResult(ProcessorResult result)
                      throws VeraPDFException

Throws:

VeraPDFException