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

Public Member Functions

 ResultInformation ()
 Constructor.

 
 ResultInformation (ResultInformation other)
 Constructor, with another result information object.
More...
 
synchronized void delete ()
 Clean up related C++ resources immediately. More...
 
FixupData getFixupData (int index) throws com.foxit.sdk.PDFException
 Get a fixup data.
More...
 
int getFixupDataCount () throws com.foxit.sdk.PDFException
 Get count of fixup data.
More...
 
HitData getHitData (int index) throws com.foxit.sdk.PDFException
 Get a hit data.
More...
 
int getHitDataCount () throws com.foxit.sdk.PDFException
 Get count of hit data.
More...
 
boolean isEmpty ()
 Check whether current object is empty or not.
More...
 

Detailed Description

This class represents the set of result information for verification or conversion process. Fixup data or hit data can be retrieved from the result information.

Constructor & Destructor Documentation

◆ ResultInformation()

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

Constructor, with another result information object.

Parameters
[in]otherAnother ResultInformation object.

Member Function Documentation

◆ delete()

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

Clean up related C++ resources immediately.

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

Reimplemented from com.foxit.sdk.common.Base.

◆ getFixupData()

FixupData com.foxit.sdk.addon.compliance.ResultInformation.getFixupData ( int  index) throws com.foxit.sdk.PDFException

Get a fixup data.

Fixup data represents the issues that do not conform to the target specification and have been processed by the engine during conversion.

Parameters
[in]indexIndex of fixup data to be retrieved. Valid range: from 0 to (count-1). count is returned by function ResultInformation.getFixupDataCount .
Returns
Fixup data.

◆ getFixupDataCount()

int com.foxit.sdk.addon.compliance.ResultInformation.getFixupDataCount ( ) throws com.foxit.sdk.PDFException

Get count of fixup data.

Fixup data represents the issues that do not conform to the target specification and have been processed by the engine during conversion.

Returns
Count of fixup data.

◆ getHitData()

HitData com.foxit.sdk.addon.compliance.ResultInformation.getHitData ( int  index) throws com.foxit.sdk.PDFException

Get a hit data.

Hit data represents the issues that do not conform to the target specification. For conversion, hit data means the issues that cannot be processed by the engine. For verification, hit data means the count of non-conforming issues.

Parameters
[in]indexIndex of hit data to be retrieved. Valid range: from 0 to (count-1). count is returned by function ResultInformation.getHitDataCount .
Returns
Hit data.

◆ getHitDataCount()

int com.foxit.sdk.addon.compliance.ResultInformation.getHitDataCount ( ) throws com.foxit.sdk.PDFException

Get count of hit data.

Hit data represents the issues that do not conform to the target specification. For conversion, hit data means the issues that cannot be processed by the engine. For verification, hit data means the count of non-conforming issues.

Returns
Count of hit data.

◆ isEmpty()

boolean com.foxit.sdk.addon.compliance.ResultInformation.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.