AxeBuilder (aXe Selenium Integration 4.6.0 API)

java.lang.Object
- com.deque.html.axecore.selenium.AxeBuilder

```
public class AxeBuilder
extends Object
```
Fluent style builder for invoking aXe. Instantiate a new Builder and configure testing with the include(), exclude(), and options() methods before calling analyze() to run.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`axeRunScript`
`String`	`hasRunPartialScript`
`String`	`iframeAllowScriptTemplate`
`String`	`sameOrigin`
`String`	`sandboxBusterScript`
`String`	`unsafeAllOrigins`

Constructor Summary

Constructors
Constructor and Description
`AxeBuilder()` Initialize an instance of AxeBuilder.
`AxeBuilder(AxeBuilderOptions builderOptions)` Initialize an instance of AxeBuilder.
`AxeBuilder(AxeBuilderOptions builderOptions, com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Initialize an instance of AxeBuilder.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Results`	`analyze(org.openqa.selenium.WebDriver webDriver)` Run axe against the entire page.
`Results`	`analyze(org.openqa.selenium.WebDriver webDriver, boolean injectAxe)` Run axe against the entire page.
`Results`	`analyze(org.openqa.selenium.WebDriver webDriver, org.openqa.selenium.WebElement... context)` Run axe against a specific WebElement or webElements (including its descendants).
`AxeBuilder`	`disableIframeTesting()` Inject and run axe on the top-level iframe only.
`AxeBuilder`	`disableRules(List<String> rules)` Set the list of rules to skip when running an analysis.
`AxeBuilder`	`exclude(FromFrames fromFrames)` Limit frame testing with the use of `fromFrames`.
`AxeBuilder`	`exclude(FromShadowDom fromShadowDom)` Limit shadow DOM testing with the use of `excludeFromShadowDom`.
`AxeBuilder`	`exclude(List<String> selectors)` Selectors to exclude in the validation.
`AxeBuilder`	`exclude(Object... selector)` Build more complex selectors by combining Shadow DOM and Frame Context to exclude
`AxeBuilder`	`exclude(Object selector)` Build more complex selectors by supplying a single object to exclude
`AxeBuilder`	`exclude(String selector)` Include a single CSS selector to exclude during analysis
`IAxeScriptProvider`	`getAxeScriptProvider()` sets the where we get the axe script from.
`AxeBuilderOptions`	`getDefaultAxeBuilderOptions()` get the default axe builder options.
`String`	`getOptions()` gets the options.
`AxeBuilder`	`include(FromFrames fromFrames)` Limit frame testing with the use of `fromFrames`.
`AxeBuilder`	`include(FromShadowDom fromShadowDom)` Limit shadow DOM testing with the use of `excludeFromShadowDom`.
`AxeBuilder`	`include(List<String> selectors)` Selectors to include in the validation.
`AxeBuilder`	`include(Object... selector)` Build more complex selectors by combining Shadow DOM and Frame Context to include
`AxeBuilder`	`include(Object selector)` Build more complex selectors by supplying a single object to include
`AxeBuilder`	`include(String selector)` Include a single CSS selector to include during analysis
`AxeBuilder`	`setAxeScriptProvider(IAxeScriptProvider axeProvider)` sets the where we get the axe script from.
`void`	`setInjectAxe(Consumer<org.openqa.selenium.WebDriver> cb)` Set a custom method of injecting axe into the page.
`void`	`setInjectAxe(Consumer<org.openqa.selenium.WebDriver> cb, boolean stillInjectAxe)` Set a custom method of injecting axe into the page.
`AxeBuilder`	`setLegacyMode()` Deprecated. This method will be removed in v5
`AxeBuilder`	`setLegacyMode(boolean state)` Deprecated. This method will be removed in v5
`void`	`setOptions(String newOptions)` sets the options.
`AxeBuilder`	`setTimeout(int newTimeout)` sets the timeout.
`AxeBuilder`	`withOnlyRules(List<String> rules)` Limit analysis to only the specified rules.
`AxeBuilder`	`withOptions(AxeRunOptions newRunOptions)` Run configuration data that is passed to axe for scanning the web page.
`AxeBuilder`	`withoutIframeSandboxes()` Remove the "sandbox" attribute from iframes on the page.
`AxeBuilder`	`withOutputFile(String path)` Causes analyze() to write the axe results as a JSON file, in addition to returning it in object format as usual.
`AxeBuilder`	`withRules(List<String> rules)` Limit analysis to only the specified rules.
`AxeBuilder`	`withTags(List<String> tags)` Limit analysis to only the specified tags.

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

- Field Detail
  - axeRunScript
```
public final String axeRunScript
```
    See Also:
    
    Constant Field Values
  - unsafeAllOrigins
```
public final String unsafeAllOrigins
```
    See Also:
    
    Constant Field Values
  - sameOrigin
```
public final String sameOrigin
```
    See Also:
    
    Constant Field Values
  - iframeAllowScriptTemplate
```
public final String iframeAllowScriptTemplate
```
    See Also:
    
    Constant Field Values
  - hasRunPartialScript
```
public final String hasRunPartialScript
```
    See Also:
    
    Constant Field Values
  - sandboxBusterScript
```
public final String sandboxBusterScript
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AxeBuilder
```
public AxeBuilder()
```
    Initialize an instance of AxeBuilder.
  - AxeBuilder
```
public AxeBuilder(AxeBuilderOptions builderOptions)
```
    Initialize an instance of AxeBuilder.
    
    Parameters:
    
    builderOptions - Builder options
  - AxeBuilder
```
public AxeBuilder(AxeBuilderOptions builderOptions,
                  com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```
    Initialize an instance of AxeBuilder.
    
    Parameters:
    
    builderOptions - Builder options
    
    objectMapper - Mapper to use when converting JSON
- Method Detail
  - getDefaultAxeBuilderOptions
```
public AxeBuilderOptions getDefaultAxeBuilderOptions()
```
    get the default axe builder options.
    
    Returns:
    
    the Axe Builder Options
  - setAxeScriptProvider
```
public AxeBuilder setAxeScriptProvider(IAxeScriptProvider axeProvider)
```
    sets the where we get the axe script from.
    
    Parameters:
    
    axeProvider - the source of the axe script
    
    Returns:
    
    an Axe Builder object
  - getAxeScriptProvider
```
public IAxeScriptProvider getAxeScriptProvider()
```
    sets the where we get the axe script from.
    
    Returns:
    
    an Axe Builder object
  - setTimeout
```
public AxeBuilder setTimeout(int newTimeout)
```
    sets the timeout.
    
    Parameters:
    
    newTimeout - the int value to be set
    
    Returns:
    
    an Axe Builder object
  - getOptions
```
public String getOptions()
```
    gets the options.
    
    Returns:
    
    the options
  - setOptions
```
public void setOptions(String newOptions)
```
    sets the options.
    
    Parameters:
    
    newOptions - the options to be set
  - withoutIframeSandboxes
```
public AxeBuilder withoutIframeSandboxes()
```
    Remove the "sandbox" attribute from iframes on the page.
    
    Returns:
    
    an Axe Builder
  - disableIframeTesting
```
public AxeBuilder disableIframeTesting()
```
    Inject and run axe on the top-level iframe only.
    
    Returns:
    
    an Axe Builder
  - withOptions
```
public AxeBuilder withOptions(AxeRunOptions newRunOptions)
```
    Run configuration data that is passed to axe for scanning the web page. This will override the value set by WithRules(string[]), WithTags(string[]) & DisableRules(string[])
    
    Parameters:
    
    newRunOptions - run options to be used for scanning.
    
    Returns:
    
    an Axe Builder
  - withTags
```
public AxeBuilder withTags(List<String> tags)
```
    Limit analysis to only the specified tags. Refer https://www.deque.com/axe/axe-for-web/ documentation/api-documentation/#api-name-axegetrules to get the list of supported tag names. Cannot be used with WithRules(string[]) & Options
    
    Parameters:
    
    tags - tags to be used for scanning
    
    Returns:
    
    an Axe Builder
  - withOnlyRules
```
public AxeBuilder withOnlyRules(List<String> rules)
```
    Limit analysis to only the specified rules. Refer https://dequeuniversity.com/rules/axe/ to get the complete listing of available rule IDs. Cannot be used with WithTags(List<String>) & Options
    
    Parameters:
    
    rules - rule IDs to be used for scanning
    
    Returns:
    
    an Axe Builder
  - withRules
```
public AxeBuilder withRules(List<String> rules)
```
    Limit analysis to only the specified rules. Refer https://dequeuniversity.com/rules/axe/ to get the complete listing of available rule IDs. Cannot be used with WithTags(List<String>) & Options
    
    Parameters:
    
    rules - rule IDs to be used for scanning
    
    Returns:
    
    an Axe Builder
  - disableRules
```
public AxeBuilder disableRules(List<String> rules)
```
    Set the list of rules to skip when running an analysis. Refer https://dequeuniversity.com/rules/axe/ to get the complete listing of available rule IDs. Cannot be used with Options
    
    Parameters:
    
    rules - rule IDs to be skipped from analysis
    
    Returns:
    
    an Axe Builder
  - include
```
public AxeBuilder include(List<String> selectors)
```
    Selectors to include in the validation. Note that the selectors array uniquely identifies one element in the page, Valid usage: axeBuilder.Include("#parent-iframe1", "#element-inside-iframe"); => to select #element-inside-iframe under #parent-iframe1 axeBuilder.Include("#element-inside-main-frame1"); Invalid usage: axeBuilder.Include("#element-inside-main-frame1", "#element-inside-main-frame2");
    
    Parameters:
    
    selectors - Any valid CSS selectors
    
    Returns:
    
    an Axe Builder
  - include
```
public AxeBuilder include(String selector)
```
    Include a single CSS selector to include during analysis
    
    Parameters:
    
    selector - Arraylist of Strings
    
    Returns:
    
    this
  - include
```
public AxeBuilder include(Object selector)
```
    Build more complex selectors by supplying a single object to include
    
    Parameters:
    
    selector - List of Strings, FromFrames, FromShadowDom object
    
    Returns:
    
    this
    
    See Also:
    
    Combine shadow DOM and frame context
  - include
```
public AxeBuilder include(Object... selector)
```
    Build more complex selectors by combining Shadow DOM and Frame Context to include
    
    Parameters:
    
    selector - Provide a list nested selectors
    
    Returns:
    
    this
    
    See Also:
    
    Combine shadow DOM and frame context
  - include
```
public AxeBuilder include(FromFrames fromFrames)
```
    Limit frame testing with the use of `fromFrames`.
    
    Parameters:
    
    fromFrames - List of specific sections within a frame to include
    
    Returns:
    
    this
    
    See Also:
    
    FromFrames
  - include
```
public AxeBuilder include(FromShadowDom fromShadowDom)
```
    Limit shadow DOM testing with the use of `excludeFromShadowDom`.
    
    Parameters:
    
    fromShadowDom - List of shadow DOM host element(s) to include
    
    Returns:
    
    this
    
    See Also:
    
    FromShadowDom
  - exclude
```
public AxeBuilder exclude(List<String> selectors)
```
    Selectors to exclude in the validation. Note that the selectors array uniquely identifies one element in the page. Refer include(string[]) for more information on the usage
    
    Parameters:
    
    selectors - Any valid CSS selectors
    
    Returns:
    
    an Axe Builder
  - exclude
```
public AxeBuilder exclude(String selector)
```
    Include a single CSS selector to exclude during analysis
    
    Parameters:
    
    selector - Arraylist of Strings
    
    Returns:
    
    this
  - exclude
```
public AxeBuilder exclude(Object selector)
```
    Build more complex selectors by supplying a single object to exclude
    
    Parameters:
    
    selector - List of Strings, FromFrames, FromShadowDom object
    
    Returns:
    
    this
    
    See Also:
    
    Combine shadow DOM and frame context
  - exclude
```
public AxeBuilder exclude(Object... selector)
```
    Build more complex selectors by combining Shadow DOM and Frame Context to exclude
    
    Parameters:
    
    selector - Provide a list nested selectors
    
    Returns:
    
    this
    
    See Also:
    
    Combine shadow DOM and frame context
  - exclude
```
public AxeBuilder exclude(FromFrames fromFrames)
```
    Limit frame testing with the use of `fromFrames`.
    
    Parameters:
    
    fromFrames - List of specific sections within a frame to exclude
    
    Returns:
    
    this
    
    See Also:
    
    FromFrames
  - exclude
```
public AxeBuilder exclude(FromShadowDom fromShadowDom)
```
    Limit shadow DOM testing with the use of `excludeFromShadowDom`.
    
    Parameters:
    
    fromShadowDom - List of shadow DOM host element(s) to exclude
    
    Returns:
    
    this
    
    See Also:
    
    FromShadowDom
  - withOutputFile
```
public AxeBuilder withOutputFile(String path)
```
    Causes analyze() to write the axe results as a JSON file, in addition to returning it in object format as usual.
    
    Parameters:
    
    path - Path to the output file. Will be passed as-is to the System.IO APIs.
    
    Returns:
    
    an Axe builder
  - setLegacyMode
```
@Deprecated
public AxeBuilder setLegacyMode()
```
    Deprecated. This method will be removed in v5
    
    Enables the use of legacy axe analysis path. Affects cross-domain results.
    
    Returns:
    
    an Axe Builder
  - setLegacyMode
```
@Deprecated
public AxeBuilder setLegacyMode(boolean state)
```
    Deprecated. This method will be removed in v5
    
    Enables the use of legacy axe analysis path. Affects cross-domain results.
    
    Parameters:
    
    state - Whether or not to use legacy mode.
    
    Returns:
    
    an Axe Builder
  - setInjectAxe
```
public void setInjectAxe(Consumer<org.openqa.selenium.WebDriver> cb)
```
    Set a custom method of injecting axe into the page. Will not use the default injection if set.
    
    Parameters:
    
    cb - function that will inject axe-core into the page
  - setInjectAxe
```
public void setInjectAxe(Consumer<org.openqa.selenium.WebDriver> cb,
                         boolean stillInjectAxe)
```
    Set a custom method of injecting axe into the page. Will not use the default injection if set.
    
    Parameters:
    
    cb - function that will inject axe-core into the page
    
    stillInjectAxe - whether or not to still inject axe
  - analyze
```
public Results analyze(org.openqa.selenium.WebDriver webDriver,
                       org.openqa.selenium.WebElement... context)
```
    Run axe against a specific WebElement or webElements (including its descendants).
    
    Parameters:
    
    webDriver - for the page to be scanned
    
    context - WebElement(s) to test
    
    Returns:
    
    An axe results document
  - analyze
```
public Results analyze(org.openqa.selenium.WebDriver webDriver)
```
    Run axe against the entire page.
    
    Parameters:
    
    webDriver - for the page to be scanned
    
    Returns:
    
    An axe results document
  - analyze
```
public Results analyze(org.openqa.selenium.WebDriver webDriver,
                       boolean injectAxe)
```
    Run axe against the entire page.
    
    Parameters:
    
    webDriver - for the page to be scanned
    
    injectAxe - whether or not to inject axe into the page
    
    Returns:
    
    An axe results document

Class AxeBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

axeRunScript

unsafeAllOrigins

sameOrigin

iframeAllowScriptTemplate

hasRunPartialScript

sandboxBusterScript

Constructor Detail

AxeBuilder

AxeBuilder

AxeBuilder

Method Detail

getDefaultAxeBuilderOptions

setAxeScriptProvider

getAxeScriptProvider

setTimeout

getOptions

setOptions

withoutIframeSandboxes

disableIframeTesting

withOptions

withTags

withOnlyRules

withRules

disableRules

include

include

include

include

include

include

exclude

exclude

exclude

exclude

exclude

exclude

withOutputFile

setLegacyMode

setLegacyMode

setInjectAxe

setInjectAxe

analyze

analyze

analyze