com.applitools.eyes.rendering

Class Eyes

java.lang.Object

com.applitools.eyes.rendering.Eyes

All Implemented Interfaces:

IEyes, IRenderingEyes

public class Eyes
extends Object
implements IRenderingEyes, IEyes

Nested Class Summary

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

IRenderingEyes.EyesListener

Constructor Summary

Constructors

Constructor and Description
Eyes(VisualGridManager renderingGridManager)

Method Summary

Modifier and Type	Method and Description
TestResults	abortIfNotClosed()
void	check(ICheckSettings checkSettings)
void	check(String name, ICheckSettings checkSettings)
List<Future<TestResultContainer>>	close()
List<Future<TestResultContainer>>	close(boolean throwException)
List<RunningTest>	getAllRunningTests()
String	getApiKey()
ScoreTask	getBestScoreTaskForCheck()
ScoreTask	getBestScoreTaskForOpen()
List<Future<TestResultContainer>>	getCloseFutures()
boolean	getIsDisabled()
boolean	getIsOpen()
Logger	getLogger()
RunningTest	getNextTestToClose()
URI	getServerUrl()
boolean	isEyesClosed()
void	open(org.openqa.selenium.WebDriver webDriver, RenderingConfiguration renderingConfiguration)
void	setApiKey(String apiKey)
void	setBatch(BatchInfo batchInfo)
void	setBranchName(String branchName)
void	setDebugResourceWriter(IDebugResourceWriter debugResourceWriter)
void	setHideCaret(boolean hideCaret)
void	setIsDisabled(boolean disabled)
void	setListener(IRenderingEyes.EyesListener listener)
void	setLogHandler(LogHandler logHandler) Sets a handler of log messages generated by this API.
void	setMatchLevel(MatchLevel level)
void	setParentBranchName(String branchName)
void	setProxy(AbstractProxySettings abstractProxySettings) Sets the proxy settings to be used by the rest client.
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

Eyes

public Eyes(VisualGridManager renderingGridManager)

Method Detail

setLogHandler

public void setLogHandler(LogHandler logHandler)

Sets a handler of log messages generated by this API.

Specified by:

setLogHandler in interface IEyes

Parameters:

logHandler - Handles log messages generated by this API.

open

public void open(org.openqa.selenium.WebDriver webDriver,
                 RenderingConfiguration renderingConfiguration)

getNextTestToClose

public RunningTest getNextTestToClose()

Specified by:

getNextTestToClose in interface IRenderingEyes

close

public List<Future<TestResultContainer>> close()

Specified by:

close in interface IRenderingEyes

close

public List<Future<TestResultContainer>> close(boolean throwException)

abortIfNotClosed

public TestResults abortIfNotClosed()

Specified by:

abortIfNotClosed in interface IEyes

getIsOpen

public boolean getIsOpen()

Specified by:

getIsOpen in interface IEyes

getApiKey

public String getApiKey()

Specified by:

getApiKey in interface IEyes

setApiKey

public void setApiKey(String apiKey)

Specified by:

setApiKey in interface IEyes

setIsDisabled

public void setIsDisabled(boolean disabled)

Specified by:

setIsDisabled in interface IEyes

getIsDisabled

public boolean getIsDisabled()

Specified by:

getIsDisabled in interface IEyes

setBranchName

public void setBranchName(String branchName)

Specified by:

setBranchName in interface IEyes

setParentBranchName

public void setParentBranchName(String branchName)

Specified by:

setParentBranchName in interface IEyes

setHideCaret

public void setHideCaret(boolean hideCaret)

Specified by:

setHideCaret in interface IEyes

setMatchLevel

public void setMatchLevel(MatchLevel level)

Specified by:

setMatchLevel in interface IEyes

getServerUrl

public URI getServerUrl()

Specified by:

getServerUrl in interface IEyes

getBestScoreTaskForCheck

public ScoreTask getBestScoreTaskForCheck()

Specified by:

getBestScoreTaskForCheck in interface IRenderingEyes

getBestScoreTaskForOpen

public ScoreTask getBestScoreTaskForOpen()

Specified by:

getBestScoreTaskForOpen in interface IRenderingEyes

setBatch

public void setBatch(BatchInfo batchInfo)

Specified by:

setBatch in interface IRenderingEyes

setServerUrl

public void setServerUrl(String serverUrl)

Specified by:

setServerUrl in interface IEyes

isEyesClosed

public boolean isEyesClosed()

Specified by:

isEyesClosed in interface IRenderingEyes

setListener

public void setListener(IRenderingEyes.EyesListener listener)

Specified by:

setListener in interface IRenderingEyes

setProxy

public void setProxy(AbstractProxySettings abstractProxySettings)

Sets the proxy settings to be used by the rest client.

Specified by:

setProxy in interface IEyes

Parameters:

abstractProxySettings - The proxy settings to be used by the rest client. If null then no proxy is set.

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

getLogger

public Logger getLogger()

Specified by:

getLogger in interface IEyes

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

getCloseFutures

public List<Future<TestResultContainer>> getCloseFutures()