org.openqa.selenium.safari

Class SafariOptions

java.lang.Object

org.openqa.selenium.MutableCapabilities

org.openqa.selenium.safari.SafariOptions

All Implemented Interfaces:

java.io.Serializable, Capabilities

public class SafariOptions
extends MutableCapabilities

Class to manage options specific to SafariDriver.

Example usage:

 SafariOptions options = new SafariOptions()
 options.setUseCleanSession(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 Key used to store SafariOptions in a Capabilities object.

Constructor Summary

Constructors

Constructor and Description
SafariOptions()
SafariOptions(Capabilities source)

Method Summary

Modifier and Type	Method and Description
protected int	amendHashCode() Subclasses can use this to add information that isn't always in the capabilities map.
java.util.Map<java.lang.String,java.lang.Object>	asMap()
boolean	equals(java.lang.Object o)
static SafariOptions	fromCapabilities(Capabilities capabilities) Construct a SafariOptions instance from given capabilites.
java.lang.Object	getCapability(java.lang.String capabilityName)
Platform	getPlatform()
boolean	getUseTechnologyPreview()
int	hashCode()
SafariOptions	merge(Capabilities extraCapabilities) Merges the extra capabilities provided into this DesiredCapabilities instance.
void	setCapability(java.lang.String key, boolean value)
void	setCapability(java.lang.String key, java.lang.Object value)
SafariOptions	setProxy(Proxy proxy)
SafariOptions	setUseTechnologyPreview(boolean useTechnologyPreview) Instruct the SafariDriver to use the Safari Technology Preview if true, otherwise use the release version of Safari.
java.util.Map<java.lang.String,java.lang.Object>	toJson()
java.lang.String	toString()
SafariOptions	useCleanSession(boolean useCleanSession) Deprecated. SafariDriver always runs a clean session

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

public static final java.lang.String CAPABILITY

Key used to store SafariOptions in a Capabilities object.

See Also:

Constant Field Values

Constructor Detail

SafariOptions

public SafariOptions()

SafariOptions

public SafariOptions(Capabilities source)

Method Detail

merge

public SafariOptions merge(Capabilities extraCapabilities)

Description copied from class: MutableCapabilities

Merges the extra capabilities provided into this DesiredCapabilities instance. If capabilities with the same name exist in this instance, they will be overridden by the values from the extraCapabilities object.

Specified by:

merge in interface Capabilities

Overrides:

merge in class MutableCapabilities

Parameters:

extraCapabilities - Additional capabilities to be added.

Returns:

DesiredCapabilities after the merge

fromCapabilities

public static SafariOptions fromCapabilities(Capabilities capabilities)
                                      throws 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:

WebDriverException - If an error occurred during the reconstruction of the options

useCleanSession

@Deprecated
public SafariOptions useCleanSession(boolean useCleanSession)

Deprecated. SafariDriver always runs a clean session

Instruct the SafariDriver to delete all existing session data when starting a new session. This includes browser history, cache, cookies, HTML5 local storage, and HTML5 databases.

Warning: Since Safari uses a single profile for the current user, enabling this capability will permanently erase any existing session data.

Parameters:

useCleanSession - If true, the SafariDriver will erase all existing session data.

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 MutableCapabilities

setCapability

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

Overrides:

setCapability in class MutableCapabilities

setProxy

public SafariOptions setProxy(Proxy proxy)

getUseTechnologyPreview

public boolean getUseTechnologyPreview()

amendHashCode

protected int amendHashCode()

Subclasses can use this to add information that isn't always in the capabilities map.

asMap

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

Specified by:

asMap in interface Capabilities

Returns:

The capabilities as a Map

getPlatform

public Platform getPlatform()

Specified by:

getPlatform in interface Capabilities

getCapability

public java.lang.Object getCapability(java.lang.String capabilityName)

Specified by:

getCapability in interface Capabilities

Parameters:

capabilityName - The capability to return.

Returns:

The value, or null if not set.

See Also:

CapabilityType

toJson

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object