org.openqa.selenium.ie

Class InternetExplorerDriverService.Builder

java.lang.Object

org.openqa.selenium.ie.InternetExplorerDriverService.Builder

Enclosing class:

InternetExplorerDriverService

public static class InternetExplorerDriverService.Builder
extends Object

Builder used to configure new InternetExplorerDriverService instances.

Constructor Summary

Constructors

Constructor and Description
InternetExplorerDriverService.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
InternetExplorerDriverService	build() Creates a new service to manage the driver server.
InternetExplorerDriverService.Builder	usingAnyFreePort() Configures the driver server to start on any available port.
InternetExplorerDriverService.Builder	usingDriverExecutable(File file) Sets which driver executable the builder will use.
InternetExplorerDriverService.Builder	usingPort(int port) Sets which port the driver server should be started on.
InternetExplorerDriverService.Builder	withEnvironment(Map<String,String> environment) Defines the environment for the launched driver server.
InternetExplorerDriverService.Builder	withExtractPath(File extractPath) Configures path to which the driver server library will be extracted.
InternetExplorerDriverService.Builder	withHost(String host) Configures the host to which the driver server bound.
InternetExplorerDriverService.Builder	withIeSwitches(String ieSwitches) Configures IE CLI switches which will be used by the driver service if CREATE_PROCESS launch api is specified.
InternetExplorerDriverService.Builder	withLaunchApi(Boolean forceCreateProcess) Configures IE launch API used by the driver server.
InternetExplorerDriverService.Builder	withLogFile(File logFile) Configures the driver server to write log to the given file.
InternetExplorerDriverService.Builder	withLogLevel(InternetExplorerDriverLogLevel logLevel) Configures the logging level for the driver server.
InternetExplorerDriverService.Builder	withSilent(Boolean silent) Configures silence in stdout of the driver server by unlogged messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

InternetExplorerDriverService.Builder

public InternetExplorerDriverService.Builder()

Method Detail

usingDriverExecutable

public InternetExplorerDriverService.Builder usingDriverExecutable(File file)

Sets which driver executable the builder will use.

Parameters:

file - The executable to use.

Returns:

A self reference.

usingPort

public InternetExplorerDriverService.Builder usingPort(int port)

Sets which port the driver server should be started on. A value of 0 indicates that any free port may be used.

Parameters:

port - The port to use; must be non-negative.

Returns:

A self reference.

usingAnyFreePort

public InternetExplorerDriverService.Builder usingAnyFreePort()

Configures the driver server to start on any available port.

Returns:

A self reference.

withEnvironment

@Beta
public InternetExplorerDriverService.Builder withEnvironment(Map<String,String> environment)

Defines the environment for the launched driver server. These settings will be inherited by every browser session launched by the server.

Parameters:

environment - A map of the environment variables to launch the server with.

Returns:

A self reference.

withLogFile

public InternetExplorerDriverService.Builder withLogFile(File logFile)

Configures the driver server to write log to the given file.

Parameters:

logFile - A file to write log to.

Returns:

A self reference.

withLogLevel

public InternetExplorerDriverService.Builder withLogLevel(InternetExplorerDriverLogLevel logLevel)

Configures the logging level for the driver server.

Parameters:

logLevel - A level of the log verbosity.

Returns:

A self reference.

withHost

public InternetExplorerDriverService.Builder withHost(String host)

Configures the host to which the driver server bound.

Parameters:

host - A host name.

Returns:

A self reference.

withExtractPath

public InternetExplorerDriverService.Builder withExtractPath(File extractPath)

Configures path to which the driver server library will be extracted.

Parameters:

extractPath - A path.

Returns:

A self reference.

withSilent

public InternetExplorerDriverService.Builder withSilent(Boolean silent)

Configures silence in stdout of the driver server by unlogged messages.

Parameters:

silent - To be silent in stdout ir not.

Returns:

A self reference.

withLaunchApi

public InternetExplorerDriverService.Builder withLaunchApi(Boolean forceCreateProcess)

Configures IE launch API used by the driver server.

Parameters:

forceCreateProcess - To use force CreateProcess() IE launch API or not.

Returns:

A self reference.

withIeSwitches

public InternetExplorerDriverService.Builder withIeSwitches(String ieSwitches)

Configures IE CLI switches which will be used by the driver service if CREATE_PROCESS launch api is specified.

Parameters:

ieSwitches - IE CLI switches.

Returns:

A self reference.

build

public InternetExplorerDriverService build()

Creates a new service to manage the driver server. Before creating a new service, the builder will find a port for the server to listen to.

Returns:

The new service object.