Package com.deltaxml.powerpoint

Interface PowerPointCompare

public interface PowerPointCompare

The entry point into the PowerPoint Compare Java API.

Call create() to obtain an instance.

  • Field Details

    • POWERPOINT_CONFIG_NAMESPACE

      static final String POWERPOINT_CONFIG_NAMESPACE
      Namespace used by the PowerPoint Compare configuration file.
      See Also:

  • Method Details

    • create

      static PowerPointCompare create()
      Create a new PowerPointCompare instance.
      Returns:
      the new PowerPointCompare instance.

    • compare

      void compare(File input1, File input2, File output) throws IOException, DeltaXMLException
      Compare two pptx documents and return a comparison result pptx document with a companion report put in the same directory.
      Parameters:
      input1 - The first .pptx document to compare (the 'A' input)
      input2 - The second .pptx document to compare (the 'B' input)
      output - The comparison result as a '.pptx' file with comments added to indicate change
      Throws:
      DeltaXMLException - when an error occurs during PowerPoint Comparison
      IOException - when unable to read/write files.

    • compare

      void compare(Path input1, Path input2, Path output) throws IOException, DeltaXMLException
      Compare two pptx documents and return a comparison result pptx document with a companion report put in the same directory.
      Parameters:
      input1 - The first .pptx document to compare (the 'A' input)
      input2 - The second .pptx document to compare (the 'B' input)
      output - The comparison result as a '.pptx' file with comments added to indicate change
      Throws:
      DeltaXMLException - when an error occurs during PowerPoint Comparison
      IOException - when unable to read/write files.

    • addProgressListener

      void addProgressListener(PowerPointCompareProgressListener progressListener)
      Add a progress listener. This adds a progress listener to the list of registered progress listeners. The same listener may be added more than once.
      Parameters:
      progressListener - the progress listener to add.

    • removeProgressListener

      void removeProgressListener(PowerPointCompareProgressListener progressListener)
      Remove a progress listener. This removes the first occurrence of the progress listener from the registered progress listener list.
      Parameters:
      progressListener - the progress listener to remove.

    • clearProgressListeners

      void clearProgressListeners()
      Clears all registered progress listeners.

    • addLicenseFile

      void addLicenseFile(File licenseFile) throws com.deltaxml.licensing.LicenseException, IOException
      Adds a license file for use with Flexera licensing. This can be either simple server/named-user license file or a concurrent license file containing the USE_SERVER directive.
      Parameters:
      licenseFile - the FlexLM format license file
      Throws:
      IOException - if there are problems reading the file
      com.deltaxml.licensing.LicenseException - if there is a problem using the license file

    • addLicenseServer

      void addLicenseServer(String hostname) throws com.deltaxml.licensing.LicenseException
      Adds a license server (for use with a flexera license server).
      Parameters:
      hostname - of the license server host or its ip address
      Throws:
      com.deltaxml.licensing.LicenseException - if there is a problem using the license server

    • addLicenseServer

      void addLicenseServer(String hostname, int port) throws IllegalArgumentException, com.deltaxml.licensing.LicenseException
      Adds a license server and port (for use with a flexera license server).
      Parameters:
      hostname - of the license server host or its ip address
      port - the port number on the license server for the lmgrd
      Throws:
      IllegalArgumentException - if the port number is out of range
      com.deltaxml.licensing.LicenseException - if there is a problem using the license server

    • setDebugFiles

      void setDebugFiles(boolean isEnabled)
      A method to enable debugging information on the filters of the comparison.
      Parameters:
      isEnabled - Set to true for enabled, false for disabled

    • getDebugFiles

      boolean getDebugFiles()

      Gets whether the production of debug files is on or not.

      Returns:
      whether the production of debug files is on or not.
      See Also:

    • setDebugFilesPrefix

      void setDebugFilesPrefix(String value)
      Sets what name to use for the folder containing debug files.
      Parameters:
      value - the string name of the folder that contains debug files

    • getDebugFilesPrefix

      String getDebugFilesPrefix()
      Get the current prefix used for debug result files.
      Returns:
      the current prefix used for debug result files.
      See Also:

    • setImageConfig

      void setImageConfig(ImageConfig imageConfig)
      Sets the image comparison configuration.
      Parameters:
      imageConfig - the image comparison configuration

    • getImageConfig

      ImageConfig getImageConfig()
      Gets the image comparison configuration.
      Returns:
      the image comparison configuration

    • setSvgConfig

      void setSvgConfig(SvgConfig svgConfig)
      Sets the SVG comparison configuration.
      Parameters:
      svgConfig - the SVG comparison configuration

    • getSvgConfig

      SvgConfig getSvgConfig()
      Gets the SVG comparison configuration.
      Returns:
      the SVG comparison configuration