com.itextpdf.testutils
Class CompareTool

java.lang.Object
  extended by com.itextpdf.testutils.CompareTool

public class CompareTool
extends Object

Helper class for tests: uses ghostscript to compare PDFs at a pixel level.


Nested Class Summary
protected  class CompareTool.CompareResult
           
 
Constructor Summary
CompareTool()
           
 
Method Summary
 String compare(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix)
           
 String compare(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix, Map<Integer,List<Rectangle>> ignoredAreas)
           
 boolean compareArrays(PdfArray outArray, PdfArray cmpArray)
           
 boolean compareBooleans(PdfBoolean outBoolean, PdfBoolean cmpBoolean)
           
 String compareByContent(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix)
           
 String compareByContent(String outPdf, String cmpPdf, String outPath, String differenceImagePrefix, Map<Integer,List<Rectangle>> ignoredAreas)
           
 boolean compareDictionaries(PdfDictionary outDict, PdfDictionary cmpDict)
           
 String compareDocumentInfo(String outPdf, String cmpPdf)
           
 String compareLinks(String outPdf, String cmpPdf)
           
 boolean compareNames(PdfName outName, PdfName cmpName)
           
 boolean compareNumbers(PdfNumber outNumber, PdfNumber cmpNumber)
           
 boolean compareStreams(PRStream outStream, PRStream cmpStream)
           
 boolean compareStrings(PdfString outString, PdfString cmpString)
           
 String compareTagStructures(String outPdf, String cmpPdf)
           
 boolean compareXmls(byte[] xml1, byte[] xml2)
           
 boolean compareXmls(String xml1, String xml2)
           
 String compareXmp(String outPdf, String cmpPdf)
           
 String compareXmp(String outPdf, String cmpPdf, boolean ignoreDateAndProducerProperties)
           
 CompareTool setCompareByContentErrorsLimit(int compareByContentMaxErrorCount)
          Sets the maximum errors count which will be returned as the result of the comparison.
 void setGenerateCompareByContentXmlReport(boolean generateCompareByContentXmlReport)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CompareTool

public CompareTool()
Method Detail

compare

public String compare(String outPdf,
                      String cmpPdf,
                      String outPath,
                      String differenceImagePrefix,
                      Map<Integer,List<Rectangle>> ignoredAreas)
               throws IOException,
                      InterruptedException,
                      DocumentException
Throws:
IOException
InterruptedException
DocumentException

compare

public String compare(String outPdf,
                      String cmpPdf,
                      String outPath,
                      String differenceImagePrefix)
               throws IOException,
                      InterruptedException,
                      DocumentException
Throws:
IOException
InterruptedException
DocumentException

setCompareByContentErrorsLimit

public CompareTool setCompareByContentErrorsLimit(int compareByContentMaxErrorCount)
Sets the maximum errors count which will be returned as the result of the comparison.

Parameters:
compareByContentMaxErrorCount - the errors count.
Returns:
Returns this.

setGenerateCompareByContentXmlReport

public void setGenerateCompareByContentXmlReport(boolean generateCompareByContentXmlReport)

compareByContent

public String compareByContent(String outPdf,
                               String cmpPdf,
                               String outPath,
                               String differenceImagePrefix,
                               Map<Integer,List<Rectangle>> ignoredAreas)
                        throws DocumentException,
                               InterruptedException,
                               IOException
Throws:
DocumentException
InterruptedException
IOException

compareByContent

public String compareByContent(String outPdf,
                               String cmpPdf,
                               String outPath,
                               String differenceImagePrefix)
                        throws DocumentException,
                               InterruptedException,
                               IOException
Throws:
DocumentException
InterruptedException
IOException

compareDictionaries

public boolean compareDictionaries(PdfDictionary outDict,
                                   PdfDictionary cmpDict)
                            throws IOException
Throws:
IOException

compareStreams

public boolean compareStreams(PRStream outStream,
                              PRStream cmpStream)
                       throws IOException
Throws:
IOException

compareArrays

public boolean compareArrays(PdfArray outArray,
                             PdfArray cmpArray)
                      throws IOException
Throws:
IOException

compareNames

public boolean compareNames(PdfName outName,
                            PdfName cmpName)

compareNumbers

public boolean compareNumbers(PdfNumber outNumber,
                              PdfNumber cmpNumber)

compareStrings

public boolean compareStrings(PdfString outString,
                              PdfString cmpString)

compareBooleans

public boolean compareBooleans(PdfBoolean outBoolean,
                               PdfBoolean cmpBoolean)

compareXmp

public String compareXmp(String outPdf,
                         String cmpPdf)

compareXmp

public String compareXmp(String outPdf,
                         String cmpPdf,
                         boolean ignoreDateAndProducerProperties)

compareXmls

public boolean compareXmls(byte[] xml1,
                           byte[] xml2)
                    throws ParserConfigurationException,
                           SAXException,
                           IOException
Throws:
ParserConfigurationException
SAXException
IOException

compareDocumentInfo

public String compareDocumentInfo(String outPdf,
                                  String cmpPdf)
                           throws IOException
Throws:
IOException

compareLinks

public String compareLinks(String outPdf,
                           String cmpPdf)
                    throws IOException
Throws:
IOException

compareTagStructures

public String compareTagStructures(String outPdf,
                                   String cmpPdf)
                            throws IOException,
                                   ParserConfigurationException,
                                   SAXException
Throws:
IOException
ParserConfigurationException
SAXException

compareXmls

public boolean compareXmls(String xml1,
                           String xml2)
                    throws ParserConfigurationException,
                           SAXException,
                           IOException
Throws:
ParserConfigurationException
SAXException
IOException


Copyright © 2015. All Rights Reserved.