com.itextpdf.kernel.utils Documentation Differences

iText7 8.0.0 Overview Package Class Text Changes Statistics Help

Generated by
JDiff

PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES

com.itextpdf.kernel.utils Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.kernel.utils as colored differences. Deletions are shown ~~like this~~ , and additions are shown like this.

If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.

Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.

 
  
 Class CompareTool, String compareVisually(String, String, String, String) 
  
 
  
 
  
    Compares two documents visually. For the comparison two external tools are used: Ghostscript and ImageMagick. For more info about needed configuration for visual comparison process see CompareTool class description. 
    Note, that this method uses ImageMagickHelper and GhostscriptHelper classes and therefore may create temporary files and directories.  
    During comparison for every page of the two documents an image file will be created in the folder specified by outPath parameter. Then those page images will be compared and if there are any differences for some pages, another image file will be created with marked differences on it. @param outPdf the absolute path to the output file, which is to be compared to cmp-file. @param cmpPdf the absolute path to the cmp-file, which is to be compared to output file. @param outPath the absolute path to the folder, which will be used to store image files for visual comparison. @param differenceImagePrefix file name prefix for image files with marked differences if there is any. @return string containing list of the pages that are visually different, or null if there are no visual differences. @throws InterruptedException if the current thread is interrupted by another thread while it is waiting for ghostscript or imagemagic processes, then the wait is ended and an InterruptedException is thrown. @throws IOException is thrown if any of the input files are missing or any of the auxiliary files that are created during comparison process weren't possible to be created. 
  
 Class CompareTool, String compareVisually(String, String, String, String, Map>) 
  
 
  
 
  
    Compares two documents visually. For the comparison two external tools are used: Ghostscript and ImageMagick. For more info about needed configuration for visual comparison process see CompareTool class description. 
    Note, that this method uses ImageMagickHelper and GhostscriptHelper classes and therefore may create temporary files and directories.  
    During comparison for every page of two documents an image file will be created in the folder specified by outPath parameter. Then those page images will be compared and if there are any differences for some pages, another image file will be created with marked differences on it.  
    It is possible to ignore certain areas of the document pages during visual comparison. This is useful for example in case if documents should be the same except certain page area with date on it. In this case, in the folder specified by the outPath, new pdf documents will be created with the black rectangles at the specified ignored areas, and visual comparison will be performed on these new documents. @param outPdf the absolute path to the output file, which is to be compared to cmp-file. @param cmpPdf the absolute path to the cmp-file, which is to be compared to output file. @param outPath the absolute path to the folder, which will be used to store image files for visual comparison. @param differenceImagePrefix file name prefix for image files with marked differences if there is any. @param ignoredAreas a map with one-based page numbers as keys and lists of ignored rectangles as values. @return string containing list of the pages that are visually different, or null if there are no visual differences. @throws InterruptedException if the current thread is interrupted by another thread while it is waiting for ghostscript or imagemagic processes, then the wait is ended and an InterruptedException is thrown. @throws IOException is thrown if any of the input files are missing or any of the auxiliary files that are created during comparison process weren't possible to be created. 
   
  
 Class DefaultSafeXmlParserFactory, void configureSafeDocumentBuilderFactory(DocumentBuilderFactory) 
  
 
  
 
  
    Configures document builder factory to make it secure against xml attacks. 
      
   @param factory DocumentBuilderFactory instance to be configured 
  
 Class DefaultSafeXmlParserFactory, DocumentBuilderFactory createDocumentBuilderFactory() 
  
 
  
 
  
    Creates a document builder factory implementation. 
      
   @return result of DocumentBuilderFactory.newInstance() call 
  
 Class DefaultSafeXmlParserFactory, SAXParserFactory createSAXParserFactory() 
  
 
  
 
  
    Creates a SAX parser factory implementation. 
      
   @return result of SAXParserFactory.newInstance() call