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

public class FirefoxOptions
extends 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(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)
FirefoxOptions	configureFromEnv()	Configures the following: Binary webdriver.firefox.bin - the path to the firefox binary Firefox profile webdriver.firefox.profile - a named firefox profile
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()
protected java.lang.Object	getExtraCapability(java.lang.String capabilityName)
protected java.util.Set<java.lang.String>	getExtraCapabilityNames()
FirefoxProfile	getProfile()
FirefoxOptions	merge(Capabilities capabilities)	Merge two Capabilities together and return the union of the two as a new Capabilities instance.
FirefoxOptions	setAndroidActivity(java.lang.String activity)
FirefoxOptions	setAndroidDeviceSerialNumber(java.lang.String serial)
FirefoxOptions	setAndroidIntentArguments(java.lang.String[] args)
FirefoxOptions	setAndroidIntentArguments(java.util.List<java.lang.String> args)
FirefoxOptions	setAndroidPackage(java.lang.String androidPackage)
FirefoxOptions	setBinary(java.lang.String path)
FirefoxOptions	setBinary(java.nio.file.Path path)
FirefoxOptions	setBinary(FirefoxBinary binary)
FirefoxOptions	setHeadless(boolean headless)	Deprecated. Use addArguments(String...).
FirefoxOptions	setLogLevel(FirefoxDriverLogLevel logLevel)
FirefoxOptions	setProfile(FirefoxProfile profile)

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

asMap, getCapability, getCapabilityNames, setAcceptInsecureCerts, setBrowserVersion, setImplicitWaitTimeout, setPageLoadStrategy, setPageLoadTimeout, setPlatformName, setProxy, setScriptTimeout, setStrictFileInteractability, setUnhandledPromptBehaviour

Methods inherited from class org.openqa.selenium.MutableCapabilities

equals, hashCode, setCapability, setCapability, setCapability, setCapability, toJson, 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, getBrowserVersion, getPlatformName, 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(Capabilities source)

Method Detail

configureFromEnv

public FirefoxOptions configureFromEnv()

Configures the following:

Binary

webdriver.firefox.bin - the path to the firefox binary

Firefox profile

webdriver.firefox.profile - a named firefox profile

getBinary

public FirefoxBinary getBinary()

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

setBinary

public FirefoxOptions setBinary(FirefoxBinary binary)

setBinary

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

setBinary

public FirefoxOptions setBinary(java.lang.String path)

getBinaryOrNull

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

getProfile

public FirefoxProfile getProfile()

setProfile

public FirefoxOptions setProfile(FirefoxProfile profile)

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

@Deprecated
public FirefoxOptions setHeadless(boolean headless)

Deprecated.

Use addArguments(String...). Example: `addArguments("-headless")`.

setAndroidPackage

public FirefoxOptions setAndroidPackage(java.lang.String androidPackage)

setAndroidActivity

public FirefoxOptions setAndroidActivity(java.lang.String activity)

setAndroidDeviceSerialNumber

public FirefoxOptions setAndroidDeviceSerialNumber(java.lang.String serial)

setAndroidIntentArguments

public FirefoxOptions setAndroidIntentArguments(java.lang.String[] args)

setAndroidIntentArguments

public FirefoxOptions setAndroidIntentArguments(java.util.List<java.lang.String> args)

getExtraCapabilityNames

protected java.util.Set<java.lang.String> getExtraCapabilityNames()

Specified by:

getExtraCapabilityNames in class AbstractDriverOptions<FirefoxOptions>

getExtraCapability

protected java.lang.Object getExtraCapability(java.lang.String capabilityName)

Specified by:

getExtraCapability in class AbstractDriverOptions<FirefoxOptions>

merge

public FirefoxOptions merge(Capabilities capabilities)

Description copied from class: MutableCapabilities

Merge two Capabilities together and return the union of the two as a new Capabilities instance. Capabilities from other will override those in this.

Specified by:

merge in interface Capabilities

Overrides:

merge in class MutableCapabilities