com.applitools.eyes.selenium.rendering

Class VisualGridEyes

java.lang.Object

com.applitools.eyes.selenium.rendering.VisualGridEyes

All Implemented Interfaces:

IEyesBase, IEyes, ISeleniumEyes, IRenderingEyes

public class VisualGridEyes
extends Object
implements ISeleniumEyes, IRenderingEyes

Nested Class Summary

Nested classes/interfaces inherited from interface com.applitools.eyes.visualgrid.services.IRenderingEyes

IRenderingEyes.EyesListener

Constructor Summary

Constructors

Constructor and Description
VisualGridEyes(VisualGridRunner renderingGridManager, ISeleniumConfigurationProvider configProvider)

Method Summary

Modifier and Type	Method and Description
TestResults	abort()
void	abortAsync()
TestResults	abortIfNotClosed()
void	addProperty(String name, String value) Adds a property to be sent to the server.
void	apiKey(String apiKey)
void	check(ICheckSettings... checkSettings)
void	check(ICheckSettings checkSettings)
void	check(String name, ICheckSettings checkSettings)
void	clearProperties() Clears the list of custom properties.
Collection<Future<TestResultContainer>>	close()
TestResults	close(boolean throwException)
Collection<Future<TestResultContainer>>	closeAsync()
static List<RunningTest>	collectTestsForCheck(Logger logger, List<RunningTest> tests) BEGIN - PUBLIC FOR TESTING PURPOSES ONLY
List<RunningTest>	getAllRunningTests()
List<TestResultContainer>	getAllTestResults()
String	getApiKey()
String	getBaseAgentId()
IBatchCloser	getBatchCloser()
String	getBatchId()
ScoreTask	getBestScoreTaskForCheck()
ScoreTask	getBestScoreTaskForOpen()
EyesWebDriver	getDriver()
String	getFullAgentId()
boolean	getIsDisabled()
boolean	getIsOpen()
Logger	getLogger()
LogHandler	getLogHandler()
RunningTest	getNextTestToClose()
URI	getServerUrl()
boolean	isEyesClosed()
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver webDriver)
org.openqa.selenium.WebDriver	open(org.openqa.selenium.WebDriver driver, String appName, String testName, RectangleSize viewportSize)
void	serverUrl(String serverUrl)
void	serverUrl(URI serverUrl)
void	setApiKey(String apiKey)
void	setBatch(BatchInfo batch) Sets the batch in which context future tests will run or null if tests are to run standalone.
void	setDebugResourceWriter(IDebugResourceWriter debugResourceWriter)
void	setIsDisabled(Boolean disabled)
void	setListener(IRenderingEyes.EyesListener listener)
void	setLogHandler(LogHandler logHandler) Sets a handler of log messages generated by this API.
void	setServerConnector(ServerConnector serverConnector)
void	setServerUrl(String serverUrl)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualGridEyes

public VisualGridEyes(VisualGridRunner renderingGridManager,
                      ISeleniumConfigurationProvider configProvider)

Method Detail

setLogHandler

public void setLogHandler(LogHandler logHandler)

Sets a handler of log messages generated by this API.

Specified by:

setLogHandler in interface IEyesBase

Parameters:

logHandler - Handles log messages generated by this API.

getLogHandler

public LogHandler getLogHandler()

Specified by:

getLogHandler in interface IEyesBase

apiKey

public void apiKey(String apiKey)

Specified by:

apiKey in interface ISeleniumEyes

serverUrl

public void serverUrl(String serverUrl)

Specified by:

serverUrl in interface ISeleniumEyes

serverUrl

public void serverUrl(URI serverUrl)

open

public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver driver,
                                          String appName,
                                          String testName,
                                          RectangleSize viewportSize)
                                   throws EyesException

Specified by:

open in interface ISeleniumEyes

Throws:

EyesException

open

public org.openqa.selenium.WebDriver open(org.openqa.selenium.WebDriver webDriver)

Specified by:

open in interface ISeleniumEyes

getNextTestToClose

public RunningTest getNextTestToClose()

Specified by:

getNextTestToClose in interface IRenderingEyes

close

public Collection<Future<TestResultContainer>> close()

Specified by:

close in interface IRenderingEyes

close

public TestResults close(boolean throwException)

Specified by:

close in interface ISeleniumEyes

abortIfNotClosed

public TestResults abortIfNotClosed()

Specified by:

abortIfNotClosed in interface IEyesBase

getIsOpen

public boolean getIsOpen()

Specified by:

getIsOpen in interface IEyesBase

getApiKey

public String getApiKey()

Specified by:

getApiKey in interface IEyesBase

setApiKey

public void setApiKey(String apiKey)

setIsDisabled

public void setIsDisabled(Boolean disabled)

Specified by:

setIsDisabled in interface IEyesBase

getIsDisabled

public boolean getIsDisabled()

Specified by:

getIsDisabled in interface IEyesBase

getServerUrl

public URI getServerUrl()

Specified by:

getServerUrl in interface IEyesBase

closeAsync

public Collection<Future<TestResultContainer>> closeAsync()

getBestScoreTaskForCheck

public ScoreTask getBestScoreTaskForCheck()

Specified by:

getBestScoreTaskForCheck in interface IRenderingEyes

getBestScoreTaskForOpen

public ScoreTask getBestScoreTaskForOpen()

Specified by:

getBestScoreTaskForOpen in interface IRenderingEyes

setServerUrl

public void setServerUrl(String serverUrl)

isEyesClosed

public boolean isEyesClosed()

Specified by:

isEyesClosed in interface IRenderingEyes

setListener

public void setListener(IRenderingEyes.EyesListener listener)

Specified by:

setListener in interface IRenderingEyes

check

public void check(ICheckSettings... checkSettings)

Specified by:

check in interface IEyes

check

public void check(String name,
                  ICheckSettings checkSettings)

Specified by:

check in interface IEyes

check

public void check(ICheckSettings checkSettings)

Specified by:

check in interface IEyes

collectTestsForCheck

public static List<RunningTest> collectTestsForCheck(Logger logger,
                                                     List<RunningTest> tests)

BEGIN - PUBLIC FOR TESTING PURPOSES ONLY

getLogger

public Logger getLogger()

Specified by:

getLogger in interface IEyesBase

Specified by:

getLogger in interface IRenderingEyes

getAllRunningTests

public List<RunningTest> getAllRunningTests()

Specified by:

getAllRunningTests in interface IRenderingEyes

setDebugResourceWriter

public void setDebugResourceWriter(IDebugResourceWriter debugResourceWriter)

toString

public String toString()

Overrides:

toString in class Object

setServerConnector

public void setServerConnector(ServerConnector serverConnector)

getFullAgentId

public String getFullAgentId()

Specified by:

getFullAgentId in interface IEyesBase

Returns:

The full agent id composed of both the base agent id and the user given agent id.

getBaseAgentId

public String getBaseAgentId()

setBatch

public void setBatch(BatchInfo batch)

Sets the batch in which context future tests will run or null if tests are to run standalone.

Parameters:

batch - The batch info to set.

addProperty

public void addProperty(String name,
                        String value)

Adds a property to be sent to the server.

Specified by:

addProperty in interface IEyesBase

Parameters:

name - The property name.

value - The property value.

clearProperties

public void clearProperties()

Clears the list of custom properties.

Specified by:

clearProperties in interface IEyesBase

getAllTestResults

public List<TestResultContainer> getAllTestResults()

Specified by:

getAllTestResults in interface IRenderingEyes

getDriver

public EyesWebDriver getDriver()

Specified by:

getDriver in interface ISeleniumEyes

getBatchCloser

public IBatchCloser getBatchCloser()

Specified by:

getBatchCloser in interface IRenderingEyes

getBatchId

public String getBatchId()

Specified by:

getBatchId in interface IRenderingEyes

abortAsync

public void abortAsync()

Specified by:

abortAsync in interface IEyesBase

abort

public TestResults abort()

Specified by:

abort in interface IEyesBase