org.openqa.selenium.safari

Class SafariOptions

java.lang.Object

org.openqa.selenium.MutableCapabilities

org.openqa.selenium.safari.SafariOptions

All Implemented Interfaces:

java.io.Serializable, org.openqa.selenium.Capabilities

public class SafariOptions
extends org.openqa.selenium.MutableCapabilities

Class to manage options specific to SafariDriver.

Example usage:

 SafariOptions options = new SafariOptions()
 options.setUseTechnologyPreview(true);

 // For use with SafariDriver:
 SafariDriver driver = new SafariDriver(options);

 // For use with RemoteWebDriver:
 RemoteWebDriver driver = new RemoteWebDriver(
     new URL("http://localhost:4444/wd/hub"),
     options);
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPABILITY Deprecated. No replacement. Use the methods on this class

Constructor Summary

Constructors

Constructor and Description
SafariOptions()
SafariOptions(org.openqa.selenium.Capabilities source)

Method Summary

Modifier and Type	Method and Description
protected int	amendHashCode()
java.util.Map<java.lang.String,java.lang.Object>	asMap()
static SafariOptions	fromCapabilities(org.openqa.selenium.Capabilities capabilities) Construct a SafariOptions instance from given capabilites.
boolean	getAutomaticInspection()
boolean	getAutomaticProfiling()
boolean	getUseTechnologyPreview()
SafariOptions	merge(org.openqa.selenium.Capabilities extraCapabilities)
SafariOptions	setAutomaticInspection(boolean automaticInspection) Instruct the SafariDriver to enable the Automatic Inspection if true, otherwise disable the automatic inspection.
SafariOptions	setAutomaticProfiling(boolean automaticProfiling) Instruct the SafariDriver to enable the Automatic profiling if true, otherwise disable the automatic profiling.
void	setCapability(java.lang.String key, boolean value)
void	setCapability(java.lang.String key, java.lang.Object value)
SafariOptions	setProxy(org.openqa.selenium.Proxy proxy)
SafariOptions	setUseTechnologyPreview(boolean useTechnologyPreview) Instruct the SafariDriver to use the Safari Technology Preview if true, otherwise use the release version of Safari.

Methods inherited from class org.openqa.selenium.MutableCapabilities

setCapability, setCapability

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openqa.selenium.Capabilities

getBrowserName, getVersion, is, isJavascriptEnabled

Field Detail

CAPABILITY

@Deprecated
public static final java.lang.String CAPABILITY

Deprecated. No replacement. Use the methods on this class

Key used to store SafariOptions in a Capabilities object.

See Also:

Constant Field Values

Constructor Detail

SafariOptions

public SafariOptions()

SafariOptions

public SafariOptions(org.openqa.selenium.Capabilities source)

Method Detail

merge

public SafariOptions merge(org.openqa.selenium.Capabilities extraCapabilities)

Specified by:

merge in interface org.openqa.selenium.Capabilities

Overrides:

merge in class org.openqa.selenium.MutableCapabilities

fromCapabilities

public static SafariOptions fromCapabilities(org.openqa.selenium.Capabilities capabilities)
                                      throws org.openqa.selenium.WebDriverException

Construct a SafariOptions instance from given capabilites. When the CAPABILITY capability is set, all other capabilities will be ignored!

Parameters:

capabilities - Desired capabilities from which the options are derived.

Returns:

SafariOptions

Throws:

org.openqa.selenium.WebDriverException - If an error occurred during the reconstruction of the options

setAutomaticInspection

public SafariOptions setAutomaticInspection(boolean automaticInspection)

Instruct the SafariDriver to enable the Automatic Inspection if true, otherwise disable the automatic inspection. Defaults to disabling the automatic inspection.

Parameters:

automaticInspection - If true, the SafariDriver will enable the Automation Inspection, otherwise will disable.

setAutomaticProfiling

public SafariOptions setAutomaticProfiling(boolean automaticProfiling)

Instruct the SafariDriver to enable the Automatic profiling if true, otherwise disable the automatic profiling. Defaults to disabling the automatic profiling.

Parameters:

automaticProfiling - If true, the SafariDriver will enable the Automation Profiling, otherwise will disable.

setUseTechnologyPreview

public SafariOptions setUseTechnologyPreview(boolean useTechnologyPreview)

Instruct the SafariDriver to use the Safari Technology Preview if true, otherwise use the release version of Safari. Defaults to using the release version of Safari.

Parameters:

useTechnologyPreview - If true, the SafariDriver will use the Safari Technology Preview, otherwise will use the release version of Safari.

setCapability

public void setCapability(java.lang.String key,
                          java.lang.Object value)

Overrides:

setCapability in class org.openqa.selenium.MutableCapabilities

setCapability

public void setCapability(java.lang.String key,
                          boolean value)

Overrides:

setCapability in class org.openqa.selenium.MutableCapabilities

setProxy

public SafariOptions setProxy(org.openqa.selenium.Proxy proxy)

getAutomaticInspection

public boolean getAutomaticInspection()

getAutomaticProfiling

public boolean getAutomaticProfiling()

getUseTechnologyPreview

public boolean getUseTechnologyPreview()

amendHashCode

protected int amendHashCode()

asMap

public java.util.Map<java.lang.String,java.lang.Object> asMap()

Specified by:

asMap in interface org.openqa.selenium.Capabilities

Overrides:

asMap in class org.openqa.selenium.MutableCapabilities