com.jayway.android.robotium.remotecontrol

Class By

java.lang.Object

com.jayway.android.robotium.remotecontrol.By

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

By.ClassName, By.CssSelector, By.Id, By.Name, By.TagName, By.Text, By.Xpath

public abstract class By
extends java.lang.Object
implements java.io.Serializable

From release4.0, Robotium begins to support some APIs who use com.jayway.android.robotium.solo.By as
parameter. To support this kind of APIs, this class was created, it implements interface Serializable
so that it can be transported as an object thru our TCP protocol.

In release 5.0.1, Robotium was refactored to use com.robotium.solo package

Example of usage:
At controller side, user can simply call xpath(String) etc. to get a By instance 'by'.
and send this object thru the wire.
At the device side, we receive that object 'by' and we call toSoloBy()
to get a Solo's By object, which can be used by Robotium's APIs.

This class copy the content of com.robotium.solo.By, if that class is modified, we needs
to update this class also.

Since:

May 14, 2013
Update MAR 17, 2014 to support com.robotium.solo package.

Author:

Lei Wang, SAS Institute, Inc

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	By.ClassName
(package private) static class	By.CssSelector
(package private) static class	By.Id
(package private) static class	By.Name
(package private) static class	By.TagName
(package private) static class	By.Text
(package private) static class	By.Xpath

Constructor Summary

Constructors

Constructor and Description
By()

Method Summary

Modifier and Type	Method and Description
static By	className(java.lang.String className) Select a WebElement by its class name.
static By	cssSelector(java.lang.String selectors) Select a WebElement by its css selector.
abstract java.lang.String	getStaticMethodName() Return the name of static method for creating a By instance.
java.lang.String	getValue() Returns the value.
static By	id(java.lang.String id) Select a WebElement by its id.
static By	name(java.lang.String name) Select a WebElement by its name.
static By	tagName(java.lang.String tagName) Select a WebElement by its tag name.
static By	textContent(java.lang.String textContent) Select a WebElement by its text content.
java.lang.Object	toSoloBy() Convert this class to com.jayway.android.robotium.solo.By with help of reflection. It is not suggested to call this method frequently.
static By	xpath(java.lang.String xpath) Select a WebElement by its xpath.

Methods inherited from class java.lang.Object

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

Constructor Detail

By

public By()

Method Detail

id

public static By id(java.lang.String id)

Select a WebElement by its id.

Parameters:

id - the id of the web element

Returns:

the Id object

xpath

public static By xpath(java.lang.String xpath)

Select a WebElement by its xpath.

Parameters:

xpath - the xpath of the web element

Returns:

the Xpath object

cssSelector

public static By cssSelector(java.lang.String selectors)

Select a WebElement by its css selector.

Parameters:

selectors - the css selector of the web element

Returns:

the CssSelector object

name

public static By name(java.lang.String name)

Select a WebElement by its name.

Parameters:

name - the name of the web element

Returns:

the Name object

className

public static By className(java.lang.String className)

Select a WebElement by its class name.

Parameters:

className - the class name of the web element

Returns:

the ClassName object

textContent

public static By textContent(java.lang.String textContent)

Select a WebElement by its text content.

Parameters:

textContent - the text content of the web element

Returns:

the TextContent object

tagName

public static By tagName(java.lang.String tagName)

Select a WebElement by its tag name.

Parameters:

tagName - the tag name of the web element

Returns:

the TagName object

getValue

public java.lang.String getValue()

Returns the value.

Returns:

the value

getStaticMethodName

public abstract java.lang.String getStaticMethodName()

Return the name of static method for creating a By instance.

Returns:

the name of static method for creating a By instance.

toSoloBy

public java.lang.Object toSoloBy()

Convert this class to com.jayway.android.robotium.solo.By with help of reflection.
It is not suggested to call this method frequently. User should store it in
a local variable and use that variable.

Returns:

Object, an object of com.robotium.solo.By