org.openqa.selenium.firefox

Class FirefoxOptions

java.lang.Object

org.openqa.selenium.MutableCapabilities

org.openqa.selenium.firefox.FirefoxOptions

All Implemented Interfaces:

java.io.Serializable, Capabilities

public class FirefoxOptions
extends MutableCapabilities

Manage firefox specific settings in a way that geckodriver can understand.

An example of usage:

    FirefoxOptions options = new FirefoxOptions()
      .addPreference("browser.startup.page", 1)
      .addPreference("browser.startup.homepage", "https://www.google.co.uk");
    WebDriver driver = new FirefoxDriver(options);
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIREFOX_OPTIONS

Constructor Summary

Constructors

Constructor and Description
FirefoxOptions()
FirefoxOptions(Capabilities source)

Method Summary

Modifier and Type	Method and Description
FirefoxOptions	addArguments(java.util.List<java.lang.String> arguments)
FirefoxOptions	addArguments(java.lang.String... arguments)
FirefoxOptions	addCapabilities(Capabilities capabilities) Deprecated. Use merge(Capabilities).
FirefoxOptions	addPreference(java.lang.String key, boolean value)
FirefoxOptions	addPreference(java.lang.String key, int value)
FirefoxOptions	addPreference(java.lang.String key, java.lang.String value)
DesiredCapabilities	addTo(DesiredCapabilities capabilities) Deprecated. Use MutableCapabilities.merge(Capabilities).
protected int	amendHashCode() Subclasses can use this to add information that isn't always in the capabilities map.
java.util.Map<java.lang.String,?>	asMap()
FirefoxBinary	getBinary() Constructs a FirefoxBinary and returns that to be used, and because of this is only useful when actually starting firefox.
java.util.Optional<FirefoxBinary>	getBinaryOrNull()
FirefoxProfile	getProfile()
boolean	isLegacy()
FirefoxOptions	merge(Capabilities capabilities) Merges the extra capabilities provided into this DesiredCapabilities instance.
FirefoxOptions	setAcceptInsecureCerts(boolean acceptInsecureCerts)
FirefoxOptions	setBinary(FirefoxBinary binary)
FirefoxOptions	setBinary(java.nio.file.Path path)
FirefoxOptions	setBinary(java.lang.String path)
void	setCapability(java.lang.String key, java.lang.Object value)
FirefoxOptions	setHeadless(boolean headless)
FirefoxOptions	setLegacy(boolean legacy)
FirefoxOptions	setLogLevel(FirefoxDriverLogLevel logLevel)
FirefoxOptions	setLogLevel(java.util.logging.Level logLevel) Deprecated. Use setLogLevel(FirefoxDriverLogLevel)
FirefoxOptions	setPageLoadStrategy(PageLoadStrategy strategy)
FirefoxOptions	setProfile(FirefoxProfile profile)
FirefoxOptions	setUnhandledPromptBehaviour(UnexpectedAlertBehaviour behaviour)
Capabilities	toCapabilities() Deprecated. No replacement. We are already Capabilities.

Methods inherited from class org.openqa.selenium.MutableCapabilities

equals, getCapability, hashCode, setCapability, setCapability, setCapability, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openqa.selenium.Capabilities

getBrowserName, getPlatform, getVersion, is, isJavascriptEnabled

Field Detail

FIREFOX_OPTIONS

public static final java.lang.String FIREFOX_OPTIONS

See Also:

Constant Field Values

Constructor Detail

FirefoxOptions

public FirefoxOptions()

FirefoxOptions

public FirefoxOptions(Capabilities source)

Method Detail

setLegacy

public FirefoxOptions setLegacy(boolean legacy)

isLegacy

public boolean isLegacy()

setBinary

public FirefoxOptions setBinary(FirefoxBinary binary)

setBinary

public FirefoxOptions setBinary(java.nio.file.Path path)

setBinary

public FirefoxOptions setBinary(java.lang.String path)

getBinary

public FirefoxBinary getBinary()

Constructs a FirefoxBinary and returns that to be used, and because of this is only useful when actually starting firefox.

getBinaryOrNull

public java.util.Optional<FirefoxBinary> getBinaryOrNull()

setProfile

public FirefoxOptions setProfile(FirefoxProfile profile)

getProfile

public FirefoxProfile getProfile()

addArguments

public FirefoxOptions addArguments(java.lang.String... arguments)

addArguments

public FirefoxOptions addArguments(java.util.List<java.lang.String> arguments)

addPreference

public FirefoxOptions addPreference(java.lang.String key,
                                    boolean value)

addPreference

public FirefoxOptions addPreference(java.lang.String key,
                                    int value)

addPreference

public FirefoxOptions addPreference(java.lang.String key,
                                    java.lang.String value)

setLogLevel

@Deprecated
public FirefoxOptions setLogLevel(java.util.logging.Level logLevel)

Deprecated. Use setLogLevel(FirefoxDriverLogLevel)

setLogLevel

public FirefoxOptions setLogLevel(FirefoxDriverLogLevel logLevel)

setPageLoadStrategy

public FirefoxOptions setPageLoadStrategy(PageLoadStrategy strategy)

setUnhandledPromptBehaviour

public FirefoxOptions setUnhandledPromptBehaviour(UnexpectedAlertBehaviour behaviour)

setAcceptInsecureCerts

public FirefoxOptions setAcceptInsecureCerts(boolean acceptInsecureCerts)

setHeadless

public FirefoxOptions setHeadless(boolean headless)

setCapability

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

Overrides:

setCapability in class MutableCapabilities

asMap

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

Specified by:

asMap in interface Capabilities

Overrides:

asMap in class MutableCapabilities

Returns:

The capabilities as a Map

addCapabilities

@Deprecated
public FirefoxOptions addCapabilities(Capabilities capabilities)

Deprecated. Use merge(Capabilities).

merge

public FirefoxOptions merge(Capabilities capabilities)

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:

capabilities - Additional capabilities to be added.

Returns:

DesiredCapabilities after the merge

toCapabilities

@Deprecated
public Capabilities toCapabilities()

Deprecated. No replacement. We are already Capabilities.

addTo

@Deprecated
public DesiredCapabilities addTo(DesiredCapabilities capabilities)

Deprecated. Use MutableCapabilities.merge(Capabilities).

amendHashCode

protected int amendHashCode()

Description copied from class: MutableCapabilities

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

Overrides:

amendHashCode in class MutableCapabilities

Returns: