Class ImageFileUtil.ImageFileUtilImpl

java.lang.Object
com.vaadin.testbench.screenshot.ImageFileUtil.ImageFileUtilImpl
Enclosing class:
ImageFileUtil

public static class ImageFileUtil.ImageFileUtilImpl extends Object
  • Constructor Details

    • ImageFileUtilImpl

      public ImageFileUtilImpl()
  • Method Details

    • getScreenshotReferenceDirectory

      public String getScreenshotReferenceDirectory()
      Returns the directory used for screenshot references.
      Returns:
      The screenshot reference directory, ending in a slash.
    • getScreenshotErrorDirectory

      public String getScreenshotErrorDirectory()
      Returns the directory used for screenshot error images.
      Returns:
      The screenshot error directory, ending in a slash.
    • createScreenshotDirectoriesIfNeeded

      public void createScreenshotDirectoriesIfNeeded()
      Creates all directories used to store screenshots unless they already exist.
    • readReferenceImage

      public BufferedImage readReferenceImage(String referenceImageFileName) throws IOException
      Reads the given reference image into a BufferedImage
      Parameters:
      referenceImageFileName - The name of the reference image file.
      Returns:
      a BufferedImage containing the reference image.
      Throws:
      IOException - if an error occurs during reading.
    • getErrorScreenshotFile

      public File getErrorScreenshotFile(String errorImageFileName)
    • getReferenceScreenshotFile

      public File getReferenceScreenshotFile(String referenceImageFileName)
    • getReferenceImageFileNames

      public List<String> getReferenceImageFileNames(String referenceImageFileName, org.openqa.selenium.Capabilities capabilities)
      Returns the relative file names of reference images. The actual image file for a relative file name can be retrieved with getReferenceScreenshotFile(String).
      Parameters:
      referenceImageFileName - id part of the reference image file name
      capabilities - used to compute the full name of the alternative references
      Returns:
      file names of reference images