Package 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 Description protected String
appName
protected String
baselineEnvName
protected BatchInfo
batch
protected ImageMatchSettings
defaultMatchSettings
protected Boolean
ignoreDisplacements
protected String
testName
protected com.applitools.eyes.RectangleSize
viewportSize
-
Constructor Summary
Constructors Constructor Description Configuration()
Configuration(Configuration other)
Configuration(com.applitools.eyes.RectangleSize viewportSize)
Configuration(String testName)
Configuration(String appName, String testName, com.applitools.eyes.RectangleSize viewportSize)
-
Method Summary
-
-
-
Field Detail
-
batch
protected BatchInfo batch
-
baselineEnvName
protected String baselineEnvName
-
appName
protected String appName
-
testName
protected String testName
-
viewportSize
protected com.applitools.eyes.RectangleSize viewportSize
-
ignoreDisplacements
protected Boolean ignoreDisplacements
-
defaultMatchSettings
protected ImageMatchSettings defaultMatchSettings
-
-
Constructor Detail
-
Configuration
public Configuration(Configuration other)
-
Configuration
public Configuration()
-
Configuration
public Configuration(com.applitools.eyes.RectangleSize viewportSize)
-
Configuration
public Configuration(String testName)
-
-
Method Detail
-
getSaveNewTests
public Boolean getSaveNewTests()
- Specified by:
getSaveNewTests
in interfaceIConfiguration
-
setSaveNewTests
public Configuration setSaveNewTests(Boolean saveNewTests)
- Specified by:
setSaveNewTests
in interfaceIConfiguration
-
getSaveFailedTests
public Boolean getSaveFailedTests()
- Specified by:
getSaveFailedTests
in interfaceIConfiguration
-
setSaveFailedTests
public Configuration setSaveFailedTests(Boolean saveFailedTests)
- Specified by:
setSaveFailedTests
in interfaceIConfiguration
-
getDefaultMatchSettings
public ImageMatchSettings getDefaultMatchSettings()
- Specified by:
getDefaultMatchSettings
in interfaceIConfiguration
-
setDefaultMatchSettings
public Configuration setDefaultMatchSettings(ImageMatchSettings defaultMatchSettings)
- Specified by:
setDefaultMatchSettings
in interfaceIConfiguration
-
getMatchTimeout
public Integer getMatchTimeout()
- Specified by:
getMatchTimeout
in interfaceIConfiguration
-
setMatchTimeout
public Configuration setMatchTimeout(Integer matchTimeout)
- Specified by:
setMatchTimeout
in interfaceIConfiguration
-
getHostApp
public String getHostApp()
- Specified by:
getHostApp
in interfaceIConfiguration
-
setHostApp
public Configuration setHostApp(String hostApp)
- Specified by:
setHostApp
in interfaceIConfiguration
-
getHostOS
public String getHostOS()
- Specified by:
getHostOS
in interfaceIConfiguration
-
setHostOS
public Configuration setHostOS(String hostOS)
- Specified by:
setHostOS
in interfaceIConfiguration
-
getStitchOverlap
public Integer getStitchOverlap()
- Specified by:
getStitchOverlap
in interfaceIConfiguration
-
getOverlap
public StitchOverlap getOverlap()
- Specified by:
getOverlap
in interfaceIConfiguration
-
setStitchOverlap
public Configuration setStitchOverlap(Integer stitchOverlap)
- Specified by:
setStitchOverlap
in interfaceIConfiguration
-
setStitchOverlap
public Configuration setStitchOverlap(StitchOverlap stitchOverlap)
- Specified by:
setStitchOverlap
in interfaceIConfiguration
-
setBatch
public Configuration setBatch(BatchInfo batch)
- Specified by:
setBatch
in interfaceIConfiguration
-
getBatch
public BatchInfo getBatch()
- Specified by:
getBatch
in interfaceIConfiguration
-
setBranchName
public Configuration setBranchName(String branchName)
- Specified by:
setBranchName
in interfaceIConfiguration
-
getBranchName
public String getBranchName()
- Specified by:
getBranchName
in interfaceIConfiguration
-
getAgentId
public String getAgentId()
- Specified by:
getAgentId
in interfaceIConfiguration
-
setAgentId
public Configuration setAgentId(String agentId)
- Specified by:
setAgentId
in interfaceIConfiguration
-
getParentBranchName
public String getParentBranchName()
- Specified by:
getParentBranchName
in interfaceIConfiguration
-
setParentBranchName
public Configuration setParentBranchName(String parentBranchName)
- Specified by:
setParentBranchName
in interfaceIConfiguration
-
getBaselineBranchName
public String getBaselineBranchName()
- Specified by:
getBaselineBranchName
in interfaceIConfiguration
-
setBaselineBranchName
public Configuration setBaselineBranchName(String baselineBranchName)
- Specified by:
setBaselineBranchName
in interfaceIConfiguration
-
getBaselineEnvName
public String getBaselineEnvName()
- Specified by:
getBaselineEnvName
in interfaceIConfiguration
-
setBaselineEnvName
public Configuration setBaselineEnvName(String baselineEnvName)
- Specified by:
setBaselineEnvName
in interfaceIConfiguration
-
getEnvironmentName
public String getEnvironmentName()
- Specified by:
getEnvironmentName
in interfaceIConfiguration
-
setEnvironmentName
public Configuration setEnvironmentName(String environmentName)
- Specified by:
setEnvironmentName
in interfaceIConfiguration
-
getSaveDiffs
public Boolean getSaveDiffs()
- Specified by:
getSaveDiffs
in interfaceIConfiguration
-
setSaveDiffs
public Configuration setSaveDiffs(Boolean saveDiffs)
- Specified by:
setSaveDiffs
in interfaceIConfiguration
-
getAppName
public String getAppName()
- Specified by:
getAppName
in interfaceIConfiguration
-
setAppName
public Configuration setAppName(String appName)
- Specified by:
setAppName
in interfaceIConfiguration
-
getTestName
public String getTestName()
- Specified by:
getTestName
in interfaceIConfiguration
-
setTestName
public Configuration setTestName(String testName)
- Specified by:
setTestName
in interfaceIConfiguration
-
getViewportSize
public com.applitools.eyes.RectangleSize getViewportSize()
- Specified by:
getViewportSize
in interfaceIConfiguration
-
setViewportSize
public Configuration setViewportSize(com.applitools.eyes.RectangleSize viewportSize)
- Specified by:
setViewportSize
in interfaceIConfiguration
-
getSessionType
public SessionType getSessionType()
- Specified by:
getSessionType
in interfaceIConfiguration
-
setSessionType
public Configuration setSessionType(SessionType sessionType)
- Specified by:
setSessionType
in interfaceIConfiguration
-
setFailureReports
public Configuration setFailureReports(FailureReports failureReports)
Deprecated.- Specified by:
setFailureReports
in interfaceIConfiguration
-
getFailureReports
public FailureReports getFailureReports()
Deprecated.- Specified by:
getFailureReports
in interfaceIConfiguration
-
isSendDom
public Boolean isSendDom()
- Specified by:
isSendDom
in interfaceIConfiguration
-
setSendDom
public Configuration setSendDom(Boolean sendDom)
- Specified by:
setSendDom
in interfaceIConfiguration
-
getIgnoreCaret
public Boolean getIgnoreCaret()
- Specified by:
getIgnoreCaret
in interfaceIConfiguration
- 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 interfaceIConfiguration
- Parameters:
value
- The ignore value.
-
getApiKey
public String getApiKey()
- Specified by:
getApiKey
in interfaceIConfiguration
-
setApiKey
public Configuration setApiKey(String apiKey)
- Specified by:
setApiKey
in interfaceIConfiguration
-
getServerUrl
public URI getServerUrl()
- Specified by:
getServerUrl
in interfaceIConfiguration
-
setServerUrl
public Configuration setServerUrl(String serverUrl)
- Specified by:
setServerUrl
in interfaceIConfiguration
-
getProxy
public com.applitools.eyes.AbstractProxySettings getProxy()
- Specified by:
getProxy
in interfaceIConfiguration
-
setProxy
public Configuration setProxy(com.applitools.eyes.AbstractProxySettings proxy)
- Specified by:
setProxy
in interfaceIConfiguration
-
getMatchLevel
public MatchLevel getMatchLevel()
- Specified by:
getMatchLevel
in interfaceIConfiguration
-
getIgnoreDisplacements
public Boolean getIgnoreDisplacements()
- Specified by:
getIgnoreDisplacements
in interfaceIConfiguration
-
setMatchLevel
public Configuration setMatchLevel(MatchLevel matchLevel)
- Specified by:
setMatchLevel
in interfaceIConfiguration
-
setIgnoreDisplacements
public Configuration setIgnoreDisplacements(Boolean isIgnoreDisplacements)
- Specified by:
setIgnoreDisplacements
in interfaceIConfiguration
-
getAccessibilityValidation
public AccessibilitySettings getAccessibilityValidation()
- Specified by:
getAccessibilityValidation
in interfaceIConfiguration
-
setAccessibilityValidation
public Configuration setAccessibilityValidation(AccessibilitySettings accessibilitySettings)
- Specified by:
setAccessibilityValidation
in interfaceIConfiguration
-
setUseDom
public Configuration setUseDom(Boolean useDom)
- Specified by:
setUseDom
in interfaceIConfiguration
-
getUseDom
public Boolean getUseDom()
- Specified by:
getUseDom
in interfaceIConfiguration
-
setEnablePatterns
public Configuration setEnablePatterns(Boolean enablePatterns)
- Specified by:
setEnablePatterns
in interfaceIConfiguration
-
getEnablePatterns
public Boolean getEnablePatterns()
- Specified by:
getEnablePatterns
in interfaceIConfiguration
-
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(com.applitools.eyes.visualgrid.model.IRenderingBrowserInfo... browserInfos)
-
addBrowser
public Configuration addBrowser(com.applitools.eyes.visualgrid.model.RenderBrowserInfo renderBrowserInfo)
-
addBrowser
public Configuration addBrowser(com.applitools.eyes.visualgrid.model.DesktopBrowserInfo desktopBrowserInfo)
-
addBrowser
public Configuration addBrowser(com.applitools.eyes.visualgrid.model.ChromeEmulationInfo chromeEmulationInfo)
-
addBrowser
public Configuration addBrowser(com.applitools.eyes.visualgrid.model.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)
-
addBrowser
public Configuration addBrowser(int width, int height, com.applitools.eyes.visualgrid.BrowserType browserType, String baselineEnvName)
-
addBrowser
public Configuration addBrowser(int width, int height, com.applitools.eyes.visualgrid.BrowserType browserType)
-
addDeviceEmulation
public Configuration addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName, com.applitools.eyes.visualgrid.model.ScreenOrientation orientation)
-
addDeviceEmulation
public Configuration addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName)
-
addDeviceEmulation
public Configuration addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName, String baselineEnvName)
-
addDeviceEmulation
public Configuration addDeviceEmulation(com.applitools.eyes.visualgrid.model.DeviceName deviceName, com.applitools.eyes.visualgrid.model.ScreenOrientation orientation, String baselineEnvName)
-
addMultiDeviceTarget
public Configuration addMultiDeviceTarget(com.applitools.eyes.visualgrid.model.DeviceTarget deviceTarget, com.applitools.eyes.visualgrid.model.DeviceTarget... deviceTargets)
-
getBrowsersInfo
public List<com.applitools.eyes.visualgrid.model.RenderBrowserInfo> getBrowsersInfo()
-
setBrowsersInfo
public Configuration setBrowsersInfo(List<com.applitools.eyes.visualgrid.model.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.
-
isFeatureActivated
public boolean isFeatureActivated(Feature feature)
-
setVisualGridOptions
public Configuration setVisualGridOptions(com.applitools.eyes.visualgrid.model.VisualGridOption option, com.applitools.eyes.visualgrid.model.VisualGridOption... options)
-
getVisualGridOptions
public List<com.applitools.eyes.visualgrid.model.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)
-
setGitMergeBaseTimestamp
public Configuration setGitMergeBaseTimestamp(Calendar gitMergeBaseTimestamp)
- Specified by:
setGitMergeBaseTimestamp
in interfaceIConfiguration
-
getGitMergeBaseTimestamp
public Calendar getGitMergeBaseTimestamp()
- Specified by:
getGitMergeBaseTimestamp
in interfaceIConfiguration
-
getDebugResourceWriter
public com.applitools.eyes.visualgrid.model.IDebugResourceWriter getDebugResourceWriter()
-
setDebugResourceWriter
public Configuration setDebugResourceWriter(com.applitools.eyes.visualgrid.model.IDebugResourceWriter debugResourceWriter)
-
getAbortIdleTestTimeout
public Integer getAbortIdleTestTimeout()
-
setAbortIdleTestTimeout
public Configuration setAbortIdleTestTimeout(Integer abortIdleTestTimeout)
-
setLayoutBreakpoints
public Configuration setLayoutBreakpoints(Boolean shouldSet)
-
setLayoutBreakpoints
public Configuration setLayoutBreakpoints(LayoutBreakpointsOptions layoutBreakpointsOptions)
-
isDefaultLayoutBreakpointsSet
public Boolean isDefaultLayoutBreakpointsSet()
-
setLayoutBreakpoints
public Configuration setLayoutBreakpoints(int[] breakpoints)
-
setLayoutBreakpoints
public Configuration setLayoutBreakpoints(Integer... breakpoints)
-
getLayoutBreakpointsOptions
public LayoutBreakpointsOptions getLayoutBreakpointsOptions()
-
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 Configuration 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()
-
addMobileDevice
public Configuration addMobileDevice(com.applitools.eyes.visualgrid.model.IosDeviceInfo iosDeviceInfo)
-
addMobileDevices
public Configuration addMobileDevices(com.applitools.eyes.visualgrid.model.IosDeviceInfo iosDeviceInfo, com.applitools.eyes.visualgrid.model.IosDeviceInfo... iosDeviceInfos)
-
addMobileDevice
public Configuration addMobileDevice(com.applitools.eyes.visualgrid.model.IosDeviceInfo iosDeviceInfo, String version)
-
addMobileDevice
public Configuration addMobileDevice(com.applitools.eyes.visualgrid.model.AndroidDeviceInfo androidDeviceInfo, String version)
-
addMobileDevice
public Configuration addMobileDevice(com.applitools.eyes.visualgrid.model.AndroidDeviceInfo androidDeviceInfo)
-
addMobileDevices
public Configuration addMobileDevices(com.applitools.eyes.visualgrid.model.AndroidDeviceInfo androidDeviceInfo, com.applitools.eyes.visualgrid.model.AndroidDeviceInfo... androidDeviceInfos)
-
setUseCeilForViewportSize
public Configuration setUseCeilForViewportSize(Boolean useCeilForViewportSize)
-
getUseCeilForViewportSize
public Boolean getUseCeilForViewportSize()
-
getWaitBeforeCapture
public Integer getWaitBeforeCapture()
- Returns:
- wait before capture
-
setWaitBeforeCapture
public void setWaitBeforeCapture(Integer milliSec)
- Parameters:
milliSec
- time to wait before each screenshot
-
getWebDriverProxy
public WebDriverProxySettings getWebDriverProxy()
-
setWebDriverProxy
public Configuration setWebDriverProxy(WebDriverProxySettings proxySettings)
-
setAutProxy
public Configuration setAutProxy(com.applitools.eyes.AutProxySettings autProxy)
-
getAutProxy
public com.applitools.eyes.AutProxySettings getAutProxy()
-
getContentInset
public ContentInset getContentInset()
-
setContentInset
public Configuration setContentInset(ContentInset contentInset)
-
getIgnoreGitMergeBase
public Boolean getIgnoreGitMergeBase()
- Specified by:
getIgnoreGitMergeBase
in interfaceIConfiguration
-
setIgnoreGitMergeBase
public Configuration setIgnoreGitMergeBase(Boolean ignoreGitMergeBase)
- Specified by:
setIgnoreGitMergeBase
in interfaceIConfiguration
-
-