com.applitools.eyes.config

Class Configuration

java.lang.Object

com.applitools.eyes.config.Configuration

All Implemented Interfaces:

IConfiguration

Direct Known Subclasses:

Configuration, IConfigurationGetter, IConfigurationGetter, IConfigurationSetter, IConfigurationSetter

public class Configuration
extends Object
implements IConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
protected String	appName
protected String	baselineEnvName
protected BatchInfo	batch
protected ImageMatchSettings	defaultMatchSettings
protected Boolean	ignoreDisplacements
protected String	testName
protected RectangleSize	viewportSize

Constructor Summary

Constructors

Constructor and Description
Configuration()
Configuration(Configuration other)
Configuration(RectangleSize viewportSize)
Configuration(String testName)
Configuration(String appName, String testName, RectangleSize viewportSize)

Method Summary

Modifier and Type	Method and Description
Configuration	addBrowser(ChromeEmulationInfo chromeEmulationInfo)
Configuration	addBrowser(DesktopBrowserInfo desktopBrowserInfo)
Configuration	addBrowser(int width, int height, com.applitools.eyes.selenium.BrowserType browserType)
Configuration	addBrowser(int width, int height, com.applitools.eyes.selenium.BrowserType browserType, String baselineEnvName)
Configuration	addBrowser(IosDeviceInfo iosDeviceInfo)
Configuration	addBrowser(RenderBrowserInfo renderBrowserInfo)
Configuration	addBrowsers(IRenderingBrowserInfo... browserInfos)
Configuration	addDeviceEmulation(DeviceName deviceName)
Configuration	addDeviceEmulation(DeviceName deviceName, ScreenOrientation orientation)
Configuration	addDeviceEmulation(DeviceName deviceName, ScreenOrientation orientation, String baselineEnvName)
Configuration	addDeviceEmulation(DeviceName deviceName, String baselineEnvName)
void	addProperty(String name, String value)
void	clearProperties()
Integer	getAbortIdleTestTimeout()
AccessibilitySettings	getAccessibilityValidation()
String	getAgentId()
String	getApiKey()
String	getAppName()
String	getBaselineBranchName()
String	getBaselineEnvName()
BatchInfo	getBatch()
String	getBranchName()
List<RenderBrowserInfo>	getBrowsersInfo()
CutProvider	getCutProvider()
IDebugResourceWriter	getDebugResourceWriter()
String	getDebugScreenshotsPath()
String	getDebugScreenshotsPrefix()
ImageMatchSettings	getDefaultMatchSettings()
String	getDeviceInfo()
Boolean	getEnablePatterns()
String	getEnvironmentName()
FailureReports	getFailureReports() Deprecated.
List<Feature>	getFeatures()
Boolean	getForceFullPageScreenshot()
Boolean	getHideCaret()
Boolean	getHideScrollbars()
String	getHostApp()
String	getHostingAppInfo()
String	getHostOS()
Boolean	getIgnoreCaret()
Boolean	getIgnoreDisplacements()
Boolean	getIsDisabled()
List<Integer>	getLayoutBreakpoints()
MatchLevel	getMatchLevel()
Integer	getMatchTimeout()
String	getOsInfo()
String	getParentBranchName()
List<PropertyData>	getProperties()
AbstractProxySettings	getProxy()
Integer	getRotation()
Boolean	getSaveDebugScreenshots()
Boolean	getSaveDiffs()
Boolean	getSaveFailedTests()
Boolean	getSaveNewTests()
Double	getScaleRatio()
URI	getServerUrl()
SessionType	getSessionType()
StitchMode	getStitchMode()
Integer	getStitchOverlap()
String	getTestName()
Boolean	getUseDom()
RectangleSize	getViewportSize()
List<VisualGridOption>	getVisualGridOptions()
Integer	getWaitBeforeScreenshots()
Boolean	isCaptureStatusBar()
Boolean	isDefaultLayoutBreakpointsSet()
Boolean	isDisableBrowserFetching()
boolean	isFeatureActivated(Feature feature)
Boolean	isForceFullPageScreenshot()
Boolean	isRenderingConfig()
Boolean	isSendDom()
Boolean	isUseCookies()
Boolean	isVisualGrid()
Configuration	setAbortIdleTestTimeout(Integer abortIdleTestTimeout)
Configuration	setAccessibilityValidation(AccessibilitySettings accessibilitySettings)
Configuration	setAgentId(String agentId)
Configuration	setApiKey(String apiKey)
Configuration	setAppName(String appName)
Configuration	setBaselineBranchName(String baselineBranchName)
Configuration	setBaselineEnvName(String baselineEnvName)
Configuration	setBatch(BatchInfo batch)
Configuration	setBranchName(String branchName)
Configuration	setBrowsersInfo(List<RenderBrowserInfo> browsersInfo)
void	setCaptureStatusBar(Boolean captureStatusBar)
Configuration	setCutProvider(CutProvider cutProvider)
Configuration	setDebugResourceWriter(IDebugResourceWriter debugResourceWriter)
Configuration	setDebugScreenshotsPath(String debugScreenshotsPath)
Configuration	setDebugScreenshotsPrefix(String debugScreenshotsPrefix)
Configuration	setDefaultMatchSettings(ImageMatchSettings defaultMatchSettings)
Configuration	setDeviceInfo(String deviceInfo)
Configuration	setDisableBrowserFetching(Boolean disableBrowserFetching)
Configuration	setEnablePatterns(Boolean enablePatterns)
Configuration	setEnvironmentName(String environmentName)
Configuration	setFailureReports(FailureReports failureReports) Deprecated.
Configuration	setFeatures(Feature feature, Feature... features) Sets features to for the Eyes test.
Configuration	setForceFullPageScreenshot(boolean forceFullPageScreenshot)
Configuration	setHideCaret(boolean hideCaret)
Configuration	setHideScrollbars(boolean hideScrollbars)
Configuration	setHostApp(String hostApp)
Configuration	setHostingAppInfo(String hostingAppInfo)
Configuration	setHostOS(String hostOS)
Configuration	setIgnoreCaret(Boolean value) Sets the ignore blinking caret value.
Configuration	setIgnoreDisplacements(Boolean isIgnoreDisplacements)
Configuration	setIsDisabled(Boolean isDisabled)
Configuration	setIsVisualGrid(Boolean isVisualGrid)
Configuration	setLayoutBreakpoints(Boolean shouldSet)
Configuration	setLayoutBreakpoints(int... breakpoints)
Configuration	setMatchLevel(MatchLevel matchLevel)
Configuration	setMatchTimeout(Integer matchTimeout)
Configuration	setOsInfo(String osInfo)
Configuration	setParentBranchName(String parentBranchName)
Configuration	setProxy(AbstractProxySettings proxy)
Configuration	setRenderingConfig(Boolean renderingConfig)
Configuration	setRotation(Integer rotation)
Configuration	setSaveDebugScreenshots(Boolean saveDebugScreenshots)
Configuration	setSaveDiffs(Boolean saveDiffs)
Configuration	setSaveFailedTests(Boolean saveFailedTests)
Configuration	setSaveNewTests(Boolean saveNewTests)
Configuration	setScaleRatio(Double scaleRatio)
Configuration	setSendDom(Boolean sendDom)
Configuration	setServerUrl(String serverUrl)
Configuration	setSessionType(SessionType sessionType)
Configuration	setStitchMode(StitchMode stitchMode)
Configuration	setStitchOverlap(Integer stitchOverlap)
Configuration	setTestName(String testName)
Configuration	setUseCookies(Boolean useCookies)
Configuration	setUseDom(Boolean useDom)
Configuration	setViewportSize(RectangleSize viewportSize)
Configuration	setVisualGridOptions(VisualGridOption option, VisualGridOption... options)
Configuration	setWaitBeforeScreenshots(int waitBeforeScreenshots)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

batch

protected BatchInfo batch

baselineEnvName

protected String baselineEnvName

appName

protected String appName

testName

protected String testName

viewportSize

protected RectangleSize viewportSize

ignoreDisplacements

protected Boolean ignoreDisplacements

defaultMatchSettings

protected ImageMatchSettings defaultMatchSettings

Constructor Detail

Configuration

public Configuration(Configuration other)

Configuration

public Configuration()

Configuration

public Configuration(RectangleSize viewportSize)

Configuration

public Configuration(String testName)

Configuration

public Configuration(String appName,
                     String testName,
                     RectangleSize viewportSize)

Method Detail

getSaveNewTests

public Boolean getSaveNewTests()

Specified by:

getSaveNewTests in interface IConfiguration

setSaveNewTests

public Configuration setSaveNewTests(Boolean saveNewTests)

Specified by:

setSaveNewTests in interface IConfiguration

getSaveFailedTests

public Boolean getSaveFailedTests()

Specified by:

getSaveFailedTests in interface IConfiguration

setSaveFailedTests

public Configuration setSaveFailedTests(Boolean saveFailedTests)

Specified by:

setSaveFailedTests in interface IConfiguration

getDefaultMatchSettings

public ImageMatchSettings getDefaultMatchSettings()

Specified by:

getDefaultMatchSettings in interface IConfiguration

setDefaultMatchSettings

public Configuration setDefaultMatchSettings(ImageMatchSettings defaultMatchSettings)

Specified by:

setDefaultMatchSettings in interface IConfiguration

getMatchTimeout

public Integer getMatchTimeout()

Specified by:

getMatchTimeout in interface IConfiguration

setMatchTimeout

public Configuration setMatchTimeout(Integer matchTimeout)

Specified by:

setMatchTimeout in interface IConfiguration

getHostApp

public String getHostApp()

Specified by:

getHostApp in interface IConfiguration

setHostApp

public Configuration setHostApp(String hostApp)

Specified by:

setHostApp in interface IConfiguration

getHostOS

public String getHostOS()

Specified by:

getHostOS in interface IConfiguration

setHostOS

public Configuration setHostOS(String hostOS)

Specified by:

setHostOS in interface IConfiguration

getStitchOverlap

public Integer getStitchOverlap()

Specified by:

getStitchOverlap in interface IConfiguration

setStitchOverlap

public Configuration setStitchOverlap(Integer stitchOverlap)

Specified by:

setStitchOverlap in interface IConfiguration

setBatch

public Configuration setBatch(BatchInfo batch)

Specified by:

setBatch in interface IConfiguration

getBatch

public BatchInfo getBatch()

Specified by:

getBatch in interface IConfiguration

setBranchName

public Configuration setBranchName(String branchName)

Specified by:

setBranchName in interface IConfiguration

getBranchName

public String getBranchName()

Specified by:

getBranchName in interface IConfiguration

getAgentId

public String getAgentId()

Specified by:

getAgentId in interface IConfiguration

setAgentId

public Configuration setAgentId(String agentId)

Specified by:

setAgentId in interface IConfiguration

getParentBranchName

public String getParentBranchName()

Specified by:

getParentBranchName in interface IConfiguration

setParentBranchName

public Configuration setParentBranchName(String parentBranchName)

Specified by:

setParentBranchName in interface IConfiguration

getBaselineBranchName

public String getBaselineBranchName()

Specified by:

getBaselineBranchName in interface IConfiguration

setBaselineBranchName

public Configuration setBaselineBranchName(String baselineBranchName)

Specified by:

setBaselineBranchName in interface IConfiguration

getBaselineEnvName

public String getBaselineEnvName()

Specified by:

getBaselineEnvName in interface IConfiguration

setBaselineEnvName

public Configuration setBaselineEnvName(String baselineEnvName)

Specified by:

setBaselineEnvName in interface IConfiguration

getEnvironmentName

public String getEnvironmentName()

Specified by:

getEnvironmentName in interface IConfiguration

setEnvironmentName

public Configuration setEnvironmentName(String environmentName)

Specified by:

setEnvironmentName in interface IConfiguration

getSaveDiffs

public Boolean getSaveDiffs()

Specified by:

getSaveDiffs in interface IConfiguration

setSaveDiffs

public Configuration setSaveDiffs(Boolean saveDiffs)

Specified by:

setSaveDiffs in interface IConfiguration

getAppName

public String getAppName()

Specified by:

getAppName in interface IConfiguration

setAppName

public Configuration setAppName(String appName)

Specified by:

setAppName in interface IConfiguration

getTestName

public String getTestName()

Specified by:

getTestName in interface IConfiguration

setTestName

public Configuration setTestName(String testName)

Specified by:

setTestName in interface IConfiguration

getViewportSize

public RectangleSize getViewportSize()

Specified by:

getViewportSize in interface IConfiguration

setViewportSize

public Configuration setViewportSize(RectangleSize viewportSize)

Specified by:

setViewportSize in interface IConfiguration

getSessionType

public SessionType getSessionType()

Specified by:

getSessionType in interface IConfiguration

setSessionType

public Configuration setSessionType(SessionType sessionType)

Specified by:

setSessionType in interface IConfiguration

setFailureReports

public Configuration setFailureReports(FailureReports failureReports)

Deprecated.

Specified by:

setFailureReports in interface IConfiguration

getFailureReports

public FailureReports getFailureReports()

Deprecated.

Specified by:

getFailureReports in interface IConfiguration

toString

public String toString()

Overrides:

toString in class Object

isSendDom

public Boolean isSendDom()

Specified by:

isSendDom in interface IConfiguration

setSendDom

public Configuration setSendDom(Boolean sendDom)

Specified by:

setSendDom in interface IConfiguration

getIgnoreCaret

public Boolean getIgnoreCaret()

Specified by:

getIgnoreCaret in interface IConfiguration

Returns:

Whether to ignore or the blinking caret or not when comparing images.

setIgnoreCaret

public Configuration setIgnoreCaret(Boolean value)

Sets the ignore blinking caret value.

Specified by:

setIgnoreCaret in interface IConfiguration

Parameters:

value - The ignore value.

getApiKey

public String getApiKey()

Specified by:

getApiKey in interface IConfiguration

setApiKey

public Configuration setApiKey(String apiKey)

Specified by:

setApiKey in interface IConfiguration

getServerUrl

public URI getServerUrl()

Specified by:

getServerUrl in interface IConfiguration

setServerUrl

public Configuration setServerUrl(String serverUrl)

Specified by:

setServerUrl in interface IConfiguration

getProxy

public AbstractProxySettings getProxy()

Specified by:

getProxy in interface IConfiguration

setProxy

public Configuration setProxy(AbstractProxySettings proxy)

Specified by:

setProxy in interface IConfiguration

getMatchLevel

public MatchLevel getMatchLevel()

Specified by:

getMatchLevel in interface IConfiguration

getIgnoreDisplacements

public Boolean getIgnoreDisplacements()

Specified by:

getIgnoreDisplacements in interface IConfiguration

setMatchLevel

public Configuration setMatchLevel(MatchLevel matchLevel)

Specified by:

setMatchLevel in interface IConfiguration

setIgnoreDisplacements

public Configuration setIgnoreDisplacements(Boolean isIgnoreDisplacements)

Specified by:

setIgnoreDisplacements in interface IConfiguration

getAccessibilityValidation

public AccessibilitySettings getAccessibilityValidation()

Specified by:

getAccessibilityValidation in interface IConfiguration

setAccessibilityValidation

public Configuration setAccessibilityValidation(AccessibilitySettings accessibilitySettings)

Specified by:

setAccessibilityValidation in interface IConfiguration

setUseDom

public Configuration setUseDom(Boolean useDom)

Specified by:

setUseDom in interface IConfiguration

getUseDom

public Boolean getUseDom()

Specified by:

getUseDom in interface IConfiguration

setEnablePatterns

public Configuration setEnablePatterns(Boolean enablePatterns)

Specified by:

setEnablePatterns in interface IConfiguration

getEnablePatterns

public Boolean getEnablePatterns()

Specified by:

getEnablePatterns in interface IConfiguration

getForceFullPageScreenshot

public Boolean getForceFullPageScreenshot()

getWaitBeforeScreenshots

public Integer getWaitBeforeScreenshots()

setWaitBeforeScreenshots

public Configuration setWaitBeforeScreenshots(int waitBeforeScreenshots)

getStitchMode

public StitchMode getStitchMode()

setStitchMode

public Configuration setStitchMode(StitchMode stitchMode)

getHideScrollbars

public Boolean getHideScrollbars()

setHideScrollbars

public Configuration setHideScrollbars(boolean hideScrollbars)

getHideCaret

public Boolean getHideCaret()

setHideCaret

public Configuration setHideCaret(boolean hideCaret)

addBrowsers

public Configuration addBrowsers(IRenderingBrowserInfo... browserInfos)

addBrowser

public Configuration addBrowser(RenderBrowserInfo renderBrowserInfo)

addBrowser

public Configuration addBrowser(DesktopBrowserInfo desktopBrowserInfo)

addBrowser

public Configuration addBrowser(ChromeEmulationInfo chromeEmulationInfo)

addBrowser

public Configuration addBrowser(IosDeviceInfo iosDeviceInfo)

addBrowser

public Configuration addBrowser(int width,
                                int height,
                                com.applitools.eyes.selenium.BrowserType browserType,
                                String baselineEnvName)

addBrowser

public Configuration addBrowser(int width,
                                int height,
                                com.applitools.eyes.selenium.BrowserType browserType)

addDeviceEmulation

public Configuration addDeviceEmulation(DeviceName deviceName,
                                        ScreenOrientation orientation)

addDeviceEmulation

public Configuration addDeviceEmulation(DeviceName deviceName)

addDeviceEmulation

public Configuration addDeviceEmulation(DeviceName deviceName,
                                        String baselineEnvName)

addDeviceEmulation

public Configuration addDeviceEmulation(DeviceName deviceName,
                                        ScreenOrientation orientation,
                                        String baselineEnvName)

getBrowsersInfo

public List<RenderBrowserInfo> getBrowsersInfo()

setBrowsersInfo

public Configuration setBrowsersInfo(List<RenderBrowserInfo> browsersInfo)

isForceFullPageScreenshot

public Boolean isForceFullPageScreenshot()

setForceFullPageScreenshot

public Configuration setForceFullPageScreenshot(boolean forceFullPageScreenshot)

isRenderingConfig

public Boolean isRenderingConfig()

setRenderingConfig

public Configuration setRenderingConfig(Boolean renderingConfig)

setIsVisualGrid

public Configuration setIsVisualGrid(Boolean isVisualGrid)

isVisualGrid

public Boolean isVisualGrid()

setFeatures

public Configuration setFeatures(Feature feature,
                                 Feature... features)

Sets features to for the Eyes test. Overrides existing features.

getFeatures

public List<Feature> getFeatures()

isFeatureActivated

public boolean isFeatureActivated(Feature feature)

setVisualGridOptions

public Configuration setVisualGridOptions(VisualGridOption option,
                                          VisualGridOption... options)

getVisualGridOptions

public List<VisualGridOption> getVisualGridOptions()

getDeviceInfo

public String getDeviceInfo()

setDeviceInfo

public Configuration setDeviceInfo(String deviceInfo)

getHostingAppInfo

public String getHostingAppInfo()

setHostingAppInfo

public Configuration setHostingAppInfo(String hostingAppInfo)

getOsInfo

public String getOsInfo()

setOsInfo

public Configuration setOsInfo(String osInfo)

isDisableBrowserFetching

public Boolean isDisableBrowserFetching()

setDisableBrowserFetching

public Configuration setDisableBrowserFetching(Boolean disableBrowserFetching)

isUseCookies

public Boolean isUseCookies()

setUseCookies

public Configuration setUseCookies(Boolean useCookies)

getDebugResourceWriter

public IDebugResourceWriter getDebugResourceWriter()

setDebugResourceWriter

public Configuration setDebugResourceWriter(IDebugResourceWriter debugResourceWriter)

getAbortIdleTestTimeout

public Integer getAbortIdleTestTimeout()

setAbortIdleTestTimeout

public Configuration setAbortIdleTestTimeout(Integer abortIdleTestTimeout)

setLayoutBreakpoints

public Configuration setLayoutBreakpoints(Boolean shouldSet)

isDefaultLayoutBreakpointsSet

public Boolean isDefaultLayoutBreakpointsSet()

setLayoutBreakpoints

public Configuration setLayoutBreakpoints(int... breakpoints)

getLayoutBreakpoints

public List<Integer> getLayoutBreakpoints()

isCaptureStatusBar

public Boolean isCaptureStatusBar()

setCaptureStatusBar

public void setCaptureStatusBar(Boolean captureStatusBar)

setSaveDebugScreenshots

public Configuration setSaveDebugScreenshots(Boolean saveDebugScreenshots)

getSaveDebugScreenshots

public Boolean getSaveDebugScreenshots()

setDebugScreenshotsPath

public Configuration setDebugScreenshotsPath(String debugScreenshotsPath)

getDebugScreenshotsPath

public String getDebugScreenshotsPath()

setDebugScreenshotsPrefix

public Configuration setDebugScreenshotsPrefix(String debugScreenshotsPrefix)

getDebugScreenshotsPrefix

public String getDebugScreenshotsPrefix()

setIsDisabled

public Configuration setIsDisabled(Boolean isDisabled)

getIsDisabled

public Boolean getIsDisabled()

addProperty

public void addProperty(String name,
                        String value)

clearProperties

public void clearProperties()

getProperties

public List<PropertyData> getProperties()

setCutProvider

public Configuration setCutProvider(CutProvider cutProvider)

getCutProvider

public CutProvider getCutProvider()

setRotation

public Configuration setRotation(Integer rotation)

getRotation

public Integer getRotation()

setScaleRatio

public Configuration setScaleRatio(Double scaleRatio)

getScaleRatio

public Double getScaleRatio()