com.jayway.android.robotium.remotecontrol.solo

Class RobotiumUtils

java.lang.Object

com.jayway.android.robotium.remotecontrol.solo.RobotiumUtils

public class RobotiumUtils
extends java.lang.Object

This class is used to process the methods of RobotiumUtils from the robotium-remote-control side.
This is only a wrapper class, the real implementation is in Solo class, refer to Solo

Usage:
RobotiumUtils utils = new RobotiumUtils(solo);

Since:

May 17, 2013

Author:

Lei Wang, SAS Institute, Inc

Constructor Summary

Constructors

Constructor and Description
RobotiumUtils(Solo solo)

Method Summary

Modifier and Type	Method and Description
java.util.List	filterViews(java.lang.String className, java.util.List<java.lang.String> viewUIDList) Filters Views based on the given class type.
java.util.List	filterViewsByText(java.util.List<java.lang.String> viewUIDList, java.lang.String regex) Filters a collection of Views and returns a list that contains only Views with text that matches a specified regular expression.
java.util.List	filterViewsToSet(java.util.List<java.lang.String> classNameList, java.util.List<java.lang.String> viewUIDList) Filters all Views not within the given set.
int	getNumberOfMatches(java.lang.String regex, java.lang.String textViewUID, java.util.Set<java.lang.String> matchedViewUIDList) Checks if a View matches a certain string and returns the amount of total matches.
java.util.List	removeInvisibleViews(java.util.List<java.lang.String> viewUIDList) Removes invisible Views.
void	sortViewsByLocationOnScreen(java.util.List<java.lang.String> viewUIDList) Orders Views by their location on-screen.
void	sortViewsByLocationOnScreen(java.util.List<java.lang.String> viewUIDList, boolean yAxisFirst) Orders Views by their location on-screen.

Methods inherited from class java.lang.Object

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

Constructor Detail

RobotiumUtils

public RobotiumUtils(Solo solo)

Method Detail

filterViews

public java.util.List filterViews(java.lang.String className,
                                  java.util.List<java.lang.String> viewUIDList)
                           throws java.lang.IllegalThreadStateException,
                                  RemoteException,
                                  java.util.concurrent.TimeoutException,
                                  ShutdownInvocationException

Filters Views based on the given class type.

Parameters:

className, - String, the class to filter

viewUIDList, - LIst, the list of UID for views to filter from

Returns:

a List of UID for filtered views

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

filterViewsByText

public java.util.List filterViewsByText(java.util.List<java.lang.String> viewUIDList,
                                        java.lang.String regex)
                                 throws java.lang.IllegalThreadStateException,
                                        RemoteException,
                                        java.util.concurrent.TimeoutException,
                                        ShutdownInvocationException

Filters a collection of Views and returns a list that contains only Views with text that matches a specified regular expression.

Parameters:

viewUIDList, - List The collection of UID for views to scan.

regex - The text pattern to search for.

Returns:

A list of UID for views whose text matches the given regex.

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

filterViewsToSet

public java.util.List filterViewsToSet(java.util.List<java.lang.String> classNameList,
                                       java.util.List<java.lang.String> viewUIDList)
                                throws java.lang.IllegalThreadStateException,
                                       RemoteException,
                                       java.util.concurrent.TimeoutException,
                                       ShutdownInvocationException

Filters all Views not within the given set.

Parameters:

classNameList, - List, contains 'full qualified class name' for all classes that are OK to pass the filter

viewList, - List, the list of UID for views to filter from

Returns:

a List of UID for filtered views

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

getNumberOfMatches

public int getNumberOfMatches(java.lang.String regex,
                              java.lang.String textViewUID,
                              java.util.Set<java.lang.String> matchedViewUIDList)
                       throws java.lang.IllegalThreadStateException,
                              RemoteException,
                              java.util.concurrent.TimeoutException,
                              ShutdownInvocationException

Checks if a View matches a certain string and returns the amount of total matches.

Parameters:

regex, - String, the regex to match

textViewUID, - String, the UID for view to check

matchedViewUIDList, - Set, set of UID for views that have matched

Returns:

number of total matches

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

removeInvisibleViews

public java.util.List removeInvisibleViews(java.util.List<java.lang.String> viewUIDList)
                                    throws java.lang.IllegalThreadStateException,
                                           RemoteException,
                                           java.util.concurrent.TimeoutException,
                                           ShutdownInvocationException

Removes invisible Views.

Parameters:

viewUIDList - an Iterable with UID for Views that are being checked for invisible Views.

Returns:

a List of UID for no invisible Views.

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

sortViewsByLocationOnScreen

public void sortViewsByLocationOnScreen(java.util.List<java.lang.String> viewUIDList)
                                 throws java.lang.IllegalThreadStateException,
                                        RemoteException,
                                        java.util.concurrent.TimeoutException,
                                        ShutdownInvocationException

Orders Views by their location on-screen.

Parameters:

viewUIDList, - List, a list of UID for the views to sort.

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException

sortViewsByLocationOnScreen

public void sortViewsByLocationOnScreen(java.util.List<java.lang.String> viewUIDList,
                                        boolean yAxisFirst)
                                 throws java.lang.IllegalThreadStateException,
                                        RemoteException,
                                        java.util.concurrent.TimeoutException,
                                        ShutdownInvocationException

Orders Views by their location on-screen.

Parameters:

viewUIDList, - List, a list of UID for the views to sort.

yAxisFirst - Whether the y-axis should be compared before the x-axis.

Throws:

java.lang.IllegalThreadStateException

RemoteException

java.util.concurrent.TimeoutException

ShutdownInvocationException