com.github.bogdanlivadariu.gifwebdriver

Class GifScreenshotWorker

java.lang.Object

com.github.bogdanlivadariu.gifwebdriver.GifScreenshotWorker

public class GifScreenshotWorker
extends Object

Worker responsible of taking,storing screenshots and generating the GIF based on tem

Constructor Summary

Constructors

Constructor and Description
GifScreenshotWorker(org.openqa.selenium.WebDriver driver)
GifScreenshotWorker(org.openqa.selenium.WebDriver driver, String rootDir, String screenshotsFolder, String generatedGIFsFolderName, boolean loopContinuously)

Method Summary

Modifier and Type	Method and Description
File	createGif() Creates the GIF and writes it on the disk
String	getGeneratedGIFsFolderName() Defaults to "project.dir/rootDir/uniqueId/generatedGifs"
String	getRootDir()
String	getScreenshotsFolderName() Defaults to "project.dir/rootDir/uniqueId/screenshots"
int	getTimeBetweenFramesInMilliseconds() Defaults to 500ms
String	getUniqueName()
boolean	isLoopContinuously() Defaults to false
void	setGeneratedGIFsFolderName(String generatedGIFsFolderName) Set location where generated GIFs will be stored on disk
void	setLoopContinuously(boolean loopContinuously) Set weather the generated GIF will loop
void	setRootDir(String rootDir) Folder on disk where screenshots and generated GIFs will be stored Defaults to "project.dir/gifScreenshotsFolder/uniqueId/"
void	setScreenshotsFolderName(String screenshotsFolderName) Set location where screenshots will be stored on disk
void	setTimeBetweenFramesInMilliseconds(int timeBetweenFramesInMilliseconds) Set the delay used to switch from one image to another on thegenerated GIV
void	takeScreenshot() Takes a screenshot of the current page

Methods inherited from class java.lang.Object

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

Constructor Detail

GifScreenshotWorker

public GifScreenshotWorker(org.openqa.selenium.WebDriver driver)

GifScreenshotWorker

public GifScreenshotWorker(org.openqa.selenium.WebDriver driver,
                           String rootDir,
                           String screenshotsFolder,
                           String generatedGIFsFolderName,
                           boolean loopContinuously)

Method Detail

takeScreenshot

public void takeScreenshot()

Takes a screenshot of the current page

createGif

public File createGif()

Creates the GIF and writes it on the disk

Returns:

- generated GIF File, null when the gif could not be generated due to lack of screenshots

getTimeBetweenFramesInMilliseconds

public int getTimeBetweenFramesInMilliseconds()

Defaults to 500ms

Returns:

delay used to switch from one image to another on the generated GIF

setTimeBetweenFramesInMilliseconds

public void setTimeBetweenFramesInMilliseconds(int timeBetweenFramesInMilliseconds)

Set the delay used to switch from one image to another on thegenerated GIV

Parameters:

timeBetweenFramesInMilliseconds - - value in milliseconds

isLoopContinuously

public boolean isLoopContinuously()

Defaults to false

Returns:

true/false weather the generated GIF will loop

setLoopContinuously

public void setLoopContinuously(boolean loopContinuously)

Set weather the generated GIF will loop

Parameters:

loopContinuously - true / false

getUniqueName

public String getUniqueName()

Returns:

- Unique name generated used to store every screenshot and GIF as an unique file

getRootDir

public String getRootDir()

Returns:

- folder on disk where the screenshots and generated GIF will get stored

setRootDir

public void setRootDir(String rootDir)

Folder on disk where screenshots and generated GIFs will be stored Defaults to "project.dir/gifScreenshotsFolder/uniqueId/"

Parameters:

rootDir - - path to folder absolute or relative to project dir

getScreenshotsFolderName

public String getScreenshotsFolderName()

Defaults to "project.dir/rootDir/uniqueId/screenshots"

Returns:

- path to folder where screenshots will be stored relative to rootDir

setScreenshotsFolderName

public void setScreenshotsFolderName(String screenshotsFolderName)

Set location where screenshots will be stored on disk

Parameters:

screenshotsFolderName - - path to folder where screenshots will be stored relative to rootDir

getGeneratedGIFsFolderName

public String getGeneratedGIFsFolderName()

Defaults to "project.dir/rootDir/uniqueId/generatedGifs"

Returns:

- folder where the generated GIF will be stored on disk relative to the rootDir

setGeneratedGIFsFolderName

public void setGeneratedGIFsFolderName(String generatedGIFsFolderName)

Set location where generated GIFs will be stored on disk

Parameters:

generatedGIFsFolderName - - path to folder for generated GIFS relative to rootDir