com.qoppa.pdfPreflight

Interface ProgressListener

public interface ProgressListener

This class is used when processing a document to receive progress reports on the validation or conversion process. The calling application can implement this interface to show a progress bar or some other progress mechanism to the user as a document is being processed. The methods here may be called quite frequently by the preflight operation, so if any implementations perform expensive operations it may result in a noticeable drag on runtime.

Author:

Qoppa Software

Method Summary

Modifier and Type	Method and Description
void	progress(int pageNumber, int percent, String message) This method is called by the preflight operation to notify listeners of progress.
void	resultAdded(ResultRecord result) This method is called by the preflight operation to notify listeners of a result added.
boolean	shouldCancel() This method is called by the preflight operation to allow cancellation of the operation.

Method Detail

progress

void progress(int pageNumber,
              int percent,
              String message)

This method is called by the preflight operation to notify listeners of progress.

Parameters:

pageNumber - The page number that is being checked.

percent - The percent value to completion (0-100).

message - A readable message that describes the current operation.

shouldCancel

boolean shouldCancel()

This method is called by the preflight operation to allow cancellation of the operation. It is intended that this method is called quite frequently to ensure responsive termination of the operation if so desired (and thus implementors are discouraged from putting any time consuming operations inside this method).

Returns:

A boolean that represents whether the progress should be cancelled

resultAdded

void resultAdded(ResultRecord result)

This method is called by the preflight operation to notify listeners of a result added. For example, this may be used for indicating a preflight operation should be cancelled once the first result is encountered rather than generating a full report of all errors.

Parameters:

result - The most recently generated result; in general this indicates some violation of the profile being run.