Package com.codeborne.selenide.impl

Class ScreenShotLaboratory

java.lang.Object

com.codeborne.selenide.impl.ScreenShotLaboratory

@ParametersAreNonnullByDefault
public class ScreenShotLaboratory
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<Screenshot>	allScreenshots
protected final ThreadLocal<String>	currentContext
protected final ThreadLocal<List<Screenshot>>	currentContextScreenshots
protected AtomicLong	screenshotCounter
protected final ThreadLocal<List<Screenshot>>	threadScreenshots

Method Summary

Modifier and Type	Method	Description
protected void	addToHistory(Screenshot screenshot)
List<Screenshot>	contextScreenshots()
List<Screenshot>	finishContext()
protected String	generateScreenshotFileName()
List<File>	getContextScreenshots()
static ScreenShotLaboratory	getInstance()
Optional<File>	getLastContextScreenshot()
File	getLastScreenshot()
Optional<File>	getLastThreadScreenshot()
protected String	getScreenshotFileName(String className, String methodName)
List<File>	getScreenshots()
List<File>	getThreadScreenshots()
Optional<Screenshot>	lastContextScreenshot()
Screenshot	lastScreenshot()
Optional<Screenshot>	lastThreadScreenshot()
protected File	savePageImageToFile(Config config, String fileName, Driver driver)
protected File	savePageSourceToFile(Config config, String fileName, Driver driver)
void	startContext(String context)
void	startContext(String className, String methodName)
Screenshot	takeScreenshot(Driver driver, boolean saveScreenshot, boolean savePageSource)
Screenshot	takeScreenshot(Driver driver, String fileName, boolean saveScreenshot, boolean savePageSource)	Takes screenshot of current browser window.
File	takeScreenshot(Driver driver, org.openqa.selenium.WebElement element)
File	takeScreenshot(Driver driver, org.openqa.selenium.WebElement iframe, SelenideElement element)
Screenshot	takeScreenShot(Driver driver, String className, String methodName)
<T> T	takeScreenShot(Driver driver, org.openqa.selenium.OutputType<T> outputType)
File	takeScreenShotAsFile(Driver driver)
BufferedImage	takeScreenshotAsImage(Driver driver, org.openqa.selenium.WebElement element)
BufferedImage	takeScreenshotAsImage(Driver driver, org.openqa.selenium.WebElement iframe, SelenideElement element)
List<Screenshot>	threadScreenshots()

Methods inherited from class java.lang.Object

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

Field Details

allScreenshots

protected final List<Screenshot> allScreenshots

screenshotCounter

protected AtomicLong screenshotCounter

currentContext

protected final ThreadLocal<String> currentContext

currentContextScreenshots

protected final ThreadLocal<List<Screenshot>> currentContextScreenshots

threadScreenshots

protected final ThreadLocal<List<Screenshot>> threadScreenshots

Method Details

getInstance

public static ScreenShotLaboratory getInstance()

takeScreenShot

@CheckReturnValue
@Nonnull
public Screenshot takeScreenShot(Driver driver,
 String className,
 String methodName)

getScreenshotFileName

@CheckReturnValue
@Nonnull
protected String getScreenshotFileName(String className,
 String methodName)

takeScreenshot

@CheckReturnValue
@Nonnull
public Screenshot takeScreenshot(Driver driver,
 String fileName,
 boolean saveScreenshot,
 boolean savePageSource)

Takes screenshot of current browser window. Stores 2 files: 1. html of the page (if "savePageSource" parameter is true), and 2. screenshot of the page in PNG format (if "saveScreenshot" parameter is true)

Either file may be null if webdriver has failed to save it.

Parameters:

fileName - name of file (without extension) to store screenshot to.

Returns:

instance of Screenshot containing both files

takeScreenShot

@CheckReturnValue
@Nullable
public <T> T takeScreenShot(Driver driver,
 org.openqa.selenium.OutputType<T> outputType)

takeScreenshot

@CheckReturnValue
@Nullable
public File takeScreenshot(Driver driver,
 org.openqa.selenium.WebElement element)

takeScreenshotAsImage

@CheckReturnValue
@Nullable
public BufferedImage takeScreenshotAsImage(Driver driver,
 org.openqa.selenium.WebElement element)

generateScreenshotFileName

@CheckReturnValue
@Nonnull
protected String generateScreenshotFileName()

takeScreenshot

@CheckReturnValue
@Nullable
public File takeScreenshot(Driver driver,
 org.openqa.selenium.WebElement iframe,
 SelenideElement element)

takeScreenshotAsImage

@CheckReturnValue
@Nullable
public BufferedImage takeScreenshotAsImage(Driver driver,
 org.openqa.selenium.WebElement iframe,
 SelenideElement element)

takeScreenShotAsFile

@CheckReturnValue
@Nullable
public File takeScreenShotAsFile(Driver driver)

addToHistory

protected void addToHistory(Screenshot screenshot)

savePageImageToFile

@CheckReturnValue
@Nullable
protected File savePageImageToFile(Config config,
 String fileName,
 Driver driver)

savePageSourceToFile

@CheckReturnValue
@Nonnull
protected File savePageSourceToFile(Config config,
 String fileName,
 Driver driver)

startContext

public void startContext(String className,
 String methodName)

startContext

public void startContext(String context)

finishContext

@Nonnull
public List<Screenshot> finishContext()

getScreenshots

@CheckReturnValue
@Nonnull
public List<File> getScreenshots()

getThreadScreenshots

@CheckReturnValue
@Nonnull
public List<File> getThreadScreenshots()

threadScreenshots

@CheckReturnValue
@Nonnull
public List<Screenshot> threadScreenshots()

getContextScreenshots

@CheckReturnValue
@Nonnull
public List<File> getContextScreenshots()

contextScreenshots

@CheckReturnValue
@Nonnull
public List<Screenshot> contextScreenshots()

getLastScreenshot

@CheckReturnValue
@Nullable
public File getLastScreenshot()

lastScreenshot

@CheckReturnValue
@Nullable
public Screenshot lastScreenshot()

getLastThreadScreenshot

@CheckReturnValue
@Nonnull
public Optional<File> getLastThreadScreenshot()

lastThreadScreenshot

@CheckReturnValue
@Nonnull
public Optional<Screenshot> lastThreadScreenshot()

getLastContextScreenshot

@CheckReturnValue
@Nonnull
public Optional<File> getLastContextScreenshot()

lastContextScreenshot

@CheckReturnValue
@Nonnull
public Optional<Screenshot> lastContextScreenshot()

takeScreenshot

@CheckReturnValue
@Nonnull
public Screenshot takeScreenshot(Driver driver,
 boolean saveScreenshot,
 boolean savePageSource)