com.deque.worldspace

Class A11yTest.Builder

java.lang.Object

com.deque.worldspace.A11yTest.Builder

Enclosing class:

A11yTest

public static class A11yTest.Builder
extends java.lang.Object

Builder class for A11yTests.

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context, A11yNodeInfo nodeInfo) The only required elements for an accessibility tests are a context and the node info you want to test.
Builder(android.content.Context context, android.view.accessibility.AccessibilityNodeInfo nodeInfo) Convenience initializer that takes an AccessibilityNodeInfo instead.

Method Summary

Modifier and Type	Method and Description
A11yTest.Builder	addRule(java.lang.Class<? extends Rule> clazz) Add a single rule.
A11yTest	build() Build the test.
A11yTest.Builder	removeRule(java.lang.Class<? extends Rule> clazz) Remove a specific rule class from the test.
A11yTest.Builder	setRules(java.lang.Class<? extends Rule>[] rules) Changes the rules that will be run for the test.
A11yTest.Builder	setRules(java.lang.Iterable<java.lang.Class<? extends Rule>> rules) Changes the rules that will be run for the test.
A11yTest.Builder	setRules(Rule.RuleSet ruleSet) Changes the rules that will be run for the test.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(android.content.Context context,
               A11yNodeInfo nodeInfo)

The only required elements for an accessibility tests are a context and the node info you want to test. A default test runs against no rules.

Parameters:

context - The activity or application context that the rules will run against.

nodeInfo - The wrapped root AccessibilityNodeInfo or AccessibilityNodeInfoCompat to test.

Builder

public Builder(android.content.Context context,
               android.view.accessibility.AccessibilityNodeInfo nodeInfo)

Convenience initializer that takes an AccessibilityNodeInfo instead.

Parameters:

context - The activity or application context that the rules will run against.

nodeInfo - The root AccessibilityNodeInfo or AccessibilityNodeInfoCompat to test.

Method Detail

setRules

public A11yTest.Builder setRules(java.lang.Iterable<java.lang.Class<? extends Rule>> rules)

Changes the rules that will be run for the test.

Parameters:

rules - An iterable list of rule classes to test against.

Returns:

this

setRules

public A11yTest.Builder setRules(Rule.RuleSet ruleSet)

Changes the rules that will be run for the test.

Parameters:

ruleSet - One of our prebuilt rule sets.

Returns:

this

setRules

public A11yTest.Builder setRules(java.lang.Class<? extends Rule>[] rules)

Changes the rules that will be run for the test.

Parameters:

rules - An array of rule classes to test against.

Returns:

this

addRule

public A11yTest.Builder addRule(java.lang.Class<? extends Rule> clazz)

Add a single rule. If the list is full already, the list will be cleared before the rule is added.

Parameters:

clazz - The class of the rule to be added.

Returns:

this for method chaining.

removeRule

public A11yTest.Builder removeRule(java.lang.Class<? extends Rule> clazz)

Remove a specific rule class from the test.

Parameters:

clazz - The class of the rule to remove.

Returns:

build

public A11yTest build()

Build the test.

Returns:

The configured test object.