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

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	addCapabilities(org.openqa.selenium.Capabilities capabilities)
FirefoxOptions	addDesiredCapabilities(org.openqa.selenium.Capabilities desiredCapabilities) Deprecated. Use addCapabilities(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)
FirefoxOptions	addRequiredCapabilities(org.openqa.selenium.Capabilities requiredCapabilities) Deprecated. Use addCapabilities(Capabilities)
org.openqa.selenium.remote.DesiredCapabilities	addTo(org.openqa.selenium.remote.DesiredCapabilities capabilities)
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	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)
org.openqa.selenium.Capabilities	toCapabilities()
org.openqa.selenium.Capabilities	toDesiredCapabilities() Deprecated. Use toCapabilities().
com.google.gson.JsonObject	toJson()
org.openqa.selenium.Capabilities	toRequiredCapabilities() Deprecated. Use toCapabilities().
java.lang.String	toString()

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

Constructor Detail

FirefoxOptions

public FirefoxOptions()

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

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

addDesiredCapabilities

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

Deprecated. Use addCapabilities(Capabilities)

addRequiredCapabilities

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

Deprecated. Use addCapabilities(Capabilities)

addCapabilities

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

toDesiredCapabilities

public org.openqa.selenium.Capabilities toDesiredCapabilities()

Deprecated. Use toCapabilities().

toRequiredCapabilities

public org.openqa.selenium.Capabilities toRequiredCapabilities()

Deprecated. Use toCapabilities().

toCapabilities

public org.openqa.selenium.Capabilities toCapabilities()

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object