All Classes

Class Description
AbstractListItemHandler<T>
Similar to SmartElementHandler but wraps a concrete WebElement instead of an ElementLocator.
AbstractObjectInitialiser<T>  
AbstractSingleItemHandler<T>
Base class for handlers of non-List members.
AbstractStepListener  
AddCustomCapabilities  
AddCustomDriverCapabilities  
AddEnvironmentSpecifiedDriverCapabilities  
AddLoggingPreferences
Define WebDriver logging levels using the webdriver.logprefs.* properties, e.g.
AfterAWebdriverScenario  
AfterExample  
AfterScenario  
AlertStub  
AmendedPathBuilder  
AndContent  
AndroidWebDriverStub  
AnnotatedBluring  
AnyPage
A page object that can represent any page, without specifiying the exact page.
AppiumConfiguration  
AppiumDevicePool
Manage Appium servers for multiple devices.
AppiumDriverCapabilities  
AppiumDriverProvider  
AppiumServerPool
The Appium Service pool is responsible for starting up and shutting down Appium servers.
At
Define the URLs that a given Page Object works with.
AtTheEndOfAWebDriverTest  
BaseMethodRunner  
BaseStepListener
Observes the test run and stores test run details for later reporting.
BaseStepListener.ScreenshotType  
BeforeAWebdriverScenario  
BeforeExample  
BeforeScenario  
BigDecimalTypeConverter  
Blurer  
BlurLevel
Created with IntelliJ IDEA.
BlurScreenshots
Indicates whether or not the screenshots should be blurred.
BooleanTypeConverter  
Broadcaster  
BrowserStackRemoteDriverCapabilities
Provides BrowserStack specific capabilities
By  
By Deprecated.
Use By instead
By.ByButtonTextSelector  
By.ByjQuerySelector  
By.ByScLocator  
ByJQuery  
ByJQuerySelector  
ByShadowDom
By Selector that finds Shadow Dom elements.
CanBeSilent  
CapabilitiesConverter  
CapabilitiesStub
Created by john on 14/06/2016.
CapabilityEnhancer
Created by john on 25/06/2016.
CapabilityValue  
CapabilityValue  
Checkbox
A checkbox web element.
ChromeDriverCapabilities  
ChromeDriverProvider  
ChromePreferences  
ChromeServicePool  
ClasspathCustomFindByAnnotationProviderService
Created by Sergio Sacristan on 03/12/17.
ClasspathFieldInjectorService
A description goes here.
ClasspathFixtureProviderService
Load any implementations of the FixtureService class declared on the classpath.
CleanupMethodAnnotationProvider
Specifies the annotations of the cleanup methods.
CleanupMethodLocator  
ClearContents  
ClearCookiesPolicy  
ClickStrategy  
CloseBrowser  
ConfigurableTimeouts
Created by john on 12/03/15.
ConfigureChromeOptions  
ConfiguredProxy  
ConfigureFileDetector  
ConstructionStrategy  
CookieStub  
CSVTestDataSource
Test data from a CSV file.
CustomCapabilities
CustomCapabilities are use to define both general and browser-specific capabilities for drivers in a generic way.
CustomChromeOptions  
CustomDriverEnhancer  
CustomFindByAnnotationProviderService  
CustomFindByAnnotationService
Created by Sergio Sacristan on 03/12/17.
Darkroom  
DarkroomFileSystem  
DarkroomProcessingLine  
DataDrivenStep
Keep track of whether the current thread is running a data-driven step or not.
DataDrivenStepFactory
Create a proxy for scenario steps objects to be used for data-driven tests.
DataDrivenStepInterceptor
Invoke a step multiple times, each time initialized with a different set of test data.
DeactivatedCloseBrowser  
DefaultPageObjectInitialiser  
DefaultTimeouts
Created by john on 6/03/15.
DefaultUrl
Define the URLs that a given Page Object works with.
DefaultValue  
DefaultWidgetObjectInitialiser
Initializes the WebElementFacade members of a WidgetObject.
DisabledGeckoDriverService  
DisabledPageSourceRecorder  
DisableScreenshots
Marks a task that should not generate any screenshots (such as a REST call or backend action) even if the test overall is a UI test
DriverCapabilities  
DriverCapabilitiesProvider
Created by john on 25/06/2016.
DriverConfiguration<T extends DriverConfiguration>  
DriverConfigurationError
Thrown when the test runner tries to use an unsupported WebDriver driver.
DriverName  
DriverOptions
Options that will be passed to a driver specified by the @WithDriver annotation
DriverPathConfiguration  
DriverProvider  
DriverServiceExecutable  
DriverServiceExecutable.DriverServiceExecutableBuilder  
DriverServiceHook  
DriverServicePool<T extends org.openqa.selenium.remote.service.DriverService>  
DriverServices  
DriverSource
You can implement this class to provide your own driver instance.
DriverSource.UnknownDriver
Used to indicate that the provided driver has not been specified by the driverType() method.
DriverStrategy  
DriverStrategySelector
Created by john on 25/06/2016.
Dropdown
Created by IntelliJ IDEA.
Droppable  
DynamicExampleStepInterceptionListener  
EdgeDriverCapabilities  
EdgeDriverProvider  
EdgeServicePool  
ElementContructorForm  
ElementIsUsable  
ElementLocatorFactorySelector  
ElementNotFoundAfterTimeoutError  
ElementNotVisibleAfterTimeoutError  
ElementProxyCreator  
ElementShouldBeDisabledException  
ElementShouldBeEnabledException  
ElementShouldBeInvisibleException  
ElementShouldBePresentException  
ElementShouldBeVisibleException  
EnclosingClass  
EnhanceDriver  
EnvironmentDependencyInjector
Created by john on 26/03/2015.
EqualsUtils
Utility class for implementing equals().
ErrorConvertor  
ExampleTables  
ExampleTables.OptionalFields  
ExampleTables.WithHeaders  
ExpectedBackendCondition<B,​T>
Models a condition that might reasonably be expected to eventually evaluate to something that is neither null nor false.
FailedToInitializeTestData
Error that occurs if the test data could not be instanciated for some reason.
FeatureOrStoryFile  
FieldInjectorService  
FieldName
Utility class to convert CSV headings to valid JavaBean property names.
FileSeparatorUtil  
FileSystemUtils
Created by john on 29/06/2014.
FileToDownload
Created by john on 30/10/2014.
FileToUpload
A class that helps upload a file to an HTML form in using a fluent API.
FileToUploadCouldNotBeFoundException  
FindAllWaitOptions  
FindBy  
FindBy Deprecated.
Replaced by FindBy
FirefoxDriverCapabilities  
FirefoxDriverProvider  
FirefoxOptionsEnhancer  
FirefoxProfileEnhancer  
FixtureException
A description goes here.
FixtureProviderService  
FixtureService  
FluentDropdown  
FluentDropdownDeselect  
FluentDropdownSelect  
FluentWaitWithRefresh<T>  
FromFile  
GeckoDriverServiceExecutable  
GeckoServicePool  
HasCustomFieldValues  
How  
HtmlDriverProvider  
HtmlTable
Class designed to make it easier reading from and reasoning about data in HTML tables.
HtmlTable.CellReaderStrategy  
HtmlTable.HtmlTableBuilder  
HtmlTag  
ImeHandlerStub  
ImplementedBy
Annotation is used to specify the implementation Class of the interface that extends WebElementFacade.
ImplementedBy
Annotation is used to specify the implementation Class of the interface that extends WebElementFacade.
IndividualInstancesByDefaultStepCreationStrategy  
InstanceBuilder
Helper class for finding and invoking constructors.
Instrumented  
Instrumented.InstrumentedBuilder<T>  
IntegerTypeConverter  
Interceptor  
InternetExplorerDriverProvider  
InternetExplorerServicePool  
InvalidManagedPagesFieldException
Thrown if no suitable WebDriver field with the @Managed annotation is found in a test.
InvalidManagedWebDriverFieldException
Thrown if no suitable WebDriver field with the @Managed annotation is found in a test.
InvalidStepsFieldException
Thrown if no suitable WebDriver field with the @Managed annotation is found in a test.
IOSWebDriverStub  
IsHidden
Marks a task that will not be reported.
IsSilent
Marks a task that will not be reported.
JavascriptExecutorFacade
Simple encapsulation of Javascript execution.
JavascriptSupport  
JQueryEnabledPage  
JUnitCleanupMethodAnnotationProvider  
KeyboardStub
Created by john on 14/06/2016.
LifecycleRegister  
Line  
Line.LineBuilder  
Listeners  
Listeners.BaseStepListenerBuilder  
ListOfWebElementFacades  
Managed
Annotation that marks a WebDriver field as one that is managed by the Test Runner.
ManagedPages
Annotation that marks a WebDriver field as one that is managed by the Test Runner.
ManagedWebDriverAnnotatedField
The WebDriver driver is stored as an annotated field in the test classes.
ManageStub
Created by john on 2/02/15.
Manual
Annotation that marks a manual test.
ManualTestMarkedAsError  
ManualTestMarkedAsFailure  
MatchingPageExpressions
Determines which URLs a given page object will work with.
MethodErrorReporter
Created by john on 9/08/2015.
Methods
Created by john on 7/08/2015.
MethodTiming
Created by john on 17/03/15.
MobilePlatform
Created by john on 28/10/2014.
MouseStub
Created by john on 14/06/2016.
MultipleSelect
A convenience class to help handle multiple select fields.
NamedUrl
Define the URLs that a given Page Object works with.
NamedUrls
Define the URLs that a given Page Object works with.
NavigationStub  
NoAvailableDeviceException  
NormalFluentWait<T>  
NoSuchElementException
I need NoSuchElementException that does not include InvalidSelectorException.
NoSuchPageException  
NotImplementedException
Thrown when there is an implementation error of WebElementFacade extension
OptionsFacade  
OptionsMap
Created by john on 14/07/2017.
OptionsSplitter  
OptionsStub
A description goes here.
OverrideDriverCapabilities
This class allows you to override driver capabilities defined in the Serenity configuration files at runtime.
OverrideDriverCapabilities.CapabilityBuilderChain  
OverrideDriverCapabilities.OverrideDriverCapabilitiesBuilder  
OverrideDriverCapabilities.OverrideSetter  
PageFactory  
PageFieldInjector
Allows you to instantiate PageObject fields in
PageLooksDodgyException  
PageObject
A base class representing a WebDriver page object.
PageObject
A base class representing a WebDriver page object.
PageObject.OpenWithParams  
PageObjectDependencyInjector  
PageObjects  
PageObjectStepDelayer<T extends PageObject>  
Pages
The Pages object keeps track of what web pages a test visits, and helps with mapping pages to Page Objects.
PagesAnnotatedField
The Pages object keeps track of the Page Objects used during the tests.
PageSourceRecorder  
PageUrls
Manage the URLs associated with a page Urls can be associated with a page using annotations or via the default configuration properties.
ParameterisedLocator  
PathProcessor  
PeriodicRestart  
PhantomJSCapabilityEnhancer  
PhantomJSDriverProvider  
PhantomJSServicePool  
PhotoFilter  
Photographer  
PhotoSession  
PhotoSessionBooking  
Point  
PollingSchedule<T>  
PollingSchedule<T>  
ProvidedDriver  
ProvidedDriverCapabilities  
ProvidedDriverConfiguration
A description goes here.
ProvidedDriverProvider  
ProvideNewDriver  
Proxies  
ProxyConfiguration  
ProxyConfiguration.InterceptorDispatcher
A static interceptor that guards against method calls before the interceptor is set.
QueuedScreenshot  
RadioButtonGroup  
ReadableMethodName  
ReadableMethodName.TestNameBuilder  
RecursiveOrCyclicStepLibraryReferenceException  
RedimensionBrowser
Created by john on 25/06/2016.
RemoteDriver  
RemoteDriverCapabilities  
RemoteDriverProvider
A Remote Driver using Saucelabs or Browserstack (for remote web tesing), or Selenium Grid.
RemoteWebdriverStub  
RenderedPageObjectView
A page view that handles checking and waiting for element visibility.
Reportable  
ReportDataSaver  
Reported
Annotation that marks a WebDriver field as one that is managed by the Test Runner.
RequirementsForOutcomeTypes
Created by john on 26/06/2016.
Resizer  
ResolvedWebElementResolver  
RestartBrowserForEach  
SafariDriverProvider  
SanitisedBrowserPreferenceValue  
SaucelabsRemoteDriverCapabilities
Provide Sauce Labs specific capabilities
ScenarioActor  
ScenarioSteps
A set of reusable steps for use in an acceptance test suite.
ScenarioStepsStepDelayer<T extends ScenarioSteps>  
ScreenshotBlurCheck  
ScreenshotDigest  
ScreenshotDigest  
ScreenshotNegative  
ScreenshotNegative.ScreenshotNegativeBuilder  
ScreenshotPermission  
ScreenshotPhoto
A screenshot taken by a photographer.
ScreenshotProcessor Deprecated.
ScreenshotReceipt  
Screenshots  
ScreenshotSequence
A simple sequencer for screenshot numbers.
SelectorConverter  
Selectors  
Serenity
A utility class that provides services to initialize web testing and reporting-related fields in arbitrary objects.
Serenity.SerenityConfigurer  
Serenity.SessionVariableSetter  
SerenityActions  
SerenityFluentWait  
SerenityJUnitTestCase  
SerenityListeners  
SerenityReports
Provide supporting methods for creating report listeners and generating reports.
SerenityWebdriverManager
Manage WebDriver instances.
ServicePoolError  
SessionMap<K,​V>  
SetProxyConfiguration  
Shared
Shared is a synonym for @Steps(shared=true)
SharedInstancesByDefaultStepCreationStrategy  
SilentEventBus  
SkipNested  
SlowTest  
SmartAjaxElementLocator  
SmartAnnotations  
SmartAnnotations  
SmartElementHandler  
SmartElementLocator  
SmartElementLocatorFactory  
SmartElementProxyCreator  
SmartFieldDecorator  
SmartListHandler
Handles Lists of WebElementFacades.
SmartWidgetHandler
Handles single-item WidgetObject proxies.
SmartWidgetProxyCreator
Initializes WidgetObject fields with contextual locators.
SoundEngineer  
StepAnnotations
Utility class used to inject fields into a test case.
StepData
Data-driven test step execution.
StepDefinitionAnnotations  
StepEventBus
An event bus for Step-related notifications.
StepFactory
Produces an instance of a set of requirement steps for use in the acceptance tests.
StepInitialisationException  
StepInterceptionListener  
StepInterceptor
Listen to step results and publish notification messages.
StepLibraryConstructionStrategy  
StepLibraryCreationStrategy  
StepLibraryType  
StepName  
StepNamer  
StepPublisher
Represents a class that monitors step results and can report on test outcomes.
Steps
Marks a class that implements test steps as individual methods.
StepsAnnotatedField
Used to identify Step library fields that need to be instantiated.
StopServiceHook  
StringTestDataSource
Test data from a set of Strings.
StringTypeConverter  
SupportedWebDriver
The list of supported web drivers.
TargetLocatorStub  
TemporalUnitConverter  
TestCaseAnnotations
Utility class used to inject fields into a test case.
TestDataSource
A set of test data used in parameterized web tests.
TestDescription
Helps analyse annotations on test methods, steps and step groups.
TestLifecycleEvents  
TestLifecycleEvents.TestFinished  
TestLifecycleEvents.TestStarted  
TestLifecycleEvents.TestSuiteFinished  
TestLifecycleEvents.TestSuiteStarted  
TestMethodNotFoundException
A named test method was not found in a test class.
TestResultTally
Result of a test step or sequence of test steps.
TestSessionVariables<K,​V>  
TestSuiteCloseBrowser  
ThreadsafeGeckoDriverService
Used as a wrapper around the GeckoDriverService to make it behave in a Threadsafe manner like all the other DriverService implementations.
Thucydides Deprecated.
Use Serenity class instead A utility class that provides services to initialize web testing and reporting-related fields in arbitrary objects.
ThucydidesAgent
A utility class that provides services to initialize web testing and reporting-related fields in arbitrary objects.
ThucydidesConfigurationException
Created by john on 28/10/2014.
ThucydidesFluentAdapter  
ThucydidesFluentWait<T>  
ThucydidesListeners Deprecated.
Use SerenityListeners instead
ThucydidesPageFragmentInjector  
ThucydidesReports Deprecated.
Use SerenityListeners instead
ThucydidesWebDriverEventListener
Listener class used to know when a new Webdriver instance has been created.
ThucydidesWebDriverSupport
A utility class that provides services to initialize web testing and reporting-related fields in arbitrary objects.
TimeoutSchedule<T>  
TimeoutSchedule<T>  
TimeoutsFacade
Created by john on 30/01/15.
TimeoutsStub  
TimeoutStack
Created by john on 12/03/15.
TimeSchedule<T>  
TimeSchedule<T>  
TriConsumer<T,​U,​V>  
TypeConverter  
TypeConverters  
UIInteractionSteps
An action class designed to interact an application via the UI
UIQuerySteps
An action class designed to query an application via the UI
UnableToInvokeWhenPageOpensMethods
Could not invoke a Page Oject method annotated with the WhenPageOpens annotation.
UnavailableTestOutcome  
UnexpectedDriverExpected  
URLUtils
Created by john on 27/06/2014.
UsePersistantStepLibraries  
UserStoryCode
Mark a test case with a code identifing a user story.
WaitForAngular  
WaitForBuilder<T>  
WaitForWebElementCollection  
WaitForWebElements  
WebdriverCloseBrowser  
WebdriverCollectionStrategy  
WebDriverConfiguration<T extends DriverConfiguration>  
WebDriverConfiguredEnvironment  
WebDriverConfigurer  
WebdriverContext  
WebDriverFacade
A proxy class for webdriver instances, designed to prevent the browser being opened unnecessarily.
WebDriverFactory
Provides an instance of a supported WebDriver.
WebDriverInjectors  
WebDriverInstanceEventListener  
WebDriverInstanceEvents  
WebdriverInstances
One or more WebDriver drivers that are being used in a test.
WebDriverLifecycleEvent  
WebdriverManager
Manage WebDriver instances.
WebDriverModule  
WebdriverProxyFactory
Provides a proxy for a WebDriver instance.
WebDriverStub  
WebDriverType  
WebElementDescriber
Created by john on 30/01/15.
WebElementExpectations  
WebElementFacade  
WebElementFacade Deprecated.
Use same-named class in serenitybdd package
WebElementFacadeImpl
A proxy class for a web element, providing some more methods.
WebElementFacadeImpl Deprecated.
Use same-named class in serenitybdd package
WebElementFacadeImplLocator  
WebElementFacadeListItemHandler
Handles a resolved WebElementFacade from a List.
WebElementFacadeStub  
WebElementFacadeWait  
WebElementResolver  
WebElementResolver.LocatorResolverBuilder  
WebElementResolverByElementLocator  
WebElementResolverByLocator  
WebElementState
This interface is a way of presenting state information about a web element without exposing (too much) of the WebDriver API.
WebElementState Deprecated.
Use same-named class in serenitybdd package
WhenPageOpens
Indicates a method on a Page Object that is called when the page is opened.
WidgetListItemHandler
Handles a resolved WidgetObject from a List.
WidgetObject
Represents a page fragment which occurs across pages or multiple times in a single page.
WidgetObjectImpl
Base implementation for WidgetObject.
WidgetProxyCreator  
WindowStub  
WithByLocator  
WithConfigurableTimeout
Created by john on 12/03/15.
WithDriver
Run an individual test with a specific driver.
WithLocator  
WithStepDescription  
WithTitle  
WrappedElementStub  
WrappedWebElementFacadeImpl  
WrongPageError
We have navigated to the wrong page.