Property Detail

• static boolean bCompareAllPages

• static boolean bHighlightPdfDifference

• static boolean bTrimWhiteSpace

• static CompareModes compareMode

• static int endPage

• static java.lang.String imageDestinationPath

• static java.awt.Color imgColor

• static int startPage

• static org.apache.pdfbox.text.PDFTextStripper stripper

Method Detail

• @groovy.transform.CompileStatic static void compareAllPages(boolean flag)

  To compare all the pages of the PDF files. By default as soon as a mismatch is found, the method returns false and exits.

  Parameters:

  flag - true to enable; false otherwise

• @groovy.transform.CompileStatic static boolean comparePdfFiles(java.lang.String file1, java.lang.String file2, int startPage, int endPage, java.lang.Object excludePattern)

  This method compare PDF files

• @groovy.transform.CompileStatic static boolean comparepdfFilesWithTextMode(java.lang.String file1, java.lang.String file2, int startPage, int endPage, java.lang.String[] excludePattern)

  This method compare PDF files with text mode

• @groovy.transform.CompileStatic static boolean createFolder(java.lang.String dir)

  To create folder

  Parameters:

  dir - The path to create the folder

• @groovy.transform.CompileStatic static void createImageDestinationDirectory(java.lang.String file)

  To create image destination directory

  Parameters:

  file - the file path from which defines the location of the image directory

• @groovy.transform.CompileStatic static CompareModes getCompareMode()

  This method is used to get the current comparison mode text/visual

  Returns:

  CompareMode

• @groovy.transform.CompileStatic static java.lang.String getFileName(java.lang.String file)

  This method gets the file name

• @groovy.transform.CompileStatic static java.lang.String getImageDestinationPath()

  Path where images are stored when the savePdfAsImage or extractPdfImages methods are invoked.

  Returns:

  String Absolute path where images are stored

• @groovy.transform.CompileStatic static java.lang.String getPDFText(java.lang.String file, int startPage, int endPage)

  This method returns the content of the document

• @groovy.transform.CompileStatic static void highlightPdfDifference(boolean flag)

  Highlight the difference when 2 pdf files are compared in Binary mode. The result is saved as an image.

  Parameters:

  flag - true - enable ; false - disable (default);

• @groovy.transform.CompileStatic static void highlightPdfDifference(java.awt.Color colorCode)

  Color in which pdf difference can be highlighted. MAGENTA is the default color.

  Parameters:

  colorCode - color code to highlight the difference

• @groovy.transform.CompileStatic static void setCompareMode(CompareModes mode)

  This method is used to change the file comparison mode text/visual

  Parameters:

  mode - CompareMode

• @groovy.transform.CompileStatic static void setImageDestinationPath(java.lang.String path)

  Set the path where images to be stored when the savePdfAsImage or extractPdfImages methods are invoked.

  Parameters:

  path - Absolute path to store the images

• @groovy.transform.CompileStatic static void trimWhiteSpace(boolean flag)

  getText method by default replaces all the white spaces and compares. This method is used to enable/disable the feature.

  Parameters:

  flag - true to enable; false otherwise

• @groovy.transform.CompileStatic static void updateStartAndEndPages(java.lang.String file, int start, int end)

  To update the start and end page

  Parameters:

  file - Absolute file path of the file

  start - the start page

  end - the end page

• @groovy.transform.CompileStatic static void useStripper(org.apache.pdfbox.text.PDFTextStripper stripper)

  To modify the text extracting strategy using PDFTextStripper

  Parameters:

  stripper - Stripper with user strategy