By (droiddriver 1.0.0-SNAPSHOT API)

java.lang.Object
- io.appium.droiddriver.finders.By

```
public class By
extends java.lang.Object
```
Convenience methods to create commonly used finders.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static MatchFinder`	`allOf(MatchFinder... finders)` Evaluates given `finders` in short-circuit fashion in the order they are passed.
`static MatchFinder`	`any()` Matches any UiElement.
`static MatchFinder`	`anyOf(MatchFinder... finders)` Evaluates given `finders` in short-circuit fashion in the order they are passed.
`static ChainFinder`	`chain(Finder first, Finder second)` Returns a finder that uses the UiElement returned by first Finder as context for the second Finder.
`static MatchFinder`	`className(java.lang.Class<?> clazz)` Matches a UiElement by class name.
`static MatchFinder`	`className(java.lang.String className)` Matches a UiElement by class name.
`static MatchFinder`	`contentDescription(java.lang.String contentDescription)` Matches a UiElement by content description.
`static MatchFinder`	`contentDescriptionContains(java.lang.String substring)` Matches a UiElement whose content description contains `substring`.
`static MatchFinder`	`is(Attribute attribute)` Matches a UiElement whose `attribute` is `true`.
`static MatchFinder`	`not(Attribute attribute)` Matches a UiElement whose `attribute` is `false` or is not set.
`static MatchFinder`	`not(MatchFinder finder)` Matches a UiElement that does not match the provided `finder`.
`static MatchFinder`	`packageName(java.lang.String name)` Matches a UiElement by package name.
`static MatchFinder`	`resourceId(int resourceId)` Matches a UiElement by a resource id defined in the AUT.
`static MatchFinder`	`resourceId(java.lang.String resourceId)` Matches a UiElement by the string representation of a resource id.
`static MatchFinder`	`selected()` Matches a UiElement that is selected.
`static MatchFinder`	`text(java.lang.String text)` Matches a UiElement by the exact text.
`static MatchFinder`	`textContains(java.lang.String substring)` Matches a UiElement whose text contains `substring`.
`static MatchFinder`	`textRegex(java.lang.String regex)` Matches a UiElement whose text matches `regex`.
`static MatchFinder`	`withAncestor(MatchFinder ancestorFinder)` Matches a UiElement whose ancestor matches the given ancestorFinder.
`static MatchFinder`	`withChild(MatchFinder childFinder)` Matches a UiElement which has a visible child matching the given childFinder.
`static MatchFinder`	`withDescendant(MatchFinder descendantFinder)` Matches a UiElement whose descendant (including self) matches the given descendantFinder.
`static MatchFinder`	`withParent(MatchFinder parentFinder)` Matches a UiElement whose parent matches the given parentFinder.
`static MatchFinder`	`withSibling(MatchFinder siblingFinder)` Matches a UiElement which has a visible sibling matching the given siblingFinder.
`static ByXPath`	`xpath(java.lang.String xPath)` Matches by XPath.

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

- Method Detail
  - any
```
public static MatchFinder any()
```
    Matches any UiElement.
  - is
```
public static MatchFinder is(Attribute attribute)
```
    Matches a UiElement whose attribute is true.
  - not
```
public static MatchFinder not(Attribute attribute)
```
    Matches a UiElement whose attribute is false or is not set.
  - resourceId
```
public static MatchFinder resourceId(int resourceId)
```
    Matches a UiElement by a resource id defined in the AUT.
  - resourceId
```
public static MatchFinder resourceId(java.lang.String resourceId)
```
    Matches a UiElement by the string representation of a resource id. This works for resources not belonging to the AUT.
  - packageName
```
public static MatchFinder packageName(java.lang.String name)
```
    Matches a UiElement by package name.
  - text
```
public static MatchFinder text(java.lang.String text)
```
    Matches a UiElement by the exact text.
  - textRegex
```
public static MatchFinder textRegex(java.lang.String regex)
```
    Matches a UiElement whose text matches regex.
  - textContains
```
public static MatchFinder textContains(java.lang.String substring)
```
    Matches a UiElement whose text contains substring.
  - contentDescription
```
public static MatchFinder contentDescription(java.lang.String contentDescription)
```
    Matches a UiElement by content description.
  - contentDescriptionContains
```
public static MatchFinder contentDescriptionContains(java.lang.String substring)
```
    Matches a UiElement whose content description contains substring.
  - className
```
public static MatchFinder className(java.lang.String className)
```
    Matches a UiElement by class name.
  - className
```
public static MatchFinder className(java.lang.Class<?> clazz)
```
    Matches a UiElement by class name.
  - selected
```
public static MatchFinder selected()
```
    Matches a UiElement that is selected.
  - xpath
```
public static ByXPath xpath(java.lang.String xPath)
```
    Matches by XPath. When applied on an non-root element, it will not evaluate above the context element.
    XPath is the domain-specific-language for navigating a node tree. It is ideal if the UiElement to match has a complex relationship with surrounding nodes. For simple cases, withParent(io.appium.droiddriver.finders.MatchFinder) or withAncestor(io.appium.droiddriver.finders.MatchFinder) are preferred, which can combine with other MatchFinders in allOf(io.appium.droiddriver.finders.MatchFinder...). For complex cases like below, XPath is superior:
```
 
 <View>
   <LinearLayout>
     <TextView text='Albums'/>
     <TextView text='4 MORE'/>
   </LinearLayout>
   <RelativeLayout>
     <TextView text='Forever'/>
     <ImageView/>
   </RelativeLayout>
 </View>
 
 
 
```
    If we need to locate the RelativeLayout containing the album "Forever" instead of a song or an artist named "Forever", this XPath works:
```
  //*[LinearLayout/*[@text='Albums']]/RelativeLayout[*[@text='Forever']]
 
```
    Parameters:
    
    xPath - The xpath to use
    
    Returns:
    
    a finder which locates elements via XPath
  - chain
```
public static ChainFinder chain(Finder first,
                                Finder second)
```
    Returns a finder that uses the UiElement returned by first Finder as context for the second Finder.
    typically first Finder finds the ancestor, then second Finder finds the target UiElement, which is a descendant.
    Note that if the first Finder matches multiple UiElements, only the first match is tried, which usually is not what callers expect. In this case, allOf(second, withAncesor(first)) may work.
  - allOf
```
public static MatchFinder allOf(MatchFinder... finders)
```
    Evaluates given finders in short-circuit fashion in the order they are passed. Costly finders (for example those returned by with* methods that navigate the node tree) should be passed after cheap finders (for example the ByAttribute finders).
    
    Returns:
    
    a finder that is the logical conjunction of given finders
  - anyOf
```
public static MatchFinder anyOf(MatchFinder... finders)
```
    Evaluates given finders in short-circuit fashion in the order they are passed. Costly finders (for example those returned by with* methods that navigate the node tree) should be passed after cheap finders (for example the ByAttribute finders).
    
    Returns:
    
    a finder that is the logical disjunction of given finders
  - withParent
```
public static MatchFinder withParent(MatchFinder parentFinder)
```
    Matches a UiElement whose parent matches the given parentFinder. For complex cases, consider xpath(java.lang.String).
  - withAncestor
```
public static MatchFinder withAncestor(MatchFinder ancestorFinder)
```
    Matches a UiElement whose ancestor matches the given ancestorFinder. For complex cases, consider xpath(java.lang.String).
  - withSibling
```
public static MatchFinder withSibling(MatchFinder siblingFinder)
```
    Matches a UiElement which has a visible sibling matching the given siblingFinder. This could be inefficient; consider xpath(java.lang.String).
  - withChild
```
public static MatchFinder withChild(MatchFinder childFinder)
```
    Matches a UiElement which has a visible child matching the given childFinder. This could be inefficient; consider xpath(java.lang.String).
  - withDescendant
```
public static MatchFinder withDescendant(MatchFinder descendantFinder)
```
    Matches a UiElement whose descendant (including self) matches the given descendantFinder. This could be VERY inefficient; consider xpath(java.lang.String).
  - not
```
public static MatchFinder not(MatchFinder finder)
```
    Matches a UiElement that does not match the provided finder.

Class By

Method Summary

Methods inherited from class java.lang.Object

Method Detail

any

is

not

resourceId

resourceId

packageName

text

textRegex

textContains

contentDescription

contentDescriptionContains

className

className

selected

xpath

chain

allOf

anyOf

withParent

withAncestor

withSibling

withChild

withDescendant

not