Foxit PDF SDK
com.foxit.sdk.addon.compliance.PDFACompliance Class Reference
Inheritance diagram for com.foxit.sdk.addon.compliance.PDFACompliance:
com.foxit.sdk.common.Base

Public Member Functions

 PDFACompliance ()
 Constructor.
 
 PDFACompliance (PDFACompliance other)
 Constructor, with another PDFA compliance object. More...
 
ResultInformation convertPDFFile (String src_pdf_path, String saved_pdf_path, int convert_to_version, ProgressCallback progress_callback) throws com.foxit.sdk.PDFException
 Convert a PDF file with specified PDFA version. More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
boolean isEmpty ()
 Check whether current object is empty or not. More...
 
ResultInformation verify (int verify_version, String src_pdf_path, int first_page_index, int last_page_index, ProgressCallback progress_callback) throws com.foxit.sdk.PDFException
 Verify a PDF file with specified PDFA version. More...
 
- Public Member Functions inherited from com.foxit.sdk.common.Base
synchronized void delete ()
 Clean up related resources immediately. More...
 

Static Public Attributes

static final int e_VersionPDFA1a = 1
 PDF/A-1a.
 
static final int e_VersionPDFA1b = 2
 PDF/A-1b.
 
static final int e_VersionPDFA2a = 3
 PDF/A-2a.
 
static final int e_VersionPDFA2b = 4
 PDF/A-2b.
 
static final int e_VersionPDFA2u = 5
 PDF/A-2u.
 
static final int e_VersionPDFA3a = 6
 PDF/A-3a.
 
static final int e_VersionPDFA3b = 7
 PDF/A-3b.
 
static final int e_VersionPDFA3u = 8
 PDF/A-3u.
 

Detailed Description

This class can be used to verify if a PDF file matches a PDF/A version or convert a PDF file to a PDF/A version. Please ensure ComplianceEngine has been initialized successfully.

See also
ComplianceEngine

Constructor & Destructor Documentation

◆ PDFACompliance()

com.foxit.sdk.addon.compliance.PDFACompliance.PDFACompliance ( PDFACompliance  other)

Constructor, with another PDFA compliance object.

Parameters
[in]otherAnother PDFA compliance object.

Member Function Documentation

◆ convertPDFFile()

ResultInformation com.foxit.sdk.addon.compliance.PDFACompliance.convertPDFFile ( String  src_pdf_path,
String  saved_pdf_path,
int  convert_to_version,
ProgressCallback  progress_callback 
) throws com.foxit.sdk.PDFException

Convert a PDF file with specified PDFA version.

Parameters
[in]src_pdf_pathA complete path of source PDF file to be converted. This should not be an empty string.
[in]saved_pdf_pathA complete path for saving the converted PDF file. This should not be an empty string.
[in]convert_to_versionPDFA version to convert to.Please refer to values starting from com.foxit.sdk.addon.compliance.PDFACompliance.e_VersionPDFA1a and this should be one of these values.
[in]progress_callbackProgress callback which is implemented by user and can be used to get progress data. This can be null.
Returns
A ResultInformation object.

◆ delete()

synchronized void com.foxit.sdk.addon.compliance.PDFACompliance.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

◆ isEmpty()

boolean com.foxit.sdk.addon.compliance.PDFACompliance.isEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ verify()

ResultInformation com.foxit.sdk.addon.compliance.PDFACompliance.verify ( int  verify_version,
String  src_pdf_path,
int  first_page_index,
int  last_page_index,
ProgressCallback  progress_callback 
) throws com.foxit.sdk.PDFException

Verify a PDF file with specified PDFA version.

Parameters
[in]verify_versionPDFA version to verify.
[in]src_pdf_pathA complete path of source PDF file to be verified. This should not be an empty string.
[in]first_page_indexIndex of the first page to be verified, staring from 0.
[in]last_page_indexIndex of the last page to be verified. If this is -1, that means all the pages of the source PDF file will be verified and parameter first_page_index would be ignored.
[in]progress_callbackProgress callback which is implemented by user and can be used to get progress data. This can be null.
Returns
A ResultInformation object.