org.openqa.selenium.firefox

Class FirefoxOptions

java.lang.Object

org.openqa.selenium.firefox.FirefoxOptions

public class FirefoxOptions
extends java.lang.Object

Manage firefox specific settings in a way that geckodriver can understand. Use addTo(DesiredCapabilities) to also add settings to a DesiredCapabilities object.

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

Field Summary

Fields

Modifier and Type	Field and Description
private FirefoxBinary	actualBinary
private java.util.List<java.lang.String>	args
private java.lang.String	binaryPath
private java.util.Map<java.lang.String,java.lang.Boolean>	booleanPrefs
private org.openqa.selenium.remote.DesiredCapabilities	desiredCapabilities
static java.lang.String	FIREFOX_OPTIONS
private java.util.Map<java.lang.String,java.lang.Integer>	intPrefs
private java.lang.Boolean	legacy
private static java.util.logging.Logger	LOG
private java.util.logging.Level	logLevel
private FirefoxProfile	profile
private org.openqa.selenium.remote.DesiredCapabilities	requiredCapabilities
private java.util.Map<java.lang.String,java.lang.String>	stringPrefs

Constructor Summary

Constructors

Constructor and Description
FirefoxOptions()

Method Summary

Modifier and Type	Method and Description
FirefoxOptions	addArguments(java.util.List<java.lang.String> arguments)
FirefoxOptions	addArguments(java.lang.String... arguments)
FirefoxOptions	addDesiredCapabilities(org.openqa.selenium.Capabilities desiredCapabilities)
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)
FirefoxOptions	addRequiredCapabilities(org.openqa.selenium.Capabilities requiredCapabilities)
org.openqa.selenium.remote.DesiredCapabilities	addTo(org.openqa.selenium.remote.DesiredCapabilities capabilities)
private java.lang.String	asUnixPath(java.nio.file.Path path)
private java.util.Optional<FirefoxBinary>	determineBinaryFromCapabilities(org.openqa.selenium.Capabilities caps)
private FirefoxProfile	extractProfile(org.openqa.selenium.Capabilities capabilities)
(package private) static FirefoxOptions	fromJsonMap(java.util.Map<java.lang.String,java.lang.Object> map) INTERNAL ONLY: DO NOT USE
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()
private static <T> T	getOption(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.String key, java.lang.Class<T> type)
FirefoxProfile	getProfile()
boolean	isLegacy()
private java.lang.String	logLevelToGeckoLevel()
private static void	populateProfile(FirefoxProfile profile, org.openqa.selenium.Capabilities capabilities)
FirefoxOptions	setBinary(FirefoxBinary binary)
FirefoxOptions	setBinary(java.nio.file.Path path)
FirefoxOptions	setBinary(java.lang.String path)
FirefoxOptions	setLegacy(boolean legacy)
FirefoxOptions	setLogLevel(java.util.logging.Level logLevel)
FirefoxOptions	setProfile(FirefoxProfile profile)
private org.openqa.selenium.Capabilities	toCapabilities(org.openqa.selenium.Capabilities source)
org.openqa.selenium.Capabilities	toDesiredCapabilities()
com.google.gson.JsonObject	toJson()
org.openqa.selenium.Capabilities	toRequiredCapabilities()
java.lang.String	toString()
private FirefoxOptions	validateAndAmendUsing(org.openqa.selenium.remote.DesiredCapabilities existing, org.openqa.selenium.Capabilities caps)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FIREFOX_OPTIONS

public static final java.lang.String FIREFOX_OPTIONS

See Also:

Constant Field Values

LOG

private static final java.util.logging.Logger LOG

binaryPath

private java.lang.String binaryPath

actualBinary

private FirefoxBinary actualBinary

profile

private FirefoxProfile profile

args

private java.util.List<java.lang.String> args

booleanPrefs

private java.util.Map<java.lang.String,java.lang.Boolean> booleanPrefs

intPrefs

private java.util.Map<java.lang.String,java.lang.Integer> intPrefs

stringPrefs

private java.util.Map<java.lang.String,java.lang.String> stringPrefs

logLevel

private java.util.logging.Level logLevel

legacy

private java.lang.Boolean legacy

desiredCapabilities

private org.openqa.selenium.remote.DesiredCapabilities desiredCapabilities

requiredCapabilities

private org.openqa.selenium.remote.DesiredCapabilities requiredCapabilities

Constructor Detail

FirefoxOptions

public FirefoxOptions()

Method Detail

fromJsonMap

static FirefoxOptions fromJsonMap(java.util.Map<java.lang.String,java.lang.Object> map)
                           throws java.io.IOException

INTERNAL ONLY: DO NOT USE

Throws:

java.io.IOException

getOption

private static <T> T getOption(java.util.Map<java.lang.String,java.lang.Object> map,
                               java.lang.String key,
                               java.lang.Class<T> type)

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)

asUnixPath

private java.lang.String asUnixPath(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()

determineBinaryFromCapabilities

private java.util.Optional<FirefoxBinary> determineBinaryFromCapabilities(org.openqa.selenium.Capabilities caps)

setProfile

public FirefoxOptions setProfile(FirefoxProfile profile)

getProfile

public FirefoxProfile getProfile()

populateProfile

private static void populateProfile(FirefoxProfile profile,
                                    org.openqa.selenium.Capabilities capabilities)

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

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

addDesiredCapabilities

public FirefoxOptions addDesiredCapabilities(org.openqa.selenium.Capabilities desiredCapabilities)

addRequiredCapabilities

public FirefoxOptions addRequiredCapabilities(org.openqa.selenium.Capabilities requiredCapabilities)

validateAndAmendUsing

private FirefoxOptions validateAndAmendUsing(org.openqa.selenium.remote.DesiredCapabilities existing,
                                             org.openqa.selenium.Capabilities caps)

extractProfile

private FirefoxProfile extractProfile(org.openqa.selenium.Capabilities capabilities)

toDesiredCapabilities

public org.openqa.selenium.Capabilities toDesiredCapabilities()

toRequiredCapabilities

public org.openqa.selenium.Capabilities toRequiredCapabilities()

toCapabilities

private org.openqa.selenium.Capabilities toCapabilities(org.openqa.selenium.Capabilities source)

addTo

public org.openqa.selenium.remote.DesiredCapabilities addTo(org.openqa.selenium.remote.DesiredCapabilities capabilities)

toJson

public com.google.gson.JsonObject toJson()
                                  throws java.io.IOException

Throws:

java.io.IOException

logLevelToGeckoLevel

private java.lang.String logLevelToGeckoLevel()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object