BrowserConfigurationOptions (selenium-api 2.53.1 API)

java.lang.Object
- com.thoughtworks.selenium.BrowserConfigurationOptions

```
public class BrowserConfigurationOptions
extends Object
```
Contains parameters for a single Selenium browser session. BrowserConfigurationOptions is used as an argument to Selenium.start(). The parameters set within will override any command-line parameters set for the same option.

Author:

jbevan, chandrap

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BROWSER_EXECUTABLE_PATH`
`static String`	`BROWSER_MODE`
`static String`	`COMMAND_LINE_FLAGS`
`static int`	`DEFAULT_TIMEOUT_IN_SECONDS`
`static String`	`MULTI_WINDOW`
`static String`	`PROFILE_NAME`
`static String`	`PROXY_CONFIG`
`static String`	`SINGLE_WINDOW`
`static String`	`TIMEOUT_IN_SECONDS`

Constructor Summary

Constructors
Constructor and Description

BrowserConfigurationOptions()
Instantiate a blank BrowserConfigurationOptions instance.

Constructors
Constructor and Description
`BrowserConfigurationOptions()` Instantiate a blank BrowserConfigurationOptions instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canUse(String value)`
`String`	`get(String key)`
`protected String`	`getBrowserExecutablePath()`
`protected String`	`getBrowserMode()`
`String`	`getCommandLineFlags()`
`protected String`	`getProfile()`
`protected int`	`getTimeoutInSeconds()`
`boolean`	`hasOptions()` Returns true if any options are set in this instance.
`protected boolean`	`isMultiWindow()` Returns true if the `MULTI_WINDOW` field is set.
`boolean`	`isSet(String key)`
`protected boolean`	`isSingleWindow()` Returns true if the `SINGLE_WINDOW` field is set.
`String`	`serialize()` Serializes to the format "name=value;name=value".
`BrowserConfigurationOptions`	`set(String key, String value)` Sets the given key to the given value unless the value is null.
`BrowserConfigurationOptions`	`setBrowserExecutablePath(String executablePath)` Sets the full path for the browser executable.
`BrowserConfigurationOptions`	`setBrowserMode(String mode)` Sets the "mode" for the browser.
`BrowserConfigurationOptions`	`setCommandLineFlags(String cmdLineFlags)`
`BrowserConfigurationOptions`	`setMultiWindow()` Sets `MULTI_WINDOW` and unsets `SINGLE_WINDOW`
`BrowserConfigurationOptions`	`setProfile(String profile)` Sets the name of the profile, which must exist in the -profilesLocation directory, to use for this browser session.
`BrowserConfigurationOptions`	`setSingleWindow()` Sets `SINGLE_WINDOW` and unsets `MULTI_WINDOW`.
`BrowserConfigurationOptions`	`setTimeoutInSeconds(int timeout)` Sets the timeout, in seconds, for all commands.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PROXY_CONFIG
```
public static final String PROXY_CONFIG
```
    See Also:
    
    Constant Field Values
  - PROFILE_NAME
```
public static final String PROFILE_NAME
```
    See Also:
    
    Constant Field Values
  - SINGLE_WINDOW
```
public static final String SINGLE_WINDOW
```
    See Also:
    
    Constant Field Values
  - MULTI_WINDOW
```
public static final String MULTI_WINDOW
```
    See Also:
    
    Constant Field Values
  - BROWSER_EXECUTABLE_PATH
```
public static final String BROWSER_EXECUTABLE_PATH
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_IN_SECONDS
```
public static final String TIMEOUT_IN_SECONDS
```
    See Also:
    
    Constant Field Values
  - BROWSER_MODE
```
public static final String BROWSER_MODE
```
    See Also:
    
    Constant Field Values
  - COMMAND_LINE_FLAGS
```
public static final String COMMAND_LINE_FLAGS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMEOUT_IN_SECONDS
```
public static final int DEFAULT_TIMEOUT_IN_SECONDS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BrowserConfigurationOptions
```
public BrowserConfigurationOptions()
```
    Instantiate a blank BrowserConfigurationOptions instance.
- Method Detail
  - hasOptions
```
public boolean hasOptions()
```
    Returns true if any options are set in this instance.
    
    Returns:
    
    true if any options are set in this instance.
  - serialize
```
public String serialize()
```
    Serializes to the format "name=value;name=value".
    
    Returns:
    
    String with the above format.
  - setProfile
```
public BrowserConfigurationOptions setProfile(String profile)
```
    Sets the name of the profile, which must exist in the -profilesLocation directory, to use for this browser session.
    
    Parameters:
    
    profile - the name of the profile.
    
    Returns:
    
    this BrowserConfigurationOptions object.
  - getProfile
```
protected String getProfile()
```
  - isSingleWindow
```
protected boolean isSingleWindow()
```
    Returns true if the SINGLE_WINDOW field is set.
    
    Returns:
    
    true if SINGLE_WINDOW is set.
  - isMultiWindow
```
protected boolean isMultiWindow()
```
    Returns true if the MULTI_WINDOW field is set.
    
    Returns:
    
    true if MULTI_WINDOW is set.
  - setSingleWindow
```
public BrowserConfigurationOptions setSingleWindow()
```
    Sets SINGLE_WINDOW and unsets MULTI_WINDOW.
    
    Returns:
    
    this / self
  - setMultiWindow
```
public BrowserConfigurationOptions setMultiWindow()
```
    Sets MULTI_WINDOW and unsets SINGLE_WINDOW
    
    Returns:
    
    this / self
  - getBrowserExecutablePath
```
protected String getBrowserExecutablePath()
```
  - setBrowserExecutablePath
```
public BrowserConfigurationOptions setBrowserExecutablePath(String executablePath)
```
    Sets the full path for the browser executable.
    
    Parameters:
    
    executablePath - the full path for the browser executable.
    
    Returns:
    
    this / self
  - setTimeoutInSeconds
```
public BrowserConfigurationOptions setTimeoutInSeconds(int timeout)
```
    Sets the timeout, in seconds, for all commands.
    
    Parameters:
    
    timeout - the timeout for all commands
    
    Returns:
    
    this BrowserConfigurationOptions instance.
  - getTimeoutInSeconds
```
protected int getTimeoutInSeconds()
```
  - setBrowserMode
```
public BrowserConfigurationOptions setBrowserMode(String mode)
```
    Sets the "mode" for the browser. Historically, the 'browser' argument for getNewBrowserSession implied the mode for the browser. For example, *iehta indicated HTA mode for IE, whereas *iexplore indicated the default user mode. Using this method allows a browser mode to be specified independently of the base browser, eg. "HTA" or "PROXY". Note that absolutely no publication nor synchronization of these hard-coded strings such as "HTA" has yet been done. Use at your own risk until this is rectified.
    
    Parameters:
    
    mode - - examples "HTA" or "PROXY"
    
    Returns:
    
    this / self
  - getBrowserMode
```
protected String getBrowserMode()
```
  - setCommandLineFlags
```
public BrowserConfigurationOptions setCommandLineFlags(String cmdLineFlags)
```
  - getCommandLineFlags
```
public String getCommandLineFlags()
```
  - canUse
```
protected boolean canUse(String value)
```
  - isSet
```
public boolean isSet(String key)
```
  - get
```
public String get(String key)
```
  - set
```
public BrowserConfigurationOptions set(String key,
                                       String value)
```
    Sets the given key to the given value unless the value is null. In that case, no entry for the key is made.
    
    Parameters:
    
    key - the name of the key
    
    value - the value for the key
    
    Returns:
    
    this / self
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the serialization of this object, as defined by the serialize() method.

Class BrowserConfigurationOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROXY_CONFIG

PROFILE_NAME

SINGLE_WINDOW

MULTI_WINDOW

BROWSER_EXECUTABLE_PATH

TIMEOUT_IN_SECONDS

BROWSER_MODE

COMMAND_LINE_FLAGS

DEFAULT_TIMEOUT_IN_SECONDS

Constructor Detail

BrowserConfigurationOptions

Method Detail

hasOptions

serialize

setProfile

getProfile

isSingleWindow

isMultiWindow

setSingleWindow

setMultiWindow

getBrowserExecutablePath

setBrowserExecutablePath

setTimeoutInSeconds

getTimeoutInSeconds

setBrowserMode

getBrowserMode

setCommandLineFlags

getCommandLineFlags

canUse

isSet

get

set

toString