BySelector

public @NonNull BySelector checkable(boolean isCheckable)

Sets the search criteria to match elements that are checkable or not checkable.

public @NonNull BySelector checked(boolean isChecked)

Sets the search criteria to match elements that are checked or unchecked.

public @NonNull BySelector clazz(@NonNull Pattern className)

Sets the class name criteria for matching. A UI element will be considered a match if its full class name matches the classNamePattern and all other criteria for this selector are met.

public @NonNull BySelector clazz(@NonNull String className)

Sets the class name criteria for matching. A UI element will be considered a match if its class name exactly matches the className parameter and all other criteria for this selector are met. If className starts with a period, it is assumed to be in the android.widget package.

public @NonNull BySelector clazz(@NonNull Class clazz)

Sets the class name criteria for matching. A UI element will be considered a match if its class name matches clazz and all other criteria for this selector are met.

public @NonNull BySelector clazz(@NonNull String packageName, @NonNull String className)

Sets the class name criteria for matching. A UI element will be considered a match if its package and class name exactly match the packageName and className parameters and all other criteria for this selector are met.

public @NonNull BySelector clickable(boolean isClickable)

Sets the search criteria to match elements that are clickable or not clickable.

public @NonNull BySelector depth(int exactDepth)

Sets the search criteria to match elements that are at a certain depth.

public @NonNull BySelector depth(int min, int max)

Sets the search criteria to match elements that are in a range of depths.

public @NonNull BySelector desc(@NonNull Pattern contentDescription)

Sets the content description criteria for matching. A UI element will be considered a match if its content description matches the contentDescriptionPattern and all other criteria for this selector are met.

public @NonNull BySelector desc(@NonNull String contentDescription)

Sets the content description criteria for matching. A UI element will be considered a match if its content description exactly matches the contentDescription parameter and all other criteria for this selector are met.

public @NonNull BySelector descContains(@NonNull String substring)

Sets the content description criteria for matching. A UI element will be considered a match if its content description contains the substring parameter and all other criteria for this selector are met.

public @NonNull BySelector descEndsWith(@NonNull String suffix)

Sets the content description criteria for matching. A UI element will be considered a match if its content description ends with the suffix parameter and all other criteria for this selector are met.

public @NonNull BySelector descStartsWith(@NonNull String prefix)

Sets the content description criteria for matching. A UI element will be considered a match if its content description starts with the prefix parameter and all other criteria for this selector are met.

@RequiresApi(value = 30)
public @NonNull BySelector displayId(int displayId)

Adds a display ID selector criteria for matching. A UI element will be considered a match if it is within the display with the ID of displayId and all other criteria for this selector are met.

public @NonNull BySelector enabled(boolean isEnabled)

Sets the search criteria to match elements that are enabled or disabled.

public @NonNull BySelector focusable(boolean isFocusable)

Sets the search criteria to match elements that are focusable or not focusable.

public @NonNull BySelector focused(boolean isFocused)

Sets the search criteria to match elements that are focused or unfocused.

public @NonNull BySelector hasAncestor(@NonNull BySelector ancestorSelector)

Adds an ancestor selector criteria for matching. A UI element will be considered a match if it has an ancestor element which matches the ancestorSelector and all other criteria for this selector are met.

public @NonNull BySelector hasAncestor(
    @NonNull BySelector ancestorSelector,
    @IntRange(from = 1) int maxAncestorDistance
)

Adds an ancestor selector criteria for matching. A UI element will be considered a match if it has an ancestor element which matches the ancestorSelector and all other criteria for this selector are met.

public @NonNull BySelector hasChild(@NonNull BySelector childSelector)

Adds a child selector criteria for matching. A UI element will be considered a match if it has a child element (direct descendant) which matches the childSelector and all other criteria for this selector are met. If specified more than once, matches must be found for all childSelectors.

public @NonNull BySelector hasDescendant(@NonNull BySelector descendantSelector)

Adds a descendant selector criteria for matching. A UI element will be considered a match if it has a descendant element which matches the descendantSelector and all other criteria for this selector are met. If specified more than once, matches must be found for all descendantSelectors.

public @NonNull BySelector hasDescendant(@NonNull BySelector descendantSelector, int maxDepth)

Adds a descendant selector criteria for matching. A UI element will be considered a match if it has a descendant element which matches the descendantSelector and all other criteria for this selector are met. If specified more than once, matches must be found for all descendantSelectors.

public @NonNull BySelector hasParent(@NonNull BySelector parentSelector)

Adds a parent selector criteria for matching. A UI element will be considered a match if it has a parent element (direct ancestor) which matches the parentSelector and all other criteria for this selector are met.

@RequiresApi(value = 26)
public @NonNull BySelector hint(@NonNull Pattern hintValue)

Sets the hint value criteria for matching. A UI element will be considered a match if its hint value matches the hintValuePattern and all other criteria for this selector are met.

Hint text is displayed when there's no user input text.

@RequiresApi(value = 26)
public @NonNull BySelector hint(@NonNull String hintValue)

Sets the hint value criteria for matching. A UI element will be considered a match if its hint value exactly matches the hintValue parameter and all other criteria for this selector are met.

Hint text is displayed when there's no user input text.

@RequiresApi(value = 26)
public @NonNull BySelector hintContains(@NonNull String substring)

Sets the hint value criteria for matching. A UI element will be considered a match if its hint value contains the substring parameter and all other criteria for this selector are met.

Hint text is displayed when there's no user input text.

@RequiresApi(value = 26)
public @NonNull BySelector hintEndsWith(@NonNull String suffix)

Sets the hint value criteria for matching. A UI element will be considered a match if its hint value ends with the suffix parameter and all other criteria for this selector are met.

Hint text is displayed when there's no user input text.

@RequiresApi(value = 26)
public @NonNull BySelector hintStartsWith(@NonNull String prefix)

Sets the hint value criteria for matching. A UI element will be considered a match if its hint value starts with the prefix parameter and all other criteria for this selector are met.

Hint text is displayed when there's no user input text.

public @NonNull BySelector longClickable(boolean isLongClickable)

Sets the search criteria to match elements that are long clickable or not long clickable.

public @NonNull BySelector maxDepth(int max)

Sets the search criteria to match elements that are no more than a certain depth.

public @NonNull BySelector minDepth(int min)

Sets the search criteria to match elements that are at least a certain depth.

public @NonNull BySelector pkg(@NonNull Pattern applicationPackage)

Sets the package name criteria for matching. A UI element will be considered a match if its application package name matches the applicationPackagePattern and all other criteria for this selector are met.

public @NonNull BySelector pkg(@NonNull String applicationPackage)

Sets the application package name criteria for matching. A UI element will be considered a match if its application package name exactly matches the applicationPackage parameter and all other criteria for this selector are met.

public @NonNull BySelector res(@NonNull Pattern resourceName)

Sets the resource name criteria for matching. A UI element will be considered a match if its resource name matches the resourceNamePattern and all other criteria for this selector are met.

public @NonNull BySelector res(@NonNull String resourceName)

Sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the resourceName parameter and all other criteria for this selector are met.

public @NonNull BySelector res(@NonNull String resourcePackage, @NonNull String resourceId)

Sets the resource name criteria for matching. A UI element will be considered a match if its resource package and resource id exactly match the resourcePackage and resourceId parameters and all other criteria for this selector are met.

public @NonNull BySelector scrollable(boolean isScrollable)

Sets the search criteria to match elements that are scrollable or not scrollable.

public @NonNull BySelector selected(boolean isSelected)

Sets the search criteria to match elements that are selected or not selected.

public @NonNull BySelector text(@NonNull Pattern textValue)

Sets the text value criteria for matching. A UI element will be considered a match if its text value matches the textValuePattern and all other criteria for this selector are met.

public @NonNull BySelector text(@NonNull String textValue)

Sets the text value criteria for matching. A UI element will be considered a match if its text value exactly matches the textValue parameter and all other criteria for this selector are met.

public @NonNull BySelector textContains(@NonNull String substring)

Sets the text value criteria for matching. A UI element will be considered a match if its text value contains the substring parameter and all other criteria for this selector are met.

public @NonNull BySelector textEndsWith(@NonNull String suffix)

Sets the text value criteria for matching. A UI element will be considered a match if its text value ends with the suffix parameter and all other criteria for this selector are met.

public @NonNull BySelector textStartsWith(@NonNull String prefix)

Sets the text value criteria for matching. A UI element will be considered a match if its text value starts with the prefix parameter and all other criteria for this selector are met.

public String toString()

Returns a String representation of this BySelector. The format is "BySelector [=' ... ]". Each criteria is listed as a key-value pair where the key is the name of the criteria expressed in all caps (e.g. CLAZZ, RES, etc).