Package 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	Description
static class	ImageFileUtil.ImageFileUtilImpl

Constructor Summary

Constructors

Constructor	Description
ImageFileUtil()

Method Summary

Modifier and Type	Method	Description
static void	createScreenshotDirectoriesIfNeeded()	Creates all directories used to store screenshots unless they already exist.
static File	getErrorScreenshotFile(String errorImageFileName)
static List<String>	getReferenceImageFileNames(String referenceImageFileName, org.openqa.selenium.Capabilities capabilities)	Returns the relative file names of reference images.
static File	getReferenceScreenshotFile(String referenceImageFileName)
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 - The name of the reference image file.

Returns:

a BufferedImage containing the reference image.

Throws:

IOException - if an error occurs during reading.

getErrorScreenshotFile

public static File getErrorScreenshotFile(String errorImageFileName)

getReferenceScreenshotFile

public static File getReferenceScreenshotFile(String referenceImageFileName)

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 - 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