WebDriver (java-client 4.1.1 API)

All Superinterfaces:

SearchContext

All Known Subinterfaces:

MobileDriver<T>

All Known Implementing Classes:

AndroidDriver, AppiumDriver, IOSDriver, org.openqa.selenium.remote.RemoteWebDriver, YouiEngineDriver
```
public interface WebDriver
extends SearchContext
```
The main interface to use for testing, which represents an idealised web browser. The methods in this class fall into three categories:
- Control of the browser itself
- Selection of WebElements
- Debugging aids
Key methods are get(String), which is used to load a new web page, and the various methods similar to findElement(By), which is used to find WebElements.
Currently, you will need to instantiate implementations of this class directly. It is hoped that you write your tests against this interface so that you may "swap in" a more fully featured browser when there is a requirement for one.
Note that all methods that use XPath to locate elements will throw a RuntimeException should there be an error thrown by the underlying XPath engine.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`WebDriver.ImeHandler` An interface for managing input methods.
`static interface`	`WebDriver.Navigation`
`static interface`	`WebDriver.Options` An interface for managing stuff you would do in a browser menu
`static interface`	`WebDriver.TargetLocator` Used to locate a given frame or window.
`static interface`	`WebDriver.Timeouts` An interface for managing timeout behavior for WebDriver instances.
`static interface`	`WebDriver.Window`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close the current window, quitting the browser if it's the last window currently open.
`<T extends WebElement> T`	`findElement(org.openqa.selenium.By by)` Find the first `WebElement` using the given method.
`<T extends WebElement> List<T>`	`findElements(org.openqa.selenium.By by)` Find all elements within the current page using the given mechanism.
`void`	`get(String url)` Load a new web page in the current browser window.
`String`	`getCurrentUrl()` Get a string representing the current URL that the browser is looking at.
`String`	`getPageSource()` Get the source of the last loaded page.
`String`	`getTitle()` The title of the current page.
`String`	`getWindowHandle()` Return an opaque handle to this window that uniquely identifies it within this driver instance.
`Set<String>`	`getWindowHandles()` Return a set of window handles which can be used to iterate over all open windows of this WebDriver instance by passing them to `switchTo()`.
`WebDriver.Options`	`manage()` Gets the Option interface
`WebDriver.Navigation`	`navigate()` An abstraction allowing the driver to access the browser's history and to navigate to a given URL.
`void`	`quit()` Quits this driver, closing every associated window.
`WebDriver.TargetLocator`	`switchTo()` Send future commands to a different frame or window.

- Method Detail
  - get
```
void get(String url)
```
    Load a new web page in the current browser window. This is done using an HTTP GET operation, and the method will block until the load is complete. This will follow redirects issued either by the server or as a meta-redirect from within the returned HTML. Should a meta-redirect "rest" for any duration of time, it is best to wait until this timeout is over, since should the underlying page change whilst your test is executing the results of future calls against this interface will be against the freshly loaded page. Synonym for WebDriver.Navigation.to(String).
    
    Parameters:
    url - The URL to load. It is best to use a fully qualified URL
  - getCurrentUrl
```
String getCurrentUrl()
```
    Get a string representing the current URL that the browser is looking at.
    
    Returns:
    The URL of the page currently loaded in the browser
  - getTitle
```
String getTitle()
```
    The title of the current page.
    
    Returns:
    The title of the current page, with leading and trailing whitespace stripped, or null if one is not already set
  - findElements
```
<T extends WebElement> List<T> findElements(org.openqa.selenium.By by)
```
    Find all elements within the current page using the given mechanism. This method is affected by the 'implicit wait' times in force at the time of execution. When implicitly waiting, this method will return as soon as there are more than 0 items in the found collection, or will return an empty list if the timeout is reached.
    
    Specified by:
    
    findElements in interface SearchContext
    
    Parameters:
    by - The locating mechanism to use
    
    Returns:
    A list of all WebElements, or an empty list if nothing matches
    See Also:
    By, WebDriver.Timeouts
  - findElement
```
<T extends WebElement> T findElement(org.openqa.selenium.By by)
```
    Find the first WebElement using the given method. This method is affected by the 'implicit wait' times in force at the time of execution. The findElement(..) invocation will return a matching row, or try again repeatedly until the configured timeout is reached.
    findElement should not be used to look for non-present elements, use findElements(By) and assert zero length response instead.
    
    Specified by:
    
    findElement in interface SearchContext
    
    Parameters:
    by - The locating mechanism
    
    Returns:
    The first matching element on the current page
    
    Throws:
    
    NoSuchElementException - If no matching elements are found
    See Also:
    By, WebDriver.Timeouts
  - getPageSource
```
String getPageSource()
```
    Get the source of the last loaded page. If the page has been modified after loading (for example, by Javascript) there is no guarantee that the returned text is that of the modified page. Please consult the documentation of the particular driver being used to determine whether the returned text reflects the current state of the page or the text last sent by the web server. The page source returned is a representation of the underlying DOM: do not expect it to be formatted or escaped in the same way as the response sent from the web server. Think of it as an artist's impression.
    
    Returns:
    The source of the current page
  - close
```
void close()
```
    Close the current window, quitting the browser if it's the last window currently open.
  - quit
```
void quit()
```
    Quits this driver, closing every associated window.
  - getWindowHandles
```
Set<String> getWindowHandles()
```
    Return a set of window handles which can be used to iterate over all open windows of this WebDriver instance by passing them to switchTo().WebDriver.Options.window()
    
    Returns:
    A set of window handles which can be used to iterate over all open windows.
  - getWindowHandle
```
String getWindowHandle()
```
    Return an opaque handle to this window that uniquely identifies it within this driver instance. This can be used to switch to this window at a later date
    
    Returns:
    the current window handle
  - switchTo
```
WebDriver.TargetLocator switchTo()
```
    Send future commands to a different frame or window.
    
    Returns:
    A TargetLocator which can be used to select a frame or window
    See Also:
    WebDriver.TargetLocator
  - navigate
```
WebDriver.Navigation navigate()
```
    An abstraction allowing the driver to access the browser's history and to navigate to a given URL.
    
    Returns:
    A WebDriver.Navigation that allows the selection of what to do next
  - manage
```
WebDriver.Options manage()
```
    Gets the Option interface
    
    Returns:
    An option interface
    See Also:
    WebDriver.Options

Interface WebDriver

Nested Class Summary

Method Summary

Method Detail

get

getCurrentUrl

getTitle

findElements

findElement

getPageSource

close

quit

getWindowHandles

getWindowHandle

switchTo

navigate

manage