com.vaadin.testbench.screenshot

Class ImageFileUtil.ImageFileUtilImpl

java.lang.Object

com.vaadin.testbench.screenshot.ImageFileUtil.ImageFileUtilImpl

Enclosing class:

ImageFileUtil

public static class ImageFileUtil.ImageFileUtilImpl
extends Object

Constructor Summary

Constructors

Constructor and Description
ImageFileUtilImpl()

Method Summary

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

ImageFileUtilImpl

public ImageFileUtilImpl()

Method Detail

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

Returns:

image instance

Throws:

IOException - if reading the file failed

getErrorScreenshotFile

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