Skip to content

Commit 2a60218

Browse files
committed
Changing interface to final class, and adding more documentation
1 parent 00801a0 commit 2a60218

File tree

1 file changed

+27
-18
lines changed

1 file changed

+27
-18
lines changed

Diff for: java/client/src/org/openqa/selenium/firefox/FirefoxDriver.java

+27-18
Original file line numberDiff line numberDiff line change
@@ -60,35 +60,44 @@
6060

6161
/**
6262
* An implementation of the {#link WebDriver} interface that drives Firefox. This works through a
63-
* firefox extension, which gets installed automatically if necessary. Important system variables
64-
* are:
65-
* <ul>
66-
* <li><b>webdriver.firefox.bin</b> - Which firefox binary to use (normally "firefox" on the PATH).</li>
67-
* <li><b>webdriver.firefox.profile</b> - The name of the profile to use (normally "WebDriver").</li>
68-
* </ul>
69-
* <p>
70-
* When the driver starts, it will make a copy of the profile it is using, rather than using that
71-
* profile directly. This allows multiple instances of firefox to be started.
63+
* firefox extension, which gets installed automatically if necessary.
7264
*/
7365
public class FirefoxDriver extends RemoteWebDriver implements Killable {
7466

75-
public interface SystemProperty {
76-
String BROWSER_BINARY = "webdriver.firefox.bin";
77-
String BROWSER_LOGFILE = "webdriver.firefox.logfile";
78-
String BROWSER_LIBRARY_PATH = "webdriver.firefox.library.path";
79-
String BROWSER_PROFILE = "webdriver.firefox.profile";
67+
public static final class SystemProperty {
68+
69+
/**
70+
* System property that defines the location of the Firefox executable file.
71+
*/
72+
public static final String BROWSER_BINARY = "webdriver.firefox.bin";
73+
74+
/**
75+
* System property that defines the location of the file where Firefox log should be stored.
76+
*/
77+
public static final String BROWSER_LOGFILE = "webdriver.firefox.logfile";
78+
79+
/**
80+
* System property that defines the additional library path (Linux only).
81+
*/
82+
public static final String BROWSER_LIBRARY_PATH = "webdriver.firefox.library.path";
83+
84+
/**
85+
* System property that defines the profile that should be used as a template.
86+
* When the driver starts, it will make a copy of the profile it is using,
87+
* rather than using that profile directly.
88+
*/
89+
public static final String BROWSER_PROFILE = "webdriver.firefox.profile";
8090

8191
/**
8292
* System property that defines the location of the webdriver.xpi browser extension to install
83-
* in the browser. If not set, the prebuilt extension bundled with this class will be used
84-
* instead.
93+
* in the browser. If not set, the prebuilt extension bundled with this class will be used.
8594
*/
86-
String DRIVER_XPI_PROPERTY = "webdriver.firefox.driver";
95+
public static final String DRIVER_XPI_PROPERTY = "webdriver.firefox.driver";
8796

8897
/**
8998
* Boolean system property that instructs FirefoxDriver to use Marionette backend.
9099
*/
91-
String DRIVER_USE_MARIONETTE = "webdriver.firefox.marionette";
100+
public static final String DRIVER_USE_MARIONETTE = "webdriver.firefox.marionette";
92101
}
93102

94103
public static final String BINARY = "firefox_binary";

0 commit comments

Comments
 (0)