com.vaadin.testbench.screenshot

Class ImageFileUtil

java.lang.Object

com.vaadin.testbench.screenshot.ImageFileUtil

public class ImageFileUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageFileUtil.ImageFileUtilImpl

Constructor Summary

Constructors

Constructor and Description
ImageFileUtil()

Method Summary

Modifier and Type	Method and Description
static void	createScreenshotDirectoriesIfNeeded() Creates all directories used to store screenshots unless they already exist.
static File	getErrorScreenshotFile(String errorImageFileName) Returns an error screenshot File instance with the given file name within the error screenshot directory.
static List<String>	getReferenceImageFileNames(String referenceImageFileName, org.openqa.selenium.Capabilities capabilities) Returns the relative file names of reference images.
static File	getReferenceScreenshotFile(String referenceImageFileName) Returns a reference screenshot File instance with the given file name within the reference screenshot directory.
static String	getScreenshotErrorDirectory() Returns the directory used for screenshot error images.
static String	getScreenshotReferenceDirectory() Returns the directory used for screenshot references.
static BufferedImage	readReferenceImage(String referenceImageFileName) Reads the given reference image into a BufferedImage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageFileUtil

public ImageFileUtil()

Method Detail

getScreenshotReferenceDirectory

public static String getScreenshotReferenceDirectory()

Returns the directory used for screenshot references.

Returns:

The screenshot reference directory, ending in a slash.

getScreenshotErrorDirectory

public static String getScreenshotErrorDirectory()

Returns the directory used for screenshot error images.

Returns:

The screenshot error directory, ending in a slash.

createScreenshotDirectoriesIfNeeded

public static void createScreenshotDirectoriesIfNeeded()

Creates all directories used to store screenshots unless they already exist.

readReferenceImage

public static BufferedImage readReferenceImage(String referenceImageFileName)
                                        throws IOException

Reads the given reference image into a BufferedImage

Parameters:

referenceImageFileName - image pathname

Returns:

buffered image

Throws:

IOException - if an error occurs during reading the image

getErrorScreenshotFile

public static File getErrorScreenshotFile(String errorImageFileName)

Returns an error screenshot File instance with the given file name within the error screenshot directory. The file doesn't necessarily exist yet in the file system after this method has been called.

Parameters:

errorImageFileName - name of the error screenshot

Returns:

error screenshot file

getReferenceScreenshotFile

public static File getReferenceScreenshotFile(String referenceImageFileName)

Returns a reference screenshot File instance with the given file name within the reference screenshot directory. The file doesn't necessarily exist yet in the file system after this method has been called.

Parameters:

referenceImageFileName - name of the reference screenshot

Returns:

reference screenshot file

getReferenceImageFileNames

public static 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 - name of the reference screenshot

capabilities - browser capabilities

Returns:

file names of reference images