Package org.openqa.selenium.firefox

Class FirefoxOptions

java.lang.Object

org.openqa.selenium.MutableCapabilities

org.openqa.selenium.remote.AbstractDriverOptions<FirefoxOptions>

org.openqa.selenium.firefox.FirefoxOptions

All Implemented Interfaces:

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

public class FirefoxOptions
extends org.openqa.selenium.remote.AbstractDriverOptions<FirefoxOptions>

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	Description
static java.lang.String	FIREFOX_OPTIONS

Constructor Summary

Constructors

Constructor	Description
FirefoxOptions()
FirefoxOptions(org.openqa.selenium.Capabilities source)

Method Summary

Modifier and Type	Method	Description
FirefoxOptions	addArguments(java.lang.String... arguments)
FirefoxOptions	addArguments(java.util.List<java.lang.String> arguments)
FirefoxOptions	addPreference(java.lang.String key, java.lang.Object value)
protected int	amendHashCode()
java.util.Map<java.lang.String,java.lang.Object>	asMap()
boolean	equals(java.lang.Object arg0)
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()
java.lang.Object	getCapability(java.lang.String arg0)
java.util.Set<java.lang.String>	getCapabilityNames()
org.openqa.selenium.Platform	getPlatform()
FirefoxProfile	getProfile()
int	hashCode()
boolean	isLegacy()
FirefoxOptions	merge(org.openqa.selenium.Capabilities capabilities)
FirefoxOptions	setBinary(java.lang.String path)
FirefoxOptions	setBinary(java.nio.file.Path path)
FirefoxOptions	setBinary(FirefoxBinary binary)
void	setCapability(java.lang.String key, java.lang.Object value)
FirefoxOptions	setHeadless(boolean headless)
FirefoxOptions	setLegacy(boolean legacy)
FirefoxOptions	setLogLevel(FirefoxDriverLogLevel logLevel)
FirefoxOptions	setProfile(FirefoxProfile profile)
java.util.Map<java.lang.String,java.lang.Object>	toJson()
java.lang.String	toString()

Methods inherited from class org.openqa.selenium.remote.AbstractDriverOptions

setAcceptInsecureCerts, setPageLoadStrategy, setProxy, setStrictFileInteractability, setUnhandledPromptBehaviour

Methods inherited from class org.openqa.selenium.MutableCapabilities

setCapability, 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

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(org.openqa.selenium.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,
                                    java.lang.Object value)

setLogLevel

public FirefoxOptions setLogLevel(FirefoxDriverLogLevel logLevel)

setHeadless

public FirefoxOptions setHeadless(boolean headless)

setCapability

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

Overrides:

setCapability in class org.openqa.selenium.MutableCapabilities

asMap

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

Specified by:

asMap in interface org.openqa.selenium.Capabilities

merge

public FirefoxOptions merge(org.openqa.selenium.Capabilities capabilities)

Specified by:

merge in interface org.openqa.selenium.Capabilities

Overrides:

merge in class org.openqa.selenium.MutableCapabilities

amendHashCode

protected int amendHashCode()

getPlatform

public org.openqa.selenium.Platform getPlatform()

Specified by:

getPlatform in interface org.openqa.selenium.Capabilities

getCapability

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

Specified by:

getCapability in interface org.openqa.selenium.Capabilities

getCapabilityNames

public java.util.Set<java.lang.String> getCapabilityNames()

Specified by:

getCapabilityNames in interface org.openqa.selenium.Capabilities

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 arg0)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object