From debd2a7d41a62161671caee333a06b337e35270d Mon Sep 17 00:00:00 2001 From: Dirk Dougherty Date: Wed, 11 May 2016 10:35:08 -0700 Subject: [PATCH] Add updated Test Support lib docs to reference. Change-Id: Ib572c99c07890a9b91aa53154d937ac45605d122 --- .../support/test/InstrumentationRegistry.html | 1803 ++-- .../reference/android/support/test/_book.yaml | 89 + .../android/support/test/annotation/Beta.html | 959 +- .../support/test/annotation/UiThreadTest.html | 967 +- .../test/annotation/package-summary.html | 729 +- ...AmbiguousViewMatcherException.Builder.html | 2143 ++--- .../AmbiguousViewMatcherException.html | 2048 ++-- .../test/espresso/AppNotIdleException.html | 2299 ++--- .../test/espresso/BaseLayerComponent.html | 1262 +-- .../test/espresso/DataInteraction.html | 2086 ++-- .../support/test/espresso/Espresso.html | 2742 +++--- .../test/espresso/EspressoException.html | 983 +- .../support/test/espresso/FailureHandler.html | 975 +- .../support/test/espresso/GraphHolder.html | 1328 +-- .../support/test/espresso/IdlingPolicies.html | 1821 ++-- .../support/test/espresso/IdlingPolicy.html | 1647 ++-- .../IdlingResource.ResourceCallback.html | 922 +- .../support/test/espresso/IdlingResource.html | 1209 +-- .../IdlingResourceTimeoutException.html | 2091 ++-- .../InjectEventSecurityException.html | 2211 ++--- .../espresso/NoActivityResumedException.html | 2179 ++--- .../espresso/NoMatchingRootException.html | 2112 ++-- .../NoMatchingViewException.Builder.html | 2050 ++-- .../espresso/NoMatchingViewException.html | 2153 ++--- .../espresso/PerformException.Builder.html | 1864 ++-- .../test/espresso/PerformException.html | 2229 ++--- .../support/test/espresso/Root.Builder.html | 1675 ++-- .../android/support/test/espresso/Root.html | 1628 ++-- .../support/test/espresso/UiController.html | 1420 +-- .../support/test/espresso/ViewAction.html | 1352 +-- .../support/test/espresso/ViewAssertion.html | 951 +- .../support/test/espresso/ViewFinder.html | 987 +- .../test/espresso/ViewInteraction.html | 1804 ++-- .../espresso/ViewInteractionComponent.html | 917 +- .../action/AdapterDataLoaderAction.html | 2031 ++-- ...apterViewProtocol.AdaptedData.Builder.html | 1770 ++-- .../AdapterViewProtocol.AdaptedData.html | 1691 ++-- .../AdapterViewProtocol.DataFunction.html | 917 +- .../espresso/action/AdapterViewProtocol.html | 1433 +-- .../espresso/action/AdapterViewProtocols.html | 1429 +-- .../espresso/action/CloseKeyboardAction.html | 1922 ++-- .../espresso/action/CoordinatesProvider.html | 988 +- .../test/espresso/action/EditorAction.html | 1922 ++-- .../espresso/action/EspressoKey.Builder.html | 1902 ++-- .../test/espresso/action/EspressoKey.html | 1630 ++-- .../espresso/action/GeneralClickAction.html | 2051 ++-- .../test/espresso/action/GeneralLocation.html | 2926 +++--- .../espresso/action/GeneralSwipeAction.html | 1954 ++-- .../test/espresso/action/KeyEventAction.html | 2168 ++--- .../action/MotionEvents.DownResultHolder.html | 1467 +-- .../test/espresso/action/MotionEvents.html | 1886 ++-- .../test/espresso/action/OpenLinkAction.html | 1940 ++-- .../espresso/action/PrecisionDescriber.html | 970 +- .../support/test/espresso/action/Press.html | 2444 ++--- .../espresso/action/ReplaceTextAction.html | 1933 ++-- .../test/espresso/action/ScrollToAction.html | 1922 ++-- .../support/test/espresso/action/Swipe.html | 2334 ++--- .../test/espresso/action/Swiper.Status.html | 2224 ++--- .../support/test/espresso/action/Swiper.html | 1064 +-- .../support/test/espresso/action/Tap.html | 2444 ++--- .../test/espresso/action/Tapper.Status.html | 2286 ++--- .../support/test/espresso/action/Tapper.html | 1049 +- .../test/espresso/action/TypeTextAction.html | 2075 ++-- .../test/espresso/action/ViewActions.html | 4421 ++++----- .../test/espresso/action/package-summary.html | 1117 +-- .../espresso/assertion/LayoutAssertions.html | 1656 ++-- .../assertion/PositionAssertions.html | 2263 ++--- .../espresso/assertion/ViewAssertions.html | 1578 ++- .../espresso/assertion/package-summary.html | 755 +- .../test/espresso/base/ActiveRootLister.html | 906 +- .../BaseLayerModule.FailureHandlerHolder.html | 1551 +-- .../test/espresso/base/BaseLayerModule.html | 2201 ++--- .../support/test/espresso/base/Default.html | 993 +- .../espresso/base/DefaultFailureHandler.html | 1584 ++- .../espresso/base/IdlingResourceRegistry.html | 1804 ++-- .../test/espresso/base/MainThread.html | 993 +- .../test/espresso/base/RootViewPicker.html | 1471 +-- .../espresso/base/UiControllerModule.html | 1463 +-- .../test/espresso/base/ViewFinderImpl.html | 1514 +-- .../test/espresso/base/package-summary.html | 875 +- .../espresso/contrib/AccessibilityChecks.html | 1474 +-- .../contrib/CountingIdlingResource.html | 2289 ++--- .../test/espresso/contrib/DrawerActions.html | 2108 ++-- .../test/espresso/contrib/DrawerMatchers.html | 1698 ++-- .../contrib/NavigationViewActions.html | 736 ++ .../test/espresso/contrib/PickerActions.html | 1521 +-- ...ctions.PositionableRecyclerViewAction.html | 1106 +-- .../espresso/contrib/RecyclerViewActions.html | 2106 ++-- .../espresso/contrib/package-summary.html | 844 +- .../idling/CountingIdlingResource.html | 1302 +++ .../test/espresso/idling/package-summary.html | 218 + .../support/test/espresso/intent/Checks.html | 1966 ++-- .../support/test/espresso/intent/Intents.html | 2049 ++-- .../test/espresso/intent/OngoingStubbing.html | 1387 +-- .../espresso/intent/ResettingStubber.html | 1296 +-- .../espresso/intent/ResettingStubberImpl.html | 2156 ++--- .../test/espresso/intent/ResolvedIntent.html | 1021 +- .../espresso/intent/VerifiableIntent.html | 1113 +-- .../espresso/intent/VerificationMode.html | 892 +- .../espresso/intent/VerificationModes.html | 1484 +-- .../intent/matcher/BundleMatchers.html | 1939 ++-- .../intent/matcher/ComponentNameMatchers.html | 1923 ++-- .../intent/matcher/IntentMatchers.html | 3866 ++++---- .../espresso/intent/matcher/UriMatchers.html | 2417 ++--- .../intent/matcher/package-summary.html | 771 +- .../test/espresso/intent/package-summary.html | 847 +- .../espresso/intent/rule/IntentsTestRule.html | 2398 ++--- .../espresso/intent/rule/package-summary.html | 727 +- .../test/espresso/matcher/BoundedMatcher.html | 2110 ++-- .../matcher/CursorMatchers.CursorMatcher.html | 2153 ++--- .../test/espresso/matcher/CursorMatchers.html | 6205 ++++++------ .../test/espresso/matcher/LayoutMatchers.html | 1473 +-- .../espresso/matcher/PreferenceMatchers.html | 2111 ++-- .../test/espresso/matcher/RootMatchers.html | 1845 ++-- .../matcher/ViewMatchers.Visibility.html | 2318 ++--- .../test/espresso/matcher/ViewMatchers.html | 6941 +++++++------- .../espresso/matcher/package-summary.html | 835 +- .../test/espresso/package-summary.html | 1111 +-- .../espresso/util/ActivityLifecycles.html | 1625 ++-- .../test/espresso/util/HumanReadables.html | 1635 ++-- .../util/TreeIterables.ViewAndDistance.html | 1439 +-- .../test/espresso/util/TreeIterables.html | 1656 ++-- .../test/espresso/util/package-summary.html | 763 +- .../test/espresso/web/action/AtomAction.html | 2270 ++--- .../web/action/EnableJavascriptAction.html | 1850 ++-- .../espresso/web/action/package-summary.html | 739 +- .../web/assertion/TagSoupDocumentParser.html | 1492 +-- .../espresso/web/assertion/WebAssertion.html | 1655 ++-- .../WebViewAssertions.ResultDescriber.html | 868 +- .../web/assertion/WebViewAssertions.html | 1682 ++-- .../web/assertion/package-summary.html | 781 +- .../test/espresso/web/bridge/Conduit.html | 1590 ++- .../espresso/web/bridge/JavaScriptBridge.html | 1517 +-- .../espresso/web/bridge/package-summary.html | 739 +- .../AmbiguousElementMatcherException.html | 2027 ++-- .../espresso/web/matcher/DomMatchers.html | 2133 ++--- .../espresso/web/matcher/package-summary.html | 751 +- .../support/test/espresso/web/model/Atom.html | 1171 +-- .../test/espresso/web/model/Atoms.html | 2041 ++-- .../espresso/web/model/ElementReference.html | 1736 ++-- .../test/espresso/web/model/Evaluation.html | 2072 ++-- .../web/model/JSONAble.DeJSONFactory.html | 919 +- .../test/espresso/web/model/JSONAble.html | 983 +- .../test/espresso/web/model/ModelCodec.html | 1703 ++-- .../SimpleAtom.ElementReferencePlacement.html | 2184 ++--- .../test/espresso/web/model/SimpleAtom.html | 2437 ++--- .../model/TransformingAtom.Transformer.html | 892 +- .../espresso/web/model/TransformingAtom.html | 1956 ++-- .../espresso/web/model/WindowReference.html | 1736 ++-- .../espresso/web/model/package-summary.html | 891 +- .../web/sugar/Web.WebInteraction.html | 2576 +++-- .../support/test/espresso/web/sugar/Web.html | 1548 +-- .../espresso/web/sugar/package-summary.html | 739 +- .../espresso/web/webdriver/DriverAtoms.html | 2468 ++--- .../test/espresso/web/webdriver/Locator.html | 2668 +++--- .../web/webdriver/package-summary.html | 753 +- .../support/test/filters/FlakyTest.html | 965 +- .../support/test/filters/LargeTest.html | 491 + .../support/test/filters/MediumTest.html | 492 + .../support/test/filters/RequiresDevice.html | 965 +- .../support/test/filters/SdkSuppress.html | 965 +- .../support/test/filters/SmallTest.html | 493 + .../support/test/filters/Suppress.html | 483 + .../support/test/filters/package-summary.html | 780 +- .../android/support/test/jank/GfxMonitor.html | 2284 ++--- .../android/support/test/jank/IMonitor.html | 519 + .../support/test/jank/IMonitorFactory.html | 416 + .../android/support/test/jank/JankTest.html | 977 +- .../support/test/jank/JankTestBase.html | 4966 +++++----- .../jank/annotations/UseMonitorFactory.html | 472 + .../jank/annotations/package-summary.html | 217 + .../support/test/jank/package-summary.html | 799 +- .../reference/android/support/test/lists.js | 232 + .../android/support/test/navtree_data.js | 84 + .../android/support/test/package-summary.html | 727 +- .../support/test/rule/ActivityTestRule.html | 2820 +++--- .../test/rule/DisableOnAndroidDebug.html | 1684 ++-- .../support/test/rule/ServiceTestRule.html | 2329 ++--- .../support/test/rule/UiThreadTestRule.html | 1845 ++-- .../test/rule/logging/AtraceLogger.html | 892 ++ .../rule/logging/EnableTestTracingRule.html | 1276 +++ .../logging/LogBatteryInformationRule.html | 1402 +++ .../logging/LogDeviceGetPropInfoRule.html | 1343 +++ .../rule/logging/LogGraphicsStatsRule.html | 1342 +++ .../test/rule/logging/LogLogcatRule.html | 1525 +++ .../test/rule/logging/LogNetStatsRule.html | 1328 +++ .../test/rule/logging/LoggingBaseRule.html | 1600 ++++ .../test/rule/logging/RuleLoggingUtils.html | 1927 ++++ .../test/rule/logging/package-summary.html | 321 + .../support/test/rule/package-summary.html | 765 +- .../support/test/runner/AndroidJUnit4.html | 4000 ++++---- .../test/runner/AndroidJUnitRunner.html | 5476 +++++------ ...oringInstrumentation.ActivityFinisher.html | 1504 +-- .../runner/MonitoringInstrumentation.html | 6389 +++++++------ .../test/runner/UsageTrackerFacilitator.html | 921 ++ .../test/runner/intent/IntentCallback.html | 875 +- .../test/runner/intent/IntentMonitor.html | 975 +- .../runner/intent/IntentMonitorRegistry.html | 1482 +-- .../test/runner/intent/IntentStubber.html | 935 +- .../runner/intent/IntentStubberRegistry.html | 1663 ++-- .../test/runner/intent/package-summary.html | 803 +- .../lifecycle/ActivityLifecycleCallback.html | 911 +- .../lifecycle/ActivityLifecycleMonitor.html | 1267 +-- .../ActivityLifecycleMonitorRegistry.html | 1511 +-- .../ApplicationLifecycleCallback.html | 911 +- .../ApplicationLifecycleMonitor.html | 996 +- .../ApplicationLifecycleMonitorRegistry.html | 1511 +-- .../runner/lifecycle/ApplicationStage.html | 2178 ++--- .../support/test/runner/lifecycle/Stage.html | 2602 ++--- .../runner/lifecycle/package-summary.html | 843 +- .../support/test/runner/package-summary.html | 775 +- .../android/support/test/uiautomator/By.html | 5191 +++++----- .../support/test/uiautomator/BySelector.html | 5881 +++++------- .../test/uiautomator/Configurator.html | 2719 +++--- .../support/test/uiautomator/Direction.html | 2489 ++--- .../test/uiautomator/EventCondition.html | 1387 +-- .../test/uiautomator/IAutomationSupport.html | 932 +- .../test/uiautomator/SearchCondition.html | 1387 +-- .../uiautomator/StaleObjectException.html | 2056 ++-- .../UiAutomatorInstrumentationTestRunner.html | 5048 +++++----- .../test/uiautomator/UiAutomatorTestCase.html | 4556 +++++---- .../test/uiautomator/UiCollection.html | 4498 ++++----- .../support/test/uiautomator/UiDevice.html | 8489 ++++++++--------- .../support/test/uiautomator/UiObject.html | 7789 +++++++-------- .../support/test/uiautomator/UiObject2.html | 6407 ++++++------- .../test/uiautomator/UiObject2Condition.html | 1387 +-- .../UiObjectNotFoundException.html | 2186 ++--- .../test/uiautomator/UiScrollable.html | 7886 ++++++++------- .../support/test/uiautomator/UiSelector.html | 5221 +++++----- .../support/test/uiautomator/UiWatcher.html | 934 +- .../support/test/uiautomator/Until.html | 4607 ++++----- .../test/uiautomator/package-summary.html | 1033 +- 232 files changed, 168314 insertions(+), 255016 deletions(-) create mode 100644 docs/html/reference/android/support/test/_book.yaml create mode 100644 docs/html/reference/android/support/test/espresso/contrib/NavigationViewActions.html create mode 100644 docs/html/reference/android/support/test/espresso/idling/CountingIdlingResource.html create mode 100644 docs/html/reference/android/support/test/espresso/idling/package-summary.html create mode 100644 docs/html/reference/android/support/test/filters/LargeTest.html create mode 100644 docs/html/reference/android/support/test/filters/MediumTest.html create mode 100644 docs/html/reference/android/support/test/filters/SmallTest.html create mode 100644 docs/html/reference/android/support/test/filters/Suppress.html create mode 100644 docs/html/reference/android/support/test/jank/IMonitor.html create mode 100644 docs/html/reference/android/support/test/jank/IMonitorFactory.html create mode 100644 docs/html/reference/android/support/test/jank/annotations/UseMonitorFactory.html create mode 100644 docs/html/reference/android/support/test/jank/annotations/package-summary.html create mode 100644 docs/html/reference/android/support/test/lists.js create mode 100644 docs/html/reference/android/support/test/navtree_data.js create mode 100644 docs/html/reference/android/support/test/rule/logging/AtraceLogger.html create mode 100644 docs/html/reference/android/support/test/rule/logging/EnableTestTracingRule.html create mode 100644 docs/html/reference/android/support/test/rule/logging/LogBatteryInformationRule.html create mode 100644 docs/html/reference/android/support/test/rule/logging/LogDeviceGetPropInfoRule.html create mode 100644 docs/html/reference/android/support/test/rule/logging/LogGraphicsStatsRule.html create mode 100644 docs/html/reference/android/support/test/rule/logging/LogLogcatRule.html create mode 100644 docs/html/reference/android/support/test/rule/logging/LogNetStatsRule.html create mode 100644 docs/html/reference/android/support/test/rule/logging/LoggingBaseRule.html create mode 100644 docs/html/reference/android/support/test/rule/logging/RuleLoggingUtils.html create mode 100644 docs/html/reference/android/support/test/rule/logging/package-summary.html create mode 100644 docs/html/reference/android/support/test/runner/UsageTrackerFacilitator.html diff --git a/docs/html/reference/android/support/test/InstrumentationRegistry.html b/docs/html/reference/android/support/test/InstrumentationRegistry.html index b4c4559586f2..d08513caab26 100644 --- a/docs/html/reference/android/support/test/InstrumentationRegistry.html +++ b/docs/html/reference/android/support/test/InstrumentationRegistry.html @@ -1,4 +1,3 @@ - @@ -93,481 +92,85 @@ - - - - - - -InstrumentationRegistry | Android Developers - - - - - - - - - - - - - - - - - - - -
- +InstrumentationRegistry - -
- - - - - - - - - - - -
- - - - - - - -
+
+
+ + + +
- - - - - + + + + + + -
- - - - -
+
-
- public - - final - - class -

InstrumentationRegistry

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - +

InstrumentationRegistry

+

+ + public + + final + + class + InstrumentationRegistry + +
+ + + + + extends Object + + + + + + + + + + + +

java.lang.Object
   ↳android.support.test.InstrumentationRegistry
+ + + + + + + + + + + + + + +
java.lang.Object +
   ↳android.support.test.InstrumentationRegistry +
+ + +

- - - -
- - -

Class Overview

-

An exposed registry instance that holds a reference to the instrumentation running in the +

An exposed registry instance that holds a reference to the instrumentation running in the process and it's arguments. Also provides an easy way for callers to get a hold of instrumentation, application context and instrumentation arguments Bundle.

@@ -672,27 +266,9 @@ Summary: -
- - - - - - - - - - - - - - -
- - -

Summary

+

Summary

@@ -721,125 +297,146 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - +
Public Methods
- - - - static - - Bundle - - getArguments() - -
- Returns a copy of instrumentation arguments Bundle. - - - -
- -
- - - - static - - Context - - getContext() - -
- Return the Context of this instrumentation's package. - - - -
- -
- - - - static - - Instrumentation - - getInstrumentation() - -
- Returns the instrumentation currently running. - - - -
- -
+ - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + +

+ + + +

Public methods

- - static - - Context - - getTargetContext() - -
- Return a Context for the target application being instrumented. - - - -
- -
- - - - static - - void - - registerInstance(Instrumentation instrumentation, Bundle arguments) - -
- Records/exposes the instrumentation currently running and stores a copy of the + +
+ + + static + + + Bundle + + + getArguments() + + +

Returns a copy of instrumentation arguments Bundle. + + +

+ +
+ + + static + + + Context + + + getContext() + + +

Return the Context of this instrumentation's package. + + +

+ +
+ + + static + + + Instrumentation + + + getInstrumentation() + + +

Returns the instrumentation currently running. + + +

+ +
+ + + static + + + Context + + + getTargetContext() + + +

Return a Context for the target application being instrumented. + + +

+ +
+ + + static + + + void + + + registerInstance(Instrumentation instrumentation, Bundle arguments) + + +

Records/exposes the instrumentation currently running and stores a copy of the instrumentation arguments Bundle in the registry. - - - - - -

@@ -851,207 +448,276 @@ Summary: - +
- [Expand] -
Inherited Methods
+ - @@ -1060,16 +726,6 @@ From class

Inherited methods

- -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
-
- - - - - - - - - @@ -1095,218 +751,188 @@ From class -

Public Methods

+

Public methods

-
-

- - public - static - - - - Bundle - - getArguments - () -

-
-
- +
+

getArguments

+
+
+ + - -
-
- - - - -

Returns a copy of instrumentation arguments Bundle. Use this to get a Bundle - containing the command line arguments passed to Instrumentation into your test. +

+
+Bundle getArguments ()
+ + + + +

Returns a copy of instrumentation arguments Bundle. Use this to get a Bundle + containing the command line arguments passed to Instrumentation into your test.

This Bundle is not guaranteed to be present under all instrumentations. -

-
-
Returns
-
  • Bundle the arguments for this instrumentation.
-
-
-
Throws
- +

+
+ + + + + +
Returns
BundleBundle the arguments for this instrumentation.
+ + - +
Throws
IllegalStateException - if no argument Bundle has been registered. + IllegalStateExceptionif no argument Bundle has been registered.
-
+ -
-
-

- - public - static - - - - Context - - getContext - () -

-
-
- - - -
-
- - - - -

Return the Context of this instrumentation's package. Use this to get a - Context representing getContext() into your test. -

+
+

getContext

+
+
+ +
+
+Context getContext ()
+ + + + +

Return the Context of this instrumentation's package. Use this to get a + Context representing getContext() into your test. +

+ + + + + + +
Returns
Context
+
-
-

- - public - static - - - - Instrumentation - - getInstrumentation - () -

-
-
- - +
+

getInstrumentation

+
+
+ + -
-
- - - - -

Returns the instrumentation currently running. Use this to get an Instrumentation - into your test.

-
-
Throws
- + +
+Instrumentation getInstrumentation ()
+ + + + +

Returns the instrumentation currently running. Use this to get an Instrumentation + into your test.

+
+ + + + + +
Returns
Instrumentation
+ + - +
Throws
IllegalStateException - if instrumentation hasn't been registered + IllegalStateExceptionif instrumentation hasn't been registered
-
+ -
-
-

- - public - static - - - - Context - - getTargetContext - () -

-
-
- - - -
-
- - - - -

Return a Context for the target application being instrumented. Use this to get a - Context representing getTargetContext() into your test. -

+
+

getTargetContext

+
+
+ +
+
+Context getTargetContext ()
+ + + + +

Return a Context for the target application being instrumented. Use this to get a + Context representing getTargetContext() into your test. +

+ + + + + + +
Returns
Context
+
-
-

- - public - static - - - - void - - registerInstance - (Instrumentation instrumentation, Bundle arguments) -

-
-
- - - -
-
+
+

registerInstance

+
+
+ + - - - -

Records/exposes the instrumentation currently running and stores a copy of the +

+
+void registerInstance (Instrumentation instrumentation, 
+                Bundle arguments)
+ + + + +

Records/exposes the instrumentation currently running and stores a copy of the instrumentation arguments Bundle in the registry.

This is a global registry - so be aware of the impact of calling this method! -

-
-
Parameters
- - - - - - +
instrumentation - the instrumentation currently running.
arguments - the arguments for this application. Null deregisters any existing arguments. +

+ + + + + + + + + - -
Parameters
instrumentation + Instrumentation: + the instrumentation currently running.
arguments + Bundle: + the arguments for this application. Null deregisters any existing arguments.
- +
-
@@ -1318,193 +944,28 @@ From class - -
- -
- -
- - - -
-
-
+
+
+ + + +
diff --git a/docs/html/reference/android/support/test/_book.yaml b/docs/html/reference/android/support/test/_book.yaml new file mode 100644 index 000000000000..3cd704cc6449 --- /dev/null +++ b/docs/html/reference/android/support/test/_book.yaml @@ -0,0 +1,89 @@ + +reference: +- title: android.support.test + path: /reference/android/support/test/package-summary.html + status_text: apilevel- +- title: android.support.test.annotation + path: /reference/android/support/test/annotation/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso + path: /reference/android/support/test/espresso/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.action + path: /reference/android/support/test/espresso/action/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.assertion + path: /reference/android/support/test/espresso/assertion/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.base + path: /reference/android/support/test/espresso/base/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.contrib + path: /reference/android/support/test/espresso/contrib/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.idling + path: /reference/android/support/test/espresso/idling/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.intent + path: /reference/android/support/test/espresso/intent/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.intent.matcher + path: /reference/android/support/test/espresso/intent/matcher/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.intent.rule + path: /reference/android/support/test/espresso/intent/rule/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.matcher + path: /reference/android/support/test/espresso/matcher/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.util + path: /reference/android/support/test/espresso/util/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.web.action + path: /reference/android/support/test/espresso/web/action/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.web.assertion + path: /reference/android/support/test/espresso/web/assertion/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.web.bridge + path: /reference/android/support/test/espresso/web/bridge/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.web.matcher + path: /reference/android/support/test/espresso/web/matcher/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.web.model + path: /reference/android/support/test/espresso/web/model/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.web.sugar + path: /reference/android/support/test/espresso/web/sugar/package-summary.html + status_text: apilevel- +- title: android.support.test.espresso.web.webdriver + path: /reference/android/support/test/espresso/web/webdriver/package-summary.html + status_text: apilevel- +- title: android.support.test.filters + path: /reference/android/support/test/filters/package-summary.html + status_text: apilevel- +- title: android.support.test.jank + path: /reference/android/support/test/jank/package-summary.html + status_text: apilevel- +- title: android.support.test.jank.annotations + path: /reference/android/support/test/jank/annotations/package-summary.html + status_text: apilevel- +- title: android.support.test.rule + path: /reference/android/support/test/rule/package-summary.html + status_text: apilevel- +- title: android.support.test.rule.logging + path: /reference/android/support/test/rule/logging/package-summary.html + status_text: apilevel- +- title: android.support.test.runner + path: /reference/android/support/test/runner/package-summary.html + status_text: apilevel- +- title: android.support.test.runner.intent + path: /reference/android/support/test/runner/intent/package-summary.html + status_text: apilevel- +- title: android.support.test.runner.lifecycle + path: /reference/android/support/test/runner/lifecycle/package-summary.html + status_text: apilevel- +- title: android.support.test.uiautomator + path: /reference/android/support/test/uiautomator/package-summary.html + status_text: apilevel- diff --git a/docs/html/reference/android/support/test/annotation/Beta.html b/docs/html/reference/android/support/test/annotation/Beta.html index a5addc03a11f..4b604f6b4ef0 100644 --- a/docs/html/reference/android/support/test/annotation/Beta.html +++ b/docs/html/reference/android/support/test/annotation/Beta.html @@ -1,4 +1,3 @@ - @@ -93,482 +92,85 @@ - - - - - - -Beta | Android Developers - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - - - - - - - -
- - - + + -
+
+
+ + + +
- - - - - + + + + + + -
- - - - -
+
-
- public - - - abstract - @interface -

Beta

- - - - - +

Beta

+

+ + public + + + abstract + @interface + Beta + +
+ + + + + implements - + Annotation + + + + +

- - - - - - - -
- -
-
- - - - - - - + + + + +
android.support.test.annotation.Beta
android.support.test.annotation.Beta +
+ + +

- - - -
- - -

Class Overview

-

Signifies that a public API (public class, method or field) is subject to +

Signifies that a public API (public class, method or field) is subject to incompatible changes, or even removal, in a future release. An API bearing this annotation is exempt from any compatibility guarantees made by its containing library. Note that the presence of this annotation implies nothing @@ -664,27 +254,9 @@ Summary: -

- - - - - - - - - - - - - - -
- - -

Summary

+

Summary

@@ -718,95 +290,122 @@ Summary: - +
- [Expand] -
Inherited Methods
+ - @@ -815,16 +414,6 @@ From interface

Inherited methods

- -From interface - - java.lang.annotation.Annotation + + From +interface + + + java.lang.annotation.Annotation + +
-
- - - - - - - - - @@ -857,193 +446,29 @@ From interface - -
- -
- -
- - -
- -
-
+
+
+ + + +
diff --git a/docs/html/reference/android/support/test/annotation/UiThreadTest.html b/docs/html/reference/android/support/test/annotation/UiThreadTest.html index ad5c3d546cba..fc3782d898c6 100644 --- a/docs/html/reference/android/support/test/annotation/UiThreadTest.html +++ b/docs/html/reference/android/support/test/annotation/UiThreadTest.html @@ -1,5 +1,3 @@ - - @@ -93,482 +91,86 @@ - - - - - - -UiThreadTest | Android Developers - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - - - - - - - -
- - + + + -
+
+
+ + + +
- - - - - + + + + + + -
- - - - -
+
-
- public - - - abstract - @interface -

UiThreadTest

- - - - - +

UiThreadTest

+

+ + public + + + abstract + @interface + UiThreadTest + +
+ + + + + implements - + Annotation + + + + +

- - - - - - - -
- -
-
- - - - - - - + + + + +
android.support.test.annotation.UiThreadTest
android.support.test.annotation.UiThreadTest +
+ + +

- - - -
- - -

Class Overview

-

This annotation should be used along with UiThreadTestRule +

This annotation should be used along with UiThreadTestRule or with any rule that inherits from it. When the annotation is present, the test method is executed on the application's UI thread (or main thread).

@@ -660,39 +250,21 @@ Summary: Before and After will also be executed on the UI Thread. Consider using - runOnUiThread(Runnable) if this is an + runOnUiThread(Runnable) if this is an issue.

-
-
See Also
-
- - - - - - - - - - - - - - -
- - -

Summary

+

Summary

@@ -726,95 +298,122 @@ Summary: - +
- [Expand] -
Inherited Methods
+ - @@ -823,16 +422,6 @@ From interface

Inherited methods

- -From interface - - java.lang.annotation.Annotation + + From +interface + + + java.lang.annotation.Annotation + +
-
- - - - - - - - - @@ -865,193 +454,29 @@ From interface - -
- -
- -
- - -
- -
-
+
+
+ + + +
diff --git a/docs/html/reference/android/support/test/annotation/package-summary.html b/docs/html/reference/android/support/test/annotation/package-summary.html index 94e5e138e446..73f051b52a35 100644 --- a/docs/html/reference/android/support/test/annotation/package-summary.html +++ b/docs/html/reference/android/support/test/annotation/package-summary.html @@ -1,5 +1,3 @@ - - @@ -93,734 +91,139 @@ - - - - - - -android.support.test.annotation | Android Developers - - - - + + + - - + + + + + + + - - - - - + + + - + - + - - - - - - - - - - -
- - - -
- - - - - - - - - - - -
- - - + + -
+
- - - + + +
+
-
- package -

android.support.test.annotation

-
- -
- -
- +

android.support.test.annotation

+

Annotations

-
- - + + - + - + - - + + - + - - + +
BetaBeta Signifies that a public API (public class, method or field) is subject to incompatible changes, or even removal, in a future release.  - - + +
UiThreadTestUiThreadTest - This annotation should be used along with UiThreadTestRule + This annotation should be used along with UiThreadTestRule or with any rule that inherits from it.  - - + +
-
+ + + + + + +
- - - - -
- -
- -
- - - -
- -
-
- - - +
+ + + +
diff --git a/docs/html/reference/android/support/test/espresso/AmbiguousViewMatcherException.Builder.html b/docs/html/reference/android/support/test/espresso/AmbiguousViewMatcherException.Builder.html index c10bf1634366..6b890abb7909 100644 --- a/docs/html/reference/android/support/test/espresso/AmbiguousViewMatcherException.Builder.html +++ b/docs/html/reference/android/support/test/espresso/AmbiguousViewMatcherException.Builder.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -AmbiguousViewMatcherException.Builder | Android Developers - - - - - - - - - - - - - - - - - - - -
- +AmbiguousViewMatcherException.Builder - -
- - - - - - - - - - - -
-
-
-
-
- -
- -
-
-
Android APIs
-
- - -
- - -
- -
-
- - - - - - -
+
+
+ + + +
- - - - - + + + + + + -
- - - - -
+
-
- public - static - - - class -

AmbiguousViewMatcherException.Builder

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - +

AmbiguousViewMatcherException.Builder

+

+ + public + static + + + class + AmbiguousViewMatcherException.Builder + +
+ + + + + extends Object + + + + + + + + + + + +

java.lang.Object
   ↳android.support.test.espresso.AmbiguousViewMatcherException.Builder
+ + + + + + + + + + + + + + +
java.lang.Object +
   ↳android.support.test.espresso.AmbiguousViewMatcherException.Builder +
+ + +

- - - -
- - -

Class Overview

-

Builder for AmbiguousViewMatcherException.

- - - - - -
- +

Builder for AmbiguousViewMatcherException.

@@ -717,18 +268,7 @@ Summary: - - - - - - - - -
- - -

Summary

+

Summary

@@ -753,25 +293,23 @@ Summary: - - - - +
Public Constructors
+ - - - - + + + + + + +

Public constructors

- - - - - - AmbiguousViewMatcherException.Builder() - -
+ + AmbiguousViewMatcherException.Builder() + + +
@@ -782,137 +320,186 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
Public Methods
- - - - - - AmbiguousViewMatcherException - - build() - -
- - - - - - AmbiguousViewMatcherException.Builder - - from(AmbiguousViewMatcherException exception) - -
- - - - - - AmbiguousViewMatcherException.Builder - - includeViewHierarchy(boolean includeViewHierarchy) - -
- - - - - - AmbiguousViewMatcherException.Builder - - withOtherAmbiguousViews(View... others) - -
- - - - - - AmbiguousViewMatcherException.Builder - - withRootView(View rootView) - -
- - - - - - AmbiguousViewMatcherException.Builder - - withView1(View view1) - -
- - - - - - AmbiguousViewMatcherException.Builder - - withView2(View view2) - -
- - - - - - AmbiguousViewMatcherException.Builder - - withViewMatcher(Matcher<? super View> viewMatcher) - -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public methods

+ + + + + + AmbiguousViewMatcherException + + + build() + + +
+ + + + + + AmbiguousViewMatcherException.Builder + + + from(AmbiguousViewMatcherException exception) + + +
+ + + + + + AmbiguousViewMatcherException.Builder + + + includeViewHierarchy(boolean includeViewHierarchy) + + +
+ + + + + + AmbiguousViewMatcherException.Builder + + + withOtherAmbiguousViews(View... others) + + +
+ + + + + + AmbiguousViewMatcherException.Builder + + + withRootView(View rootView) + + +
+ + + + + + AmbiguousViewMatcherException.Builder + + + withView1(View view1) + + +
+ + + + + + AmbiguousViewMatcherException.Builder + + + withView2(View view2) + + +
+ + + + + + AmbiguousViewMatcherException.Builder + + + withViewMatcher(Matcher<? super View> viewMatcher) + + +
@@ -924,207 +511,276 @@ Summary: - +
- [Expand] -
Inherited Methods
+ - @@ -1133,16 +789,6 @@ From class

Inherited methods

- -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
-
- - - - - - - - - @@ -1160,39 +806,28 @@ From class -

Public Constructors

+

Public constructors

-
-

- - public - - - - - - - AmbiguousViewMatcherException.Builder - () -

-
-
- - - -
-
- - +
+

AmbiguousViewMatcherException.Builder

+
+
+ + +
+
+AmbiguousViewMatcherException.Builder ()
+ + -

+ +

-
@@ -1207,263 +842,294 @@ From class -

Public Methods

+

Public methods

-
-

- - public - - - - - AmbiguousViewMatcherException - - build - () -

-
-
- - - -
-
- - - - -

+
+

build

+
+
+ +
+
+AmbiguousViewMatcherException build ()
+ + + + +

+ + + + + + +
Returns
AmbiguousViewMatcherException
+
-
-

- - public - - - - - AmbiguousViewMatcherException.Builder - - from - (AmbiguousViewMatcherException exception) -

-
-
- - - -
-
- - - - -

+
+

from

+
+
+ +
+
+AmbiguousViewMatcherException.Builder from (AmbiguousViewMatcherException exception)
+ + + + +

+ + + + + + +
Parameters
exception + AmbiguousViewMatcherException +
+ + + + + + +
Returns
AmbiguousViewMatcherException.Builder
+
-
-

- - public - - - - - AmbiguousViewMatcherException.Builder - - includeViewHierarchy - (boolean includeViewHierarchy) -

-
-
- - - -
-
- - - - -

+
+

includeViewHierarchy

+
+
+ +
+
+AmbiguousViewMatcherException.Builder includeViewHierarchy (boolean includeViewHierarchy)
+ + + + +

+ + + + + + +
Parameters
includeViewHierarchy + boolean +
+ + + + + + +
Returns
AmbiguousViewMatcherException.Builder
+
-
-

- - public - - - - - AmbiguousViewMatcherException.Builder - - withOtherAmbiguousViews - (View... others) -

-
-
- - - -
-
- - - - -

+
+

withOtherAmbiguousViews

+
+
+ +
+
+AmbiguousViewMatcherException.Builder withOtherAmbiguousViews (View... others)
+ + + + +

+ + + + + + +
Parameters
others + View +
+ + + + + + +
Returns
AmbiguousViewMatcherException.Builder
+
-
-

- - public - - - - - AmbiguousViewMatcherException.Builder - - withRootView - (View rootView) -

-
-
- - - -
-
- - - - -

+
+

withRootView

+
+
+ +
+
+AmbiguousViewMatcherException.Builder withRootView (View rootView)
+ + + + +

+ + + + + + +
Parameters
rootView + View +
+ + + + + + +
Returns
AmbiguousViewMatcherException.Builder
+
-
-

- - public - - - - - AmbiguousViewMatcherException.Builder - - withView1 - (View view1) -

-
-
- - - -
-
- - - - -

+
+

withView1

+
+
+ +
+
+AmbiguousViewMatcherException.Builder withView1 (View view1)
+ + + + +

+ + + + + + +
Parameters
view1 + View +
+ + + + + + +
Returns
AmbiguousViewMatcherException.Builder
+
-
-

- - public - - - - - AmbiguousViewMatcherException.Builder - - withView2 - (View view2) -

-
-
- - - -
-
- - - - -

+
+

withView2

+
+
+ +
+
+AmbiguousViewMatcherException.Builder withView2 (View view2)
+ + + + +

+ + + + + + +
Parameters
view2 + View +
+ + + + + + +
Returns
AmbiguousViewMatcherException.Builder
+
-
-

- - public - - - - - AmbiguousViewMatcherException.Builder - - withViewMatcher - (Matcher<? super View> viewMatcher) -

-
-
- - - -
-
- - - - -

+
+

withViewMatcher

+
+
+ +
+
+AmbiguousViewMatcherException.Builder withViewMatcher (Matcher<? super View> viewMatcher)
+ + + + +

+ + + + + + +
Parameters
viewMatcher + Matcher +
+ + + + + + +
Returns
AmbiguousViewMatcherException.Builder
+
@@ -1475,193 +1141,64 @@ From class - -
- -
- -
- - - -
-
-
+
+ diff --git a/docs/html/reference/android/support/test/espresso/AmbiguousViewMatcherException.html b/docs/html/reference/android/support/test/espresso/AmbiguousViewMatcherException.html index ba5f8b033db7..5cbcd3402a1b 100644 --- a/docs/html/reference/android/support/test/espresso/AmbiguousViewMatcherException.html +++ b/docs/html/reference/android/support/test/espresso/AmbiguousViewMatcherException.html @@ -1,7 +1,3 @@ - - - - @@ -93,510 +89,26 @@ - - - - - - - - -AmbiguousViewMatcherException | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - - - - - - - -
-
-
-
-
- -
- -
-
-
Android APIs
-
- - -
- - -
- -
-
- - - - - - -
- -
- - @@ -604,33 +116,88 @@ type="text/css"> + + + + + + + + + + + + + + + + +AmbiguousViewMatcherException + + + +
+
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + -
- - - - -
+
-
- public - - final - - class -

AmbiguousViewMatcherException

- - - - - - - - - - - - - - - - - extends RuntimeException
- - - - - - +

AmbiguousViewMatcherException

+

+ + public + + final + + class + AmbiguousViewMatcherException + +
+ + + + + + + + + + + + + + + + + + + + + + + extends RuntimeException + + + + + + + + implements - - EspressoException - - - - - - - - -

- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + EspressoException + + + + + +

java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳java.lang.RuntimeException
      ↳android.support.test.espresso.AmbiguousViewMatcherException
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
java.lang.Object +
   ↳java.lang.Throwable +
    ↳java.lang.Exception +
     ↳java.lang.RuntimeException +
      ↳android.support.test.espresso.AmbiguousViewMatcherException +
+ + +

- - - -
- - -

Class Overview

-

An exception which indicates that a Matcher matched multiple views in the hierarchy when +

An exception which indicates that a Matcher matched multiple views in the hierarchy when only one view was expected. It should be called only from the main thread.

Contains details about the matcher and the current view hierarchy to aid in debugging. @@ -799,52 +366,35 @@ Summary: -

- - - - - - - - - - - - - - -
- - -

Summary

+

Summary

- - - - - - - +
Nested Classes
- - - - - classAmbiguousViewMatcherException.Builder
+ + + + + + - - + + @@ -878,9 +428,8 @@ Summary: -

Nested classes

+ + + + + class - Builder for AmbiguousViewMatcherException.  - - - + AmbiguousViewMatcherException.Builder +

Builder for AmbiguousViewMatcherException.  + + +

+
- [Expand] -
Inherited Methods
+ @@ -888,233 +437,315 @@ Summary: - @@ -1122,201 +753,271 @@ From class - @@ -1329,16 +1030,6 @@ From class

Inherited methods

- -From class - - java.lang.Throwable + + From +class + + + java.lang.Throwable + +
- -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
-
- - - - - - - - - @@ -1371,193 +1062,64 @@ From class - -
- -
- -
- - - -
-
-
+
+ diff --git a/docs/html/reference/android/support/test/espresso/AppNotIdleException.html b/docs/html/reference/android/support/test/espresso/AppNotIdleException.html index 0bfd996774a5..59a88d3f6db4 100644 --- a/docs/html/reference/android/support/test/espresso/AppNotIdleException.html +++ b/docs/html/reference/android/support/test/espresso/AppNotIdleException.html @@ -1,4 +1,3 @@ - @@ -93,544 +92,112 @@ - - - - - - -AppNotIdleException | Android Developers - - - - - - - - - - - - - - - - - - - -
- +AppNotIdleException - -
- - - - - - - - - - - -
-
-
-
-
- -
- -
-
-
Android APIs
-
- - -
- - -
- -
-
- - - - - - -
+
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + -
- - - - -
+
-
- public - - final - - class -

AppNotIdleException

- - - - - - - - - - - - - - - - - extends RuntimeException
- - - - - - +

AppNotIdleException

+

+ + public + + final + + class + AppNotIdleException + +
+ + + + + + + + + + + + + + + + + + + + + + + extends RuntimeException + + + + + + + + implements - - EspressoException - - - - - - - - -

- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + EspressoException + + + + + +

java.lang.Object
   ↳java.lang.Throwable
    ↳java.lang.Exception
     ↳java.lang.RuntimeException
      ↳android.support.test.espresso.AppNotIdleException
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
java.lang.Object +
   ↳java.lang.Throwable +
    ↳java.lang.Exception +
     ↳java.lang.RuntimeException +
      ↳android.support.test.espresso.AppNotIdleException +
+ + +

- - - -
- - -

Class Overview

-

An exception which indicates that the App has not become idle even after the specified duration. +

An exception which indicates that the App has not become idle even after the specified duration.

-
- - - - - - - - - - - - - - -
- - -

Summary

+

Summary

@@ -835,58 +384,67 @@ Summary: - - - - - - - - - + + - - - + +

Changes the default FailureHandler to the given one. +

+
Public Methods
- - + + - static - AppNotIdleException - - - - - - - - + + + + + - + + +

+ + + + + + + + + + + + + +

Public methods

- create(List<String> idleConditions, String message) -
- Creates a new AppNotIdleException suitable for erroring out a test case. - - - -
- -
- - - - static - - AppNotIdleException - - create(List<String> idleConditions, int loopCount, int seconds) - -
- + +
+ + + static + + + AppNotIdleException + + + create(List<String> idleConditions, int loopCount, int seconds) + + +

This method is deprecated. - use create(List, String) instead + use create(List, String) instead - - - - - -

+ + + static + + + AppNotIdleException + + + create(List<String> idleConditions, String message) + + +

Creates a new AppNotIdleException suitable for erroring out a test case. + + +

+ +
@@ -898,9 +456,8 @@ Summary: - +
- [Expand] -
Inherited Methods
+ @@ -908,233 +465,315 @@ Summary: - @@ -1142,201 +781,271 @@ From class - @@ -1349,16 +1058,6 @@ From class

Inherited methods

- -From class - - java.lang.Throwable + + From +class + + + java.lang.Throwable + +
- -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
- - - - - - - - - - @@ -1384,121 +1083,114 @@ From class -

Public Methods

- +

Public methods

- - -
-

- - public - static - - - - AppNotIdleException - - create - (List<String> idleConditions, String message) -

-
-
- - - -
-
+ +
+

create

+
+
+ + +
+
+AppNotIdleException create (List<String> idleConditions, 
+                int loopCount, 
+                int seconds)
+ + + +

+

+ This method is deprecated.
+ use create(List, String) instead -

Creates a new AppNotIdleException suitable for erroring out a test case. +

+

Creates a new AppNotIdleException suitable for erroring out a test case.

This should be called only from the main thread if the app does not idle out within the - specified duration.

-
-
Parameters
- - - - - - - -
idleConditions - list of idleConditions that failed to become idle.
message - a message about the failure.
-
-
-
Returns
-
  • a AppNotIdleException suitable to be thrown on the instrumentation thread. -
-
+ specified duration.

+ + + + + + + + + + + + + + +
Parameters
idleConditions + List: + list of idleConditions that failed to become idle.
loopCount + int: + number of times it was tried to check if they became idle.
seconds + int: + number of seconds that was tried before giving up.
+ + + + + + +
Returns
AppNotIdleExceptiona AppNotIdleException suitable to be thrown on the instrumentation thread.
-
- - -
-

- - public - static - - - - AppNotIdleException - - create - (List<String> idleConditions, int loopCount, int seconds) -

-
-
- - - -
-
- + +
+

create

+
+
+ + -

-

- This method is deprecated.
- use create(List, String) instead +

+
+AppNotIdleException create (List<String> idleConditions, 
+                String message)
+ + -

-

Creates a new AppNotIdleException suitable for erroring out a test case. + +

Creates a new AppNotIdleException suitable for erroring out a test case.

This should be called only from the main thread if the app does not idle out within the - specified duration.

-
-
Parameters
- - - - - - - - - - -
idleConditions - list of idleConditions that failed to become idle.
loopCount - number of times it was tried to check if they became idle.
seconds - number of seconds that was tried before giving up.
-
-
-
Returns
-
  • a AppNotIdleException suitable to be thrown on the instrumentation thread.
-
+ specified duration.

+ + + + + + + + + + +
Parameters
idleConditions + List: + list of idleConditions that failed to become idle.
message + String: + a message about the failure.
+ + + + + + +
Returns
AppNotIdleExceptiona AppNotIdleException suitable to be thrown on the instrumentation thread. +
-
@@ -1510,193 +1202,64 @@ From class - -
- -
- -
- - -
- - - + + diff --git a/docs/html/reference/android/support/test/espresso/BaseLayerComponent.html b/docs/html/reference/android/support/test/espresso/BaseLayerComponent.html index 4a21f81a8729..9783dcb4435a 100644 --- a/docs/html/reference/android/support/test/espresso/BaseLayerComponent.html +++ b/docs/html/reference/android/support/test/espresso/BaseLayerComponent.html @@ -1,5 +1,3 @@ - - @@ -92,599 +90,138 @@ - - - - - - - -BaseLayerComponent | Android Developers - - - - - - - - - - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - -
-
-
-
-
- -
- -
-
-
Android APIs
-
- - -
- - -
- -
-
- - - - - - -
-
+ + + + + + + + + + + - -
+ + + + -
-
+BaseLayerComponent - -
- public + + + - interface -

BaseLayerComponent

+
+
+
+ + + +
+ +
+
-
+ -
+

BaseLayerComponent

+

+ + public + + + + interface + BaseLayerComponent + +
-

- + + + + + - +

- - + + + + +
android.support.test.espresso.BaseLayerComponent
android.support.test.espresso.BaseLayerComponent +
+ + +

- - - -
- - -

Class Overview

-

Dagger component for base classes. +

Dagger component for base classes.

-
- - - - - - - - - - - - - - -
- - -

Summary

+

Summary

@@ -713,89 +250,120 @@ type="text/css"> - - - - - - - - - - - - - - - - - - - - - - +
Public Methods
- abstract - - - - - ActiveRootLister - - activeRootLister() - -
- abstract - - - - - FailureHandler - - failureHandler() - -
- abstract - - - - - BaseLayerModule.FailureHandlerHolder - - failureHolder() - -
+ - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public methods

- abstract - - - IdlingResourceRegistry - - idlingResourceRegistry() - -
- abstract - - - - - ViewInteractionComponent - - plus(ViewInteractionModule module) - -
+ abstract + + + + + ActiveRootLister + + + activeRootLister() + + +
+ abstract + + + + + FailureHandler + + + failureHandler() + + +
+ abstract + + + + + BaseLayerModule.FailureHandlerHolder + + + failureHolder() + + +
+ abstract + + + + + IdlingResourceRegistry + + + idlingResourceRegistry() + + +
+ abstract + + + + + ViewInteractionComponent + + + plus(ViewInteractionModule module) + + +
@@ -806,16 +374,6 @@ type="text/css"> -
- - - - - - - - - @@ -841,167 +399,156 @@ type="text/css"> -

Public Methods

+

Public methods

-
-

- - public - - - abstract - - ActiveRootLister - - activeRootLister - () -

-
-
- - - -
-
- - - - -

+
+

activeRootLister

+
+
+ +
+
+ActiveRootLister activeRootLister ()
+ + + + +

+ + + + + + +
Returns
ActiveRootLister
+
-
-

- - public - - - abstract - - FailureHandler - - failureHandler - () -

-
-
- - - -
-
- - - - -

+
+

failureHandler

+
+
+ +
+
+FailureHandler failureHandler ()
+ + + + +

+ + + + + + +
Returns
FailureHandler
+
-
-

- - public - - - abstract - - BaseLayerModule.FailureHandlerHolder - - failureHolder - () -

-
-
- - - -
-
- - - - -

+
+

failureHolder

+
+
+ +
+
+BaseLayerModule.FailureHandlerHolder failureHolder ()
+ + + + +

+ + + + + + +
Returns
BaseLayerModule.FailureHandlerHolder
+
-
-

- - public - - - abstract - - IdlingResourceRegistry - - idlingResourceRegistry - () -

-
-
- - - -
-
- - - - -

+
+

idlingResourceRegistry

+
+
+ +
+
+IdlingResourceRegistry idlingResourceRegistry ()
+ + + + +

+ + + + + + +
Returns
IdlingResourceRegistry
+
-
-

- - public - - - abstract - - ViewInteractionComponent - - plus - (ViewInteractionModule module) -

-
-
- - - -
-
- - - - -

+
+

plus

+
+
+ +
+
+ViewInteractionComponent plus (ViewInteractionModule module)
+ + + + +

+ + + + + + +
Parameters
module + ViewInteractionModule +
+ + + + + + +
Returns
ViewInteractionComponent
+
@@ -1013,193 +560,64 @@ type="text/css"> - -
- -
- -
- - - -
-
-
+
+ diff --git a/docs/html/reference/android/support/test/espresso/DataInteraction.html b/docs/html/reference/android/support/test/espresso/DataInteraction.html index a0aa432122a3..daabab2e9cab 100644 --- a/docs/html/reference/android/support/test/espresso/DataInteraction.html +++ b/docs/html/reference/android/support/test/espresso/DataInteraction.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -DataInteraction | Android Developers - - - - - - - - - - - - - - - - - - - -
- +DataInteraction - -
- - - - - - - - - - - -
-
-
-
-
- -
- -
-
-
Android APIs
-
- - -
- - -
- -
-
- - - - - - -
+
+
+ + + +
- - - - - + + + + + + -
- - - - -
+
-
- public - - - - class -

DataInteraction

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - +

DataInteraction

+

+ + public + + + + class + DataInteraction + +
+ + + + + extends Object + + + + + + + + + + + +

java.lang.Object
   ↳android.support.test.espresso.DataInteraction
+ + + + + + + + + + + + + + +
java.lang.Object +
   ↳android.support.test.espresso.DataInteraction +
+ + +

- - - -
- - -

Class Overview

-

An interface to interact with data displayed in AdapterViews. +

An interface to interact with data displayed in AdapterViews.

- This interface builds on top of ViewInteraction and should be the preferred way to + This interface builds on top of ViewInteraction and should be the preferred way to interact with elements displayed inside AdapterViews.

@@ -726,27 +284,9 @@ Summary: -

- - - - - - - - - - - - - - -
- - -

Summary

+

Summary

@@ -775,176 +315,205 @@ Summary: - - - - - - - - - - + - - - + + - - - + +
+

getIdlingResources

+
+
+ + -
- - + +
+

onView

+
+
+ + +
+
+ViewInteraction onView (Matcher<View> viewMatcher)
+ + -
- - + + - - - + +
+void pressBack ()
+ + + + +

Press on the back button.

+
Public Methods
- - - - - - DataInteraction - - atPosition(Integer atPosition) - -
- Selects the view which matches the nth position on the adapter + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + - + + +

+ + + +

Public methods

+ + + + + + DataInteraction + + + atPosition(Integer atPosition) + + +

Selects the view which matches the nth position on the adapter based on the data matcher. - - - - - -

- - - - - - ViewInteraction - - check(ViewAssertion assertion) - -
- Performs an assertion on the state of the view after we force the data to be loaded. - - - -
- -
- - - - - - DataInteraction - - inAdapterView(Matcher<View> adapterMatcher) - -
- Selects a particular adapter view to operate on, by default we operate on any adapter view + + +

+ +
+ + + + + + ViewInteraction + + + check(ViewAssertion assertion) + + +

Performs an assertion on the state of the view after we force the data to be loaded. + + +

+ +
+ + + + + + DataInteraction + + + inAdapterView(Matcher<View> adapterMatcher) + + +

Selects a particular adapter view to operate on, by default we operate on any adapter view on the screen. - - - - - -

- - - - - - DataInteraction - - inRoot(Matcher<Root> rootMatcher) - -
- Causes this data interaction to work within the Root specified by the given root matcher. - - - -
- -
- - - - - - DataInteraction - - onChildView(Matcher<View> childMatcher) - -
- Causes perform and check methods to take place on a specific child view of the view returned + + +

+ +
+ + + + + + DataInteraction + + + inRoot(Matcher<Root> rootMatcher) + + +

Causes this data interaction to work within the Root specified by the given root matcher. + + +

+ +
+ + + + + + DataInteraction + + + onChildView(Matcher<View> childMatcher) + + +

Causes perform and check methods to take place on a specific child view of the view returned by Adapter.getView() - - - - - -

- - - - - - ViewInteraction - - perform(ViewAction... actions) - -
- Performs an action on the view after we force the data to be loaded. - - - -
- -
- - - - - - DataInteraction - - usingAdapterViewProtocol(AdapterViewProtocol adapterViewProtocol) - -
- Use a different AdapterViewProtocol if the Adapter implementation does not + + +

+ +
+ + + + + + ViewInteraction + + + perform(ViewAction... actions) + + +

Performs an action on the view after we force the data to be loaded. + + +

+ +
+ + + + + + DataInteraction + + + usingAdapterViewProtocol(AdapterViewProtocol adapterViewProtocol) + + +

Use a different AdapterViewProtocol if the Adapter implementation does not satisfy the AdapterView contract like (@code ExpandableListView) - - - - - -

@@ -956,207 +525,276 @@ Summary: - +
- [Expand] -
Inherited Methods
+ - @@ -1165,16 +803,6 @@ From class

Inherited methods

- -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
-
- - - - - - - - - @@ -1200,250 +828,277 @@ From class -

Public Methods

+

Public methods

-
-

- - public - - - - - DataInteraction - - atPosition - (Integer atPosition) -

-
-
- - - -
-
- - +
+

atPosition

+
+
+ + +
+
+DataInteraction atPosition (Integer atPosition)
+ + -

Selects the view which matches the nth position on the adapter + +

Selects the view which matches the nth position on the adapter based on the data matcher. -

+

+ + + + + + +
Parameters
atPosition + Integer +
+ + + + + + +
Returns
DataInteraction
-
-
-

- - public - - - - - ViewInteraction - - check - (ViewAssertion assertion) -

-
-
- - - -
-
- - - - -

Performs an assertion on the state of the view after we force the data to be loaded.

-
-
Returns
- -
+
+

check

+
+
+ +
+
+ViewInteraction check (ViewAssertion assertion)
+ + + + +

Performs an assertion on the state of the view after we force the data to be loaded.

+ + + + + + +
Parameters
assertion + ViewAssertion +
+ + + + + + +
Returns
ViewInteractionan ViewInteraction for more assertions or actions. +
+
-
-

- - public - - - - - DataInteraction - - inAdapterView - (Matcher<View> adapterMatcher) -

-
-
- - - -
-
- - +
+

inAdapterView

+
+
+ + +
+
+DataInteraction inAdapterView (Matcher<View> adapterMatcher)
+ + -

Selects a particular adapter view to operate on, by default we operate on any adapter view + +

Selects a particular adapter view to operate on, by default we operate on any adapter view on the screen. -

+

+ + + + + + +
Parameters
adapterMatcher + Matcher +
+ + + + + + +
Returns
DataInteraction
-
-
-

- - public - - - - - DataInteraction - - inRoot - (Matcher<Root> rootMatcher) -

-
-
- - - -
-
- - +
+

inRoot

+
+
+ + +
+
+DataInteraction inRoot (Matcher<Root> rootMatcher)
+ + -

Causes this data interaction to work within the Root specified by the given root matcher. -

+ +

Causes this data interaction to work within the Root specified by the given root matcher. +

+ + + + + + +
Parameters
rootMatcher + Matcher +
+ + + + + + +
Returns
DataInteraction
-
-
-

- - public - - - - - DataInteraction - - onChildView - (Matcher<View> childMatcher) -

-
-
- - - -
-
- - +
+

onChildView

+
+
+ + +
+
+DataInteraction onChildView (Matcher<View> childMatcher)
+ + -

Causes perform and check methods to take place on a specific child view of the view returned + +

Causes perform and check methods to take place on a specific child view of the view returned by Adapter.getView() -

+

+ + + + + + +
Parameters
childMatcher + Matcher +
+ + + + + + +
Returns
DataInteraction
-
-
-

- - public - - - - - ViewInteraction - - perform - (ViewAction... actions) -

-
-
- - - -
-
- - - - -

Performs an action on the view after we force the data to be loaded.

-
-
Returns
- -
+
+

perform

+
+
+ +
+
+ViewInteraction perform (ViewAction... actions)
+ + + + +

Performs an action on the view after we force the data to be loaded.

+ + + + + + +
Parameters
actions + ViewAction +
+ + + + + + +
Returns
ViewInteractionan ViewInteraction for more assertions or actions. +
+
-
-

- - public - - - - - DataInteraction - - usingAdapterViewProtocol - (AdapterViewProtocol adapterViewProtocol) -

-
-
- - - -
-
- - +
+

usingAdapterViewProtocol

+
+
+ + +
+
+DataInteraction usingAdapterViewProtocol (AdapterViewProtocol adapterViewProtocol)
+ + -

Use a different AdapterViewProtocol if the Adapter implementation does not + +

Use a different AdapterViewProtocol if the Adapter implementation does not satisfy the AdapterView contract like (@code ExpandableListView) -

+

+ + + + + + +
Parameters
adapterViewProtocol + AdapterViewProtocol +
+ + + + + + +
Returns
DataInteraction
-
@@ -1455,193 +1110,64 @@ From class - -
- -
- -
- - - -
- -
-
+
+ diff --git a/docs/html/reference/android/support/test/espresso/Espresso.html b/docs/html/reference/android/support/test/espresso/Espresso.html index 3074910b872a..211cf0e197bb 100644 --- a/docs/html/reference/android/support/test/espresso/Espresso.html +++ b/docs/html/reference/android/support/test/espresso/Espresso.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -Espresso | Android Developers - - - - - - - - - - - - - - - - - - - -
- +Espresso - -
- - - - - - - - - - - -
-
-
-
-
- -
- -
-
-
Android APIs
-
- - -
- - -
- -
-
- - - - - - -
+
+
+ + + +
- - - - - + + + + + + -
- - - - -
+
-
- public - - final - - class -

Espresso

- - - - - extends Object
- - - - - - - - - - - - -
- -
- -
- - - - - - - - - - - - - - - - +

Espresso

+

+ + public + + final + + class + Espresso + +
+ + + + + extends Object + + + + + + + + + + + +

java.lang.Object
   ↳android.support.test.espresso.Espresso
+ + + + + + + + + + + + + + +
java.lang.Object +
   ↳android.support.test.espresso.Espresso +
+ + +

- - - -
- - -

Class Overview

-

Entry point to the Espresso framework. Test authors can initiate testing by using one of the on* +

Entry point to the Espresso framework. Test authors can initiate testing by using one of the on* methods (e.g. onView) or perform top-level user actions (e.g. pressBack).

@@ -707,27 +265,9 @@ Summary: -
- - - - - - - - - - - - - - -
- - -

Summary

+

Summary

@@ -756,1222 +296,1154 @@ Summary: - - - - - - - - - - - - - - - +
Public Methods
- - - - static - - void - - closeSoftKeyboard() - -
- Closes soft keyboard if open. - - - -
- -
- - - - static - - List<IdlingResource> - - getIdlingResources() - -
- Returns a list of all currently registered IdlingResources. - - - -
- -
+ - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - static - - DataInteraction - -

Public methods

+ +
+ + + static + + + void + + + closeSoftKeyboard() + + +

Closes soft keyboard if open. + + +

+ +
+ + + static + + + List<IdlingResource> + + + getIdlingResources() + + +

Returns a list of all currently registered IdlingResources. + + +

+ +
+ + + static + + + DataInteraction + + + onData(Matcher<? extends Object> dataMatcher) + + +

Creates an DataInteraction for a data object displayed by the application. + + +

+ +
+ + + static + + + ViewInteraction + + + onView(Matcher<View> viewMatcher) + + +

Creates a ViewInteraction for a given view. + + +

+ +
+ + + static + + + void + + + openActionBarOverflowOrOptionsMenu(Context context) + + +

Opens the overflow menu displayed within an ActionBar. + + +

+ +
+ + + static + + + void + + + openContextualActionModeOverflowMenu() + + +

Opens the overflow menu displayed in the contextual options of an ActionMode. + + +

+ +
+ + + static + + + void + + + pressBack() + + +

Press on the back button. + + +

+ +
+ + + static + + + boolean + + + registerIdlingResources(IdlingResource... resources) + + +

Registers one or more IdlingResources with the framework. + + +

+ +
+ + + static + + + void + + + registerLooperAsIdlingResource(Looper looper) + + +

Registers a Looper for idle checking with the framework. + + +

+ +
+ + + static + + + void + + + registerLooperAsIdlingResource(Looper looper, boolean considerWaitIdle) + + +

Registers a Looper for idle checking with the framework. + + +

+ +
+ + + static + + + void + + + setFailureHandler(FailureHandler failureHandler) + + +

Changes the default FailureHandler to the given one. + + +

+ +
+ + + static + + + boolean + + + unregisterIdlingResources(IdlingResource... resources) + + +

Unregisters one or more IdlingResources. + + +

+ +
- onData(Matcher<? extends Object> dataMatcher) - -
- Creates an DataInteraction for a data object displayed by the application. - - +
-
-
+ + + - static - ViewInteraction - - + +

Inherited methods

- onView(Matcher<View> viewMatcher) +
-
- Creates a ViewInteraction for a given view. + From +class + + + java.lang.Object + + +
+ + +
+
- -
+ + - static - void - - openActionBarOverflowOrOptionsMenu(Context context) + -
- Opens the overflow menu displayed within an ActionBar. + -
-
+ + +

Public methods

- static - void
-
- openContextualActionModeOverflowMenu() + -
- Opens the overflow menu displayed in the contextual options of an ActionMode. +
+

closeSoftKeyboard

+
+
+ + +
+
+void closeSoftKeyboard ()
+ + + +

Closes soft keyboard if open. +

-
+
-
+ +
+List<IdlingResource> getIdlingResources ()
+ + + +

Returns a list of all currently registered IdlingResources. +

+ + + + + + +
Returns
List<IdlingResource>
+ - static - void
-
- pressBack() + -
- Press on the back button. +
+

onData

+
+
+ + +
+
+DataInteraction onData (Matcher<? extends Object> dataMatcher)
+ + + + +

Creates an DataInteraction for a data object displayed by the application. Use this + method to load (into the view hierarchy) items from AdapterView widgets (e.g. ListView).

+ + + + + + +
Parameters
dataMatcher + Matcher: + a matcher used to find the data object. +
+ + + + + + +
Returns
DataInteraction
+
-
-
+ +

Creates a ViewInteraction for a given view. Note: the view has + to be part of the view hierarchy. This may not be the case if it is rendered as part of + an AdapterView (e.g. ListView). If this is the case, use Espresso.onData to load the view + first.

+ + + + + + +
Parameters
viewMatcher + Matcher: + used to select the view.
+ + + + + + +
Returns
ViewInteraction
+
+

See also:

+ +
+ - static + - boolean
-
- registerIdlingResources(IdlingResource... resources) +
+

openActionBarOverflowOrOptionsMenu

+
+
+ + -
- Registers one or more IdlingResources with the framework. +
+
+void openActionBarOverflowOrOptionsMenu (Context context)
+ + + +

Opens the overflow menu displayed within an ActionBar. +

This works with both native and SherlockActionBar ActionBars. -

+

Note the significant differences of UX between ActionMode and ActionBars with respect to + overflows. If a hardware menu key is present, the overflow icon is never displayed in + ActionBars and can only be interacted with via menu key presses. +

+ + + + + + +
Parameters
context + Context +
-
+
+

openContextualActionModeOverflowMenu

+
+
+ + +
+
+void openContextualActionModeOverflowMenu ()
+ + + +

Opens the overflow menu displayed in the contextual options of an ActionMode. - static +

This works with both native and SherlockActionBar action modes. - void -

- registerLooperAsIdlingResource(Looper looper, boolean considerWaitIdle) +

Note the significant difference in UX between ActionMode and ActionBar overflows - + ActionMode will always present an overflow icon and that icon only responds to clicks. + The menu button (if present) has no impact on it. +

-
- Registers a Looper for idle checking with the framework. +
+ - +
+

pressBack

+
+
+ + -
+ + + + + +
Throws
PerformExceptionif currently displayed activity is root activity, since pressing back + button would result in application closing. +
+ +
-
+ +
+

registerIdlingResources

+
+
+ + +
+
+boolean registerIdlingResources (IdlingResource... resources)
+ + - static + +

Registers one or more IdlingResources with the framework. It is expected, although not + strictly required, that this method will be called at test setup time prior to any interaction + with the application under test. When registering more than one resource, ensure that each has + a unique name. If any of the given resources is already registered, a warning is logged.

+ + + + + + +
Parameters
resources + IdlingResource +
+ + + + + + +
Returns
booleantrue if all resources were successfully registered +
- void
-
- registerLooperAsIdlingResource(Looper looper) + -
- Registers a Looper for idle checking with the framework. + +
+

registerLooperAsIdlingResource

+
+
+ + -
+
+
+void registerLooperAsIdlingResource (Looper looper)
+ + + + +

Registers a Looper for idle checking with the framework. This is intended for use with + non-UI thread loopers.

+ + + + + + +
Parameters
looper + Looper +
+ + + + + + +
Throws
IllegalArgumentExceptionif looper is the main looper. +
+ -
+
+

registerLooperAsIdlingResource

+
+
+ + +
+
+void registerLooperAsIdlingResource (Looper looper, 
+                boolean considerWaitIdle)
+ + + + +

Registers a Looper for idle checking with the framework. This is intended for use with + non-UI thread loopers. +

This method allows the caller to consider Thread.State.WAIT to be 'idle'. - static +

This is useful in the case where a looper is sending a message to the UI thread + synchronously through a wait/notify mechanism.

+ + + + + + + + + + +
Parameters
looper + Looper +
considerWaitIdle + boolean +
+ + + + + + +
Throws
IllegalArgumentExceptionif looper is the main looper. +
+ - void
-
- setFailureHandler(FailureHandler failureHandler) + -
- Changes the default FailureHandler to the given one. + +
+

setFailureHandler

+
+
+ + -
+
+
+void setFailureHandler (FailureHandler failureHandler)
+ + -
+ + + + + +
Parameters
failureHandler + FailureHandler +
+
- - + +
+

unregisterIdlingResources

+
+
+ + +
+
+boolean unregisterIdlingResources (IdlingResource... resources)
+ + + + +

Unregisters one or more IdlingResources. If any of the given resources are not already + registered, a warning is logged.

+ + + + + + +
Parameters
resources + IdlingResource +
+ + + + + + +
Returns
booleantrue if all resources were successfully unregistered +
- static +
- boolean
- - - unregisterIdlingResources(IdlingResource... resources) -
- Unregisters one or more IdlingResources. -
+ - + - +
- - - - - - - - - - - - -
- [Expand] -
Inherited Methods
- -From class - - java.lang.Object - -
- - -
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods

- - - - - -
-

- - public - static - - - - void - - closeSoftKeyboard - () -

-
-
- - - -
-
- - - - -

Closes soft keyboard if open. -

- -
-
- - - - -
-

- - public - static - - - - List<IdlingResource> - - getIdlingResources - () -

-
-
- - - -
-
- - - - -

Returns a list of all currently registered IdlingResources. -

- -
-
- - - - -
-

- - public - static - - - - DataInteraction - - onData - (Matcher<? extends Object> dataMatcher) -

-
-
- - - -
-
- - - - -

Creates an DataInteraction for a data object displayed by the application. Use this - method to load (into the view hierarchy) items from AdapterView widgets (e.g. ListView).

-
-
Parameters
- - - - -
dataMatcher - a matcher used to find the data object. -
-
- -
-
- - - - -
-

- - public - static - - - - ViewInteraction - - onView - (Matcher<View> viewMatcher) -

-
-
- - - -
-
- - - - -

Creates a ViewInteraction for a given view. Note: the view has - to be part of the view hierarchy. This may not be the case if it is rendered as part of - an AdapterView (e.g. ListView). If this is the case, use Espresso.onData to load the view - first.

-
-
Parameters
- - - - -
viewMatcher - used to select the view.
-
- -
- - - - -
-

- - public - static - - - - void - - openActionBarOverflowOrOptionsMenu - (Context context) -

-
-
- - - -
-
- - - - -

Opens the overflow menu displayed within an ActionBar. - -

This works with both native and SherlockActionBar ActionBars. - -

Note the significant differences of UX between ActionMode and ActionBars with respect to - overflows. If a hardware menu key is present, the overflow icon is never displayed in - ActionBars and can only be interacted with via menu key presses. -

- -
-
- - - - -
-

- - public - static - - - - void - - openContextualActionModeOverflowMenu - () -

-
-
- - - -
-
- - - - -

Opens the overflow menu displayed in the contextual options of an ActionMode. - -

This works with both native and SherlockActionBar action modes. - -

Note the significant difference in UX between ActionMode and ActionBar overflows - - ActionMode will always present an overflow icon and that icon only responds to clicks. - The menu button (if present) has no impact on it. -

- -
-
- - - - -
-

- - public - static - - - - void - - pressBack - () -

-
-
- - - -
-
- - - - -

Press on the back button.

-
-
Throws
- - - - -
PerformException - if currently displayed activity is root activity, since pressing back - button would result in application closing. -
-
- -
-
- - - - -
-

- - public - static - - - - boolean - - registerIdlingResources - (IdlingResource... resources) -

-
-
- - - -
-
- - - - -

Registers one or more IdlingResources with the framework. It is expected, although not - strictly required, that this method will be called at test setup time prior to any interaction - with the application under test. When registering more than one resource, ensure that each has - a unique name. If any of the given resources is already registered, a warning is logged.

-
-
Returns
-
  • true if all resources were successfully registered -
-
- -
-
- - - - -
-

- - public - static - - - - void - - registerLooperAsIdlingResource - (Looper looper, boolean considerWaitIdle) -

-
-
- - - -
-
- - - - -

Registers a Looper for idle checking with the framework. This is intended for use with - non-UI thread loopers. - -

This method allows the caller to consider Thread.State.WAIT to be 'idle'. - -

This is useful in the case where a looper is sending a message to the UI thread - synchronously through a wait/notify mechanism.

-
-
Throws
- - - - -
IllegalArgumentException - if looper is the main looper. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - registerLooperAsIdlingResource - (Looper looper) -

-
-
- - - -
-
- - - - -

Registers a Looper for idle checking with the framework. This is intended for use with - non-UI thread loopers.

-
-
Throws
- - - - -
IllegalArgumentException - if looper is the main looper. -
-
- -
-
- - - - -
-

- - public - static - - - - void - - setFailureHandler - (FailureHandler failureHandler) -

-
-
- - - -
-
- - - - -

Changes the default FailureHandler to the given one. -

- -
-
- - - - -
-

- - public - static - - - - boolean - - unregisterIdlingResources - (IdlingResource... resources) -

-
-
- - - -
-
- - - - -

Unregisters one or more IdlingResources. If any of the given resources are not already - registered, a warning is logged.

-
-
Returns
-
  • true if all resources were successfully unregistered -
-
- -
+ + +
  • Classes

    + +
  • + + +
  • Exceptions

    + +
  • + + +
    - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    - - - - - - diff --git a/docs/html/reference/android/support/test/espresso/EspressoException.html b/docs/html/reference/android/support/test/espresso/EspressoException.html index f3827c1b6aac..078a5c52de82 100644 --- a/docs/html/reference/android/support/test/espresso/EspressoException.html +++ b/docs/html/reference/android/support/test/espresso/EspressoException.html @@ -1,4 +1,3 @@ - @@ -93,508 +92,76 @@ - - - - - - -EspressoException | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    + + +
    +
    + + + + +
    @@ -618,246 +185,205 @@ Summary: | [Expand All]
    -
    - - - - -
    +
    -
    - public +

    EspressoException

    +

    + + public + + + + interface + EspressoException + +
    + + + + + - interface -

    EspressoException

    +

    - - - - - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.EspressoException
    android.support.test.espresso.EspressoException +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Used for identifying an exception as coming from the Espresso framework. +

    Used for identifying an exception as coming from the Espresso framework.

    -
    - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - @@ -892,193 +418,64 @@ Summary: - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/FailureHandler.html b/docs/html/reference/android/support/test/espresso/FailureHandler.html index 9c3cbfdc7982..53ee72227136 100644 --- a/docs/html/reference/android/support/test/espresso/FailureHandler.html +++ b/docs/html/reference/android/support/test/espresso/FailureHandler.html @@ -1,4 +1,3 @@ - @@ -93,508 +92,76 @@ - - - - - - -FailureHandler | Android Developers - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -614,137 +181,106 @@ Summary: Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public - - - - interface -

    FailureHandler

    - - - - - - +

    FailureHandler

    +

    + + public + + + + interface + FailureHandler + +
    + + + + + +

    - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.FailureHandler
    android.support.test.espresso.FailureHandler +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Handles failures that happen during test execution. +

    Handles failures that happen during test execution.

    -
    - - - - - - - - - - - - - - - -
    - -

    Summary

    +

    Summary

    @@ -773,33 +309,38 @@ Summary: - - - - - - - - - + +
    +

    callActivityOnStart

    +
    +
    + + -
    - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Methods
    - abstract + + - - void - - + + + + + - + + +

    + + + +

    Public methods

    - handle(Throwable error, Matcher<View> viewMatcher) - -
    - Handle the given error in a manner that makes sense to the environment in which the test is + +
    + abstract + + + + + void + + + handle(Throwable error, Matcher<View> viewMatcher) + + +

    Handle the given error in a manner that makes sense to the environment in which the test is executed (e.g. - - - - - -

    @@ -810,16 +351,6 @@ Summary: - - - - - - - - - - @@ -845,42 +376,47 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - handle - (Throwable error, Matcher<View> viewMatcher) -

    -
    -
    - - - -
    -
    +
    +

    handle

    +
    +
    + + - - - -

    Handle the given error in a manner that makes sense to the environment in which the test is +

    +
    +void handle (Throwable error, 
    +                Matcher<View> viewMatcher)
    + + + + +

    Handle the given error in a manner that makes sense to the environment in which the test is executed (e.g. take a screenshot, output extra debug info, etc). Upon handling, most handlers will choose to propagate the error. -

    +

    + + + + + + + + + + +
    Parameters
    error + Throwable +
    viewMatcher + Matcher +
    -
    @@ -892,193 +428,64 @@ Summary: - -
    - -
    - -
    - - - - - - + + diff --git a/docs/html/reference/android/support/test/espresso/GraphHolder.html b/docs/html/reference/android/support/test/espresso/GraphHolder.html index 21899aade208..2fdf8f1d86d8 100644 --- a/docs/html/reference/android/support/test/espresso/GraphHolder.html +++ b/docs/html/reference/android/support/test/espresso/GraphHolder.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -GraphHolder | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    + -
    + + +
    +
    +
    + + + +
    + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    GraphHolder

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    GraphHolder

    +

    + + public + + final + + class + GraphHolder + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.GraphHolder
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.GraphHolder +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Holds Espresso's object graph. +

    Holds Espresso's object graph.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -757,207 +297,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -966,16 +575,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1008,193 +607,64 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/IdlingPolicies.html b/docs/html/reference/android/support/test/espresso/IdlingPolicies.html index 706ee8d12942..d2d0e8e0a187 100644 --- a/docs/html/reference/android/support/test/espresso/IdlingPolicies.html +++ b/docs/html/reference/android/support/test/espresso/IdlingPolicies.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -IdlingPolicies | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +IdlingPolicies - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    IdlingPolicies

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    IdlingPolicies

    +

    + + public + + final + + class + IdlingPolicies + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.IdlingPolicies
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.IdlingPolicies +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Allows users fine grain control over idling policies. +

    Allows users fine grain control over idling policies. Espresso's default idling policies are suitable for most usecases - however certain execution environments (like the ARM emulator) might be very slow. @@ -711,27 +269,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -760,104 +300,131 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    +

    callActivityOnRestart

    +
    +
    + + +
    +
    +void callActivityOnRestart (Activity activity)
    + + + + +

    +
    Public Methods
    - - - - static - - IdlingPolicy - - getDynamicIdlingResourceErrorPolicy() - -
    - - - - static - - IdlingPolicy - - getDynamicIdlingResourceWarningPolicy() - -
    - - - - static - - IdlingPolicy - - getMasterIdlingPolicy() - -
    + + - static - - void - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - + + +

    + + + + + + + + + + + + + +

    Public methods

    - setIdlingResourceTimeout(long timeout, TimeUnit unit) - -
    - Updates the IdlingPolicy used by IdlingResourceRegistry to determine when IdlingResources + +
    + + + static + + + IdlingPolicy + + + getDynamicIdlingResourceErrorPolicy() + + +
    + + + static + + + IdlingPolicy + + + getDynamicIdlingResourceWarningPolicy() + + +
    + + + static + + + IdlingPolicy + + + getMasterIdlingPolicy() + + +
    + + + static + + + void + + + setIdlingResourceTimeout(long timeout, TimeUnit unit) + + +

    Updates the IdlingPolicy used by IdlingResourceRegistry to determine when IdlingResources timeout. - - - - - -

    - - - - static - - void - - setMasterPolicyTimeout(long timeout, TimeUnit unit) - -
    - Updates the IdlingPolicy used in UiController.loopUntil to detect AppNotIdleExceptions. - - - -
    - -
    + + + static + + + void + + + setMasterPolicyTimeout(long timeout, TimeUnit unit) + + +

    Updates the IdlingPolicy used in UiController.loopUntil to detect AppNotIdleExceptions. + + +

    + +
    @@ -869,207 +436,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1078,16 +714,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1113,196 +739,168 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - IdlingPolicy - - getDynamicIdlingResourceErrorPolicy - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getDynamicIdlingResourceErrorPolicy

    +
    +
    + +
    +
    +IdlingPolicy getDynamicIdlingResourceErrorPolicy ()
    + + + + +

    + + + + + + +
    Returns
    IdlingPolicy
    +
    -
    -

    - - public - static - - - - IdlingPolicy - - getDynamicIdlingResourceWarningPolicy - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getDynamicIdlingResourceWarningPolicy

    +
    +
    + +
    +
    +IdlingPolicy getDynamicIdlingResourceWarningPolicy ()
    + + + + +

    + + + + + + +
    Returns
    IdlingPolicy
    +
    -
    -

    - - public - static - - - - IdlingPolicy - - getMasterIdlingPolicy - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getMasterIdlingPolicy

    +
    +
    + +
    +
    +IdlingPolicy getMasterIdlingPolicy ()
    + + + + +

    + + + + + + +
    Returns
    IdlingPolicy
    +
    -
    -

    - - public - static - +
    +

    setIdlingResourceTimeout

    +
    +
    + + - - void - - setIdlingResourceTimeout - (long timeout, TimeUnit unit) -

    -
    -
    - - - -
    -
    - - - - -

    Updates the IdlingPolicy used by IdlingResourceRegistry to determine when IdlingResources - timeout.

    -
    -
    Parameters
    - - - - - - +
    timeout - the timeout before an IdlingResourceTimeoutException is created.
    unit - the unit of the timeout value. + +
    +void setIdlingResourceTimeout (long timeout, 
    +                TimeUnit unit)
    + + + + +

    Updates the IdlingPolicy used by IdlingResourceRegistry to determine when IdlingResources + timeout.

    + + + + + + + + + - -
    Parameters
    timeout + long: + the timeout before an IdlingResourceTimeoutException is created.
    unit + TimeUnit: + the unit of the timeout value.
    - +
    -
    -
    -

    - - public - static - - - - void - - setMasterPolicyTimeout - (long timeout, TimeUnit unit) -

    -
    -
    - - +
    +

    setMasterPolicyTimeout

    +
    +
    + + -
    -
    - - - - -

    Updates the IdlingPolicy used in UiController.loopUntil to detect AppNotIdleExceptions.

    -
    -
    Parameters
    - - - - - - +
    timeout - the timeout before an AppNotIdleException is created.
    unit - the unit of the timeout value. + +
    +void setMasterPolicyTimeout (long timeout, 
    +                TimeUnit unit)
    + + + + +

    Updates the IdlingPolicy used in UiController.loopUntil to detect AppNotIdleExceptions.

    + + + + + + + + + - -
    Parameters
    timeout + long: + the timeout before an AppNotIdleException is created.
    unit + TimeUnit: + the unit of the timeout value.
    - +
    -
    @@ -1314,193 +912,64 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/IdlingPolicy.html b/docs/html/reference/android/support/test/espresso/IdlingPolicy.html index a4b3cfeb714e..c914cd347383 100644 --- a/docs/html/reference/android/support/test/espresso/IdlingPolicy.html +++ b/docs/html/reference/android/support/test/espresso/IdlingPolicy.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -IdlingPolicy | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +IdlingPolicy - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    IdlingPolicy

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    IdlingPolicy

    +

    + + public + + final + + class + IdlingPolicy + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.IdlingPolicy
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.IdlingPolicy +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Allows users to control idling idleTimeouts in Espresso. +

    Allows users to control idling idleTimeouts in Espresso.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -755,78 +295,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - long - - getIdleTimeout() - -
    - The amount of time the policy allows a resource to be non-idle. - - - -
    - -
    - - - - - - TimeUnit - - getIdleTimeoutUnit() - -
    - The unit for getIdleTimeout(). - - - -
    - -
    - - - - - - void - - handleTimeout(List<String> busyResources, String message) - -
    - Invoked when the idle idleTimeout has been exceeded. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + long + + + getIdleTimeout() + + +

    The amount of time the policy allows a resource to be non-idle. + + +

    + +
    + + + + + + TimeUnit + + + getIdleTimeoutUnit() + + +

    The unit for getIdleTimeout(). + + +

    + +
    + + + + + + void + + + handleTimeout(List<String> busyResources, String message) + + +

    Invoked when the idle idleTimeout has been exceeded. + + +

    + +
    @@ -838,207 +391,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1047,16 +669,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1082,119 +694,103 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - long - - getIdleTimeout - () -

    -
    -
    - - - -
    -
    - - +
    +

    getIdleTimeout

    +
    +
    + + +
    +
    +long getIdleTimeout ()
    + + -

    The amount of time the policy allows a resource to be non-idle. -

    + +

    The amount of time the policy allows a resource to be non-idle. +

    + + + + + + +
    Returns
    long
    -
    -
    -

    - - public - - - - - TimeUnit - - getIdleTimeoutUnit - () -

    -
    -
    - - - -
    -
    - - +
    +

    getIdleTimeoutUnit

    +
    +
    + + +
    +
    +TimeUnit getIdleTimeoutUnit ()
    + + -

    The unit for getIdleTimeout(). -

    + +

    The unit for getIdleTimeout(). +

    + + + + + + +
    Returns
    TimeUnit
    -
    -
    -

    - - public - - - - - void - - handleTimeout - (List<String> busyResources, String message) -

    -
    -
    +
    +

    handleTimeout

    +
    +
    + + - - -
    -
    - - - - -

    Invoked when the idle idleTimeout has been exceeded.

    -
    -
    Parameters
    - - - - - - +
    busyResources - the resources that are not idle.
    message - an additional message to include in an exception. + +
    +void handleTimeout (List<String> busyResources, 
    +                String message)
    + + + + +

    Invoked when the idle idleTimeout has been exceeded.

    + + + + + + + + + - -
    Parameters
    busyResources + List: + the resources that are not idle.
    message + String: + an additional message to include in an exception.
    - +
    -
    @@ -1206,193 +802,64 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/IdlingResource.ResourceCallback.html b/docs/html/reference/android/support/test/espresso/IdlingResource.ResourceCallback.html index 907790b559da..294e586a7b41 100644 --- a/docs/html/reference/android/support/test/espresso/IdlingResource.ResourceCallback.html +++ b/docs/html/reference/android/support/test/espresso/IdlingResource.ResourceCallback.html @@ -1,7 +1,3 @@ - - - - @@ -93,598 +89,139 @@ - - - - - - -IdlingResource.ResourceCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    + + + -
    + + + + + + + + + - -
    + + + -
    -
    +IdlingResource.ResourceCallback - + -
    - public - static + + - interface -

    IdlingResource.ResourceCallback

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    IdlingResource.ResourceCallback

    +

    + + public + static + + + interface + IdlingResource.ResourceCallback + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.espresso.IdlingResource.ResourceCallback
    android.support.test.espresso.IdlingResource.ResourceCallback +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Registered by an IdlingResource to notify Espresso of a transition to idle. +

    Registered by an IdlingResource to notify Espresso of a transition to idle.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -713,32 +250,37 @@ type="text/css"> - - - - - - - - -
    Public Methods
    - abstract + + - - void - - - + + + + + + + + +

    Public methods

    - onTransitionToIdle() - -
    - Called when the resource goes from busy to idle. - - - -
    - -
    + abstract + + + + + void + + + onTransitionToIdle() + + +

    Called when the resource goes from busy to idle. + + +

    + +
    @@ -749,16 +291,6 @@ type="text/css"> - - - - - - - - - - @@ -784,40 +316,29 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - onTransitionToIdle - () -

    -
    -
    - - - -
    -
    - - +
    +

    onTransitionToIdle

    +
    +
    + + +
    +
    +void onTransitionToIdle ()
    + + -

    Called when the resource goes from busy to idle. -

    + +

    Called when the resource goes from busy to idle. +

    -
    @@ -829,193 +350,64 @@ type="text/css"> - -
    - -
    - -
    - - - - - - - + + diff --git a/docs/html/reference/android/support/test/espresso/IdlingResource.html b/docs/html/reference/android/support/test/espresso/IdlingResource.html index ed5d6517ea19..821be1fe05c0 100644 --- a/docs/html/reference/android/support/test/espresso/IdlingResource.html +++ b/docs/html/reference/android/support/test/espresso/IdlingResource.html @@ -1,4 +1,3 @@ - @@ -93,508 +92,76 @@ - - - - - - -IdlingResource | Android Developers - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -604,7 +171,7 @@ type="text/css"> Summary: Nested Classes - + @@ -617,115 +184,106 @@ Summary: | Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public - - - - interface -

    IdlingResource

    - - +

    IdlingResource

    +

    + + public + + + + interface + IdlingResource + +
    + + + + + +

    - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.IdlingResource
    android.support.test.espresso.IdlingResource +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Represents a resource of an application under test which can cause asynchronous background work +

    Represents a resource of an application under test which can cause asynchronous background work to happen during test execution (e.g. an intent service that processes a button click). By - default, Espresso synchronizes all view operations with the UI thread as well as + default, Espresso synchronizes all view operations with the UI thread as well as AsyncTasks; however, it has no way of doing so with "hand-made" resources. In such cases, test - authors can register the custom resource and Espresso will wait for the resource to + authors can register the custom resource and Espresso will wait for the resource to become idle prior to executing a view operation.

    Important Note: it is assumed that the resource stays idle most of the time. @@ -735,52 +293,35 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - interfaceIdlingResource.ResourceCallback
    + + + + + + - - + + @@ -809,78 +350,91 @@ Summary: -

    Nested classes

    + + + + + interface - Registered by an IdlingResource to notify Espresso of a transition to idle.  - - - + IdlingResource.ResourceCallback +

    Registered by an IdlingResource to notify Espresso of a transition to idle.  + + +

    - - - - - - - - - - - - - - - +
    Public Methods
    - abstract - - - - - String - - getName() - -
    - Returns the name of the resources (used for logging and idempotency of registration). - - - -
    - -
    - abstract - - - - - boolean - - isIdleNow() - -
    - Returns true if resource is currently idle. - - - -
    - -
    + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - abstract - - - void - - registerIdleTransitionCallback(IdlingResource.ResourceCallback callback) - -
    - Registers the given IdlingResource.ResourceCallback with the resource. - - - -
    - -
    + abstract + + + + + String + + + getName() + + +

    Returns the name of the resources (used for logging and idempotency of registration). + + +

    + +
    + abstract + + + + + boolean + + + isIdleNow() + + +

    Returns true if resource is currently idle. + + +

    + +
    + abstract + + + + + void + + + registerIdleTransitionCallback(IdlingResource.ResourceCallback callback) + + +

    Registers the given IdlingResource.ResourceCallback with the resource. + + +

    + +
    @@ -891,16 +445,6 @@ Summary: -
    - - - - - - - - - @@ -926,106 +470,88 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - String - - getName - () -

    -
    -
    - - - -
    -
    - - +
    +

    getName

    +
    +
    + + +
    +
    +String getName ()
    + + -

    Returns the name of the resources (used for logging and idempotency of registration). -

    + +

    Returns the name of the resources (used for logging and idempotency of registration). +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - abstract - - boolean - - isIdleNow - () -

    -
    -
    - - - -
    -
    - - +
    +

    isIdleNow

    +
    +
    + + +
    +
    +boolean isIdleNow ()
    + + -

    Returns true if resource is currently idle. Espresso will always call this + +

    Returns true if resource is currently idle. Espresso will always call this method from the main thread, therefore it should be non-blocking and return immediately. -

    +

    + + + + + + +
    Returns
    boolean
    -
    -
    -

    - - public - - - abstract - - void - - registerIdleTransitionCallback - (IdlingResource.ResourceCallback callback) -

    -
    -
    - - - -
    -
    - - +
    +

    registerIdleTransitionCallback

    +
    +
    + + +
    +
    +void registerIdleTransitionCallback (IdlingResource.ResourceCallback callback)
    + + -

    Registers the given IdlingResource.ResourceCallback with the resource. Espresso will call this method: + +

    Registers the given IdlingResource.ResourceCallback with the resource. Espresso will call this method:

      -
    • with its implementation of IdlingResource.ResourceCallback so it can be notified asynchronously +
    • with its implementation of IdlingResource.ResourceCallback so it can be notified asynchronously that your resource is idle
    • from the main thread, but you are free to execute the callback's onTransitionToIdle from any thread @@ -1034,9 +560,17 @@ Summary:
      You only need to call this upon transition from busy to idle - if the resource is already idle when the method is called invoking the call back is optional and has no significant impact. -

    +

    + + + + + + +
    Parameters
    callback + IdlingResource.ResourceCallback +
    -
    @@ -1048,193 +582,64 @@ Summary: - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/IdlingResourceTimeoutException.html b/docs/html/reference/android/support/test/espresso/IdlingResourceTimeoutException.html index f0384e447f59..367ecb2746ae 100644 --- a/docs/html/reference/android/support/test/espresso/IdlingResourceTimeoutException.html +++ b/docs/html/reference/android/support/test/espresso/IdlingResourceTimeoutException.html @@ -1,4 +1,3 @@ - @@ -93,544 +92,112 @@ - - - - - - -IdlingResourceTimeoutException | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +IdlingResourceTimeoutException - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    IdlingResourceTimeoutException

    - - - - - - - - - - - - - - - - - extends RuntimeException
    - - - - - - +

    IdlingResourceTimeoutException

    +

    + + public + + final + + class + IdlingResourceTimeoutException + +
    + + + + + + + + + + + + + + + + + + + + + + + extends RuntimeException + + + + + + + + implements - - EspressoException - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + EspressoException + + + + + +

    java.lang.Object
       ↳java.lang.Throwable
        ↳java.lang.Exception
         ↳java.lang.RuntimeException
          ↳android.support.test.espresso.IdlingResourceTimeoutException
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Throwable +
        ↳java.lang.Exception +
         ↳java.lang.RuntimeException +
          ↳android.support.test.espresso.IdlingResourceTimeoutException +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Indicates that an IdlingResource, which has been registered with the framework, has not +

    Indicates that an IdlingResource, which has been registered with the framework, has not idled within the allowed time. Since it is not safe to proceed with test execution while the registered resource is busy (as it is likely to cause inconsistent results in the test), this is an unrecoverable error. The test - author should verify that the IdlingResource interface has been implemented correctly. + author should verify that the IdlingResource interface has been implemented correctly.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -836,25 +385,23 @@ Summary: - - - - - - - - - + +
    Public Constructors
    + + - - - - - - + + + + + + +

    Public constructors

    - IdlingResourceTimeoutException(List<String> resourceNames) - -
    + + IdlingResourceTimeoutException(List<String> resourceNames) + + +
    @@ -870,9 +417,8 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + @@ -880,233 +426,315 @@ Summary: - @@ -1114,201 +742,271 @@ From class - @@ -1321,16 +1019,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Throwable + + From +class + + + java.lang.Throwable + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1348,39 +1036,37 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - IdlingResourceTimeoutException - (List<String> resourceNames) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    IdlingResourceTimeoutException

    +
    +
    + +
    +
    +IdlingResourceTimeoutException (List<String> resourceNames)
    + + + + +

    + + + + + + +
    Parameters
    resourceNames + List +
    +
    @@ -1402,193 +1088,64 @@ From class - -
    - -
    - -
    - - - -
    - - + + diff --git a/docs/html/reference/android/support/test/espresso/InjectEventSecurityException.html b/docs/html/reference/android/support/test/espresso/InjectEventSecurityException.html index c5341a55b8e0..adb58640292d 100644 --- a/docs/html/reference/android/support/test/espresso/InjectEventSecurityException.html +++ b/docs/html/reference/android/support/test/espresso/InjectEventSecurityException.html @@ -1,4 +1,3 @@ - @@ -93,539 +92,107 @@ - - - - - - -InjectEventSecurityException | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +InjectEventSecurityException - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    InjectEventSecurityException

    - - - - - - - - - - - - - extends Exception
    - - - - - - +

    InjectEventSecurityException

    +

    + + public + + final + + class + InjectEventSecurityException + +
    + + + + + + + + + + + + + + + + + extends Exception + + + + + + + + implements - - EspressoException - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + EspressoException + + + + + +

    java.lang.Object
       ↳java.lang.Throwable
        ↳java.lang.Exception
         ↳android.support.test.espresso.InjectEventSecurityException
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Throwable +
        ↳java.lang.Exception +
         ↳android.support.test.espresso.InjectEventSecurityException +
    + + +

    - - - -
    - - -

    Class Overview

    -

    An checked Exception indicating that event injection failed with a - SecurityException. +

    An checked Exception indicating that event injection failed with a + SecurityException.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -809,57 +355,49 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Constructors
    - - - - - - - - InjectEventSecurityException(String message) - -
    - - - - - - - - InjectEventSecurityException(Throwable cause) - -
    - - - - - - - - InjectEventSecurityException(String message, Throwable cause) - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + InjectEventSecurityException(String message) + + +
    + + InjectEventSecurityException(Throwable cause) + + +
    + + InjectEventSecurityException(String message, Throwable cause) + + +
    @@ -875,241 +413,322 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1117,201 +736,271 @@ From class - @@ -1324,16 +1013,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Throwable + + From +class + + + java.lang.Throwable + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1351,103 +1030,104 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - InjectEventSecurityException - (String message) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    InjectEventSecurityException

    +
    +
    + +
    +
    +InjectEventSecurityException (String message)
    + + + + +

    + + + + + + +
    Parameters
    message + String +
    +
    -
    -

    - - public - - - - - - - InjectEventSecurityException - (Throwable cause) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    InjectEventSecurityException

    +
    +
    + +
    +
    +InjectEventSecurityException (Throwable cause)
    + + + + +

    + + + + + + +
    Parameters
    cause + Throwable +
    +
    -
    -

    - - public - - - - - - - InjectEventSecurityException - (String message, Throwable cause) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    InjectEventSecurityException

    +
    +
    + +
    +
    +InjectEventSecurityException (String message, 
    +                Throwable cause)
    + + + + +

    + + + + + + + + + + +
    Parameters
    message + String +
    cause + Throwable +
    +
    @@ -1469,193 +1149,64 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/NoActivityResumedException.html b/docs/html/reference/android/support/test/espresso/NoActivityResumedException.html index 1846c14ef045..bfe1ab738b79 100644 --- a/docs/html/reference/android/support/test/espresso/NoActivityResumedException.html +++ b/docs/html/reference/android/support/test/espresso/NoActivityResumedException.html @@ -1,4 +1,3 @@ - @@ -93,544 +92,112 @@ - - - - - - -NoActivityResumedException | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +NoActivityResumedException - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    NoActivityResumedException

    - - - - - - - - - - - - - - - - - extends RuntimeException
    - - - - - - +

    NoActivityResumedException

    +

    + + public + + final + + class + NoActivityResumedException + +
    + + + + + + + + + + + + + + + + + + + + + + + extends RuntimeException + + + + + + + + implements - - EspressoException - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + EspressoException + + + + + +

    java.lang.Object
       ↳java.lang.Throwable
        ↳java.lang.Exception
         ↳java.lang.RuntimeException
          ↳android.support.test.espresso.NoActivityResumedException
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Throwable +
        ↳java.lang.Exception +
         ↳java.lang.RuntimeException +
          ↳android.support.test.espresso.NoActivityResumedException +
    + + +

    - - - -
    - - -

    Class Overview

    -

    An exception which indicates that there are no activities in stage RESUMED. +

    An exception which indicates that there are no activities in stage RESUMED.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -831,41 +380,36 @@ Summary: - - - - - - - - - - - - - - - +
    Public Constructors
    - - - - - - - - NoActivityResumedException(String description) - -
    - - - - - - - - NoActivityResumedException(String description, Throwable cause) - -
    + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + NoActivityResumedException(String description) + + +
    + + NoActivityResumedException(String description, Throwable cause) + + +
    @@ -881,9 +425,8 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + @@ -891,233 +434,315 @@ Summary: - @@ -1125,201 +750,271 @@ From class - @@ -1332,16 +1027,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Throwable + + From +class + + + java.lang.Throwable + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1359,71 +1044,74 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - NoActivityResumedException - (String description) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    NoActivityResumedException

    +
    +
    + +
    +
    +NoActivityResumedException (String description)
    + + + + +

    + + + + + + +
    Parameters
    description + String +
    +
    -
    -

    - - public - - - - - - - NoActivityResumedException - (String description, Throwable cause) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    NoActivityResumedException

    +
    +
    + +
    +
    +NoActivityResumedException (String description, 
    +                Throwable cause)
    + + + + +

    + + + + + + + + + + +
    Parameters
    description + String +
    cause + Throwable +
    +
    @@ -1445,193 +1133,64 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/NoMatchingRootException.html b/docs/html/reference/android/support/test/espresso/NoMatchingRootException.html index 9cd9bbcb0d30..2d9e3061f219 100644 --- a/docs/html/reference/android/support/test/espresso/NoMatchingRootException.html +++ b/docs/html/reference/android/support/test/espresso/NoMatchingRootException.html @@ -1,4 +1,3 @@ - @@ -93,544 +92,112 @@ - - - - - - -NoMatchingRootException | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +NoMatchingRootException - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    NoMatchingRootException

    - - - - - - - - - - - - - - - - - extends RuntimeException
    - - - - - - +

    NoMatchingRootException

    +

    + + public + + final + + class + NoMatchingRootException + +
    + + + + + + + + + + + + + + + + + + + + + + + extends RuntimeException + + + + + + + + implements - - EspressoException - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + EspressoException + + + + + +

    java.lang.Object
       ↳java.lang.Throwable
        ↳java.lang.Exception
         ↳java.lang.RuntimeException
          ↳android.support.test.espresso.NoMatchingRootException
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Throwable +
        ↳java.lang.Exception +
         ↳java.lang.RuntimeException +
          ↳android.support.test.espresso.NoMatchingRootException +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Indicates that a given matcher did not match any Roots (windows) from those that are +

    Indicates that a given matcher did not match any Roots (windows) from those that are currently available.

    @@ -787,27 +354,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -836,25 +385,32 @@ Summary: - - - - - - - - - - + +
    Public Methods
    + + - static - - NoMatchingRootException - - - + + + + + + + + +

    Public methods

    - create(Matcher<Root> rootMatcher, List<Root> roots) - -
    + + + static + + + NoMatchingRootException + + + create(Matcher<Root> rootMatcher, List<Root> roots) + + +
    @@ -866,9 +422,8 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + @@ -876,233 +431,315 @@ Summary: - @@ -1110,201 +747,271 @@ From class - @@ -1317,16 +1024,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Throwable + + From +class + + + java.lang.Throwable + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1352,39 +1049,51 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - NoMatchingRootException - - create - (Matcher<Root> rootMatcher, List<Root> roots) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    create

    +
    +
    + +
    +
    +NoMatchingRootException create (Matcher<Root> rootMatcher, 
    +                List<Root> roots)
    + + + + +

    + + + + + + + + + + +
    Parameters
    rootMatcher + Matcher +
    roots + List +
    + + + + + + +
    Returns
    NoMatchingRootException
    +
    @@ -1396,193 +1105,64 @@ From class - -
    - -
    - -
    - - - -
    - - + + diff --git a/docs/html/reference/android/support/test/espresso/NoMatchingViewException.Builder.html b/docs/html/reference/android/support/test/espresso/NoMatchingViewException.Builder.html index 70bdf58eb491..c3168f5896d0 100644 --- a/docs/html/reference/android/support/test/espresso/NoMatchingViewException.Builder.html +++ b/docs/html/reference/android/support/test/espresso/NoMatchingViewException.Builder.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -NoMatchingViewException.Builder | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +NoMatchingViewException.Builder - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - class -

    NoMatchingViewException.Builder

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    NoMatchingViewException.Builder

    +

    + + public + static + + + class + NoMatchingViewException.Builder + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.NoMatchingViewException.Builder
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.NoMatchingViewException.Builder +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Builder for NoMatchingViewException.

    - - - - - -
    - - - - - - - - - +

    Builder for NoMatchingViewException.

    @@ -725,10 +268,7 @@ Summary: -
    - - -

    Summary

    +

    Summary

    @@ -753,25 +293,23 @@ Summary: - - - - - - - - - + - - - - - - -
    Public Constructors
    - + + - - - - - + + + + + + +

    Public constructors

    - NoMatchingViewException.Builder() - -
    + + NoMatchingViewException.Builder() + + +
    @@ -782,121 +320,164 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - NoMatchingViewException - - build() - -
    - - - - - - NoMatchingViewException.Builder - - from(NoMatchingViewException exception) - -
    - - - - - - NoMatchingViewException.Builder - - includeViewHierarchy(boolean includeViewHierarchy) - -
    - - - - - - NoMatchingViewException.Builder - - withAdapterViewWarning(Optional<String> adapterViewWarning) - -
    - - - - - - NoMatchingViewException.Builder - - withAdapterViews(List<View> adapterViews) - -
    - - - - - - NoMatchingViewException.Builder - - withRootView(View rootView) - -
    - - - - - - NoMatchingViewException.Builder - - withViewMatcher(Matcher<? super View> viewMatcher) - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + NoMatchingViewException + + + build() + + +
    + + + + + + NoMatchingViewException.Builder + + + from(NoMatchingViewException exception) + + +
    + + + + + + NoMatchingViewException.Builder + + + includeViewHierarchy(boolean includeViewHierarchy) + + +
    + + + + + + NoMatchingViewException.Builder + + + withAdapterViewWarning(Optional<String> adapterViewWarning) + + +
    + + + + + + NoMatchingViewException.Builder + + + withAdapterViews(List<View> adapterViews) + + +
    + + + + + + NoMatchingViewException.Builder + + + withRootView(View rootView) + + +
    + + + + + + NoMatchingViewException.Builder + + + withViewMatcher(Matcher<? super View> viewMatcher) + + +
    @@ -908,207 +489,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1117,16 +767,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1144,39 +784,28 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - NoMatchingViewException.Builder - () -

    -
    -
    - - - -
    -
    - - +
    +

    NoMatchingViewException.Builder

    +
    +
    + + +
    +
    +NoMatchingViewException.Builder ()
    + + -

    + +

    -
    @@ -1191,231 +820,257 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - NoMatchingViewException - - build - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    build

    +
    +
    + +
    +
    +NoMatchingViewException build ()
    + + + + +

    + + + + + + +
    Returns
    NoMatchingViewException
    +
    -
    -

    - - public - - - - - NoMatchingViewException.Builder - - from - (NoMatchingViewException exception) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    from

    +
    +
    + +
    +
    +NoMatchingViewException.Builder from (NoMatchingViewException exception)
    + + + + +

    + + + + + + +
    Parameters
    exception + NoMatchingViewException +
    + + + + + + +
    Returns
    NoMatchingViewException.Builder
    +
    -
    -

    - - public - - - - - NoMatchingViewException.Builder - - includeViewHierarchy - (boolean includeViewHierarchy) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    includeViewHierarchy

    +
    +
    + +
    +
    +NoMatchingViewException.Builder includeViewHierarchy (boolean includeViewHierarchy)
    + + + + +

    + + + + + + +
    Parameters
    includeViewHierarchy + boolean +
    + + + + + + +
    Returns
    NoMatchingViewException.Builder
    +
    -
    -

    - - public - - - - - NoMatchingViewException.Builder - - withAdapterViewWarning - (Optional<String> adapterViewWarning) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withAdapterViewWarning

    +
    +
    + +
    +
    +NoMatchingViewException.Builder withAdapterViewWarning (Optional<String> adapterViewWarning)
    + + + + +

    + + + + + + +
    Parameters
    adapterViewWarning + Optional +
    + + + + + + +
    Returns
    NoMatchingViewException.Builder
    +
    -
    -

    - - public - - - - - NoMatchingViewException.Builder - - withAdapterViews - (List<View> adapterViews) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withAdapterViews

    +
    +
    + +
    +
    +NoMatchingViewException.Builder withAdapterViews (List<View> adapterViews)
    + + + + +

    + + + + + + +
    Parameters
    adapterViews + List +
    + + + + + + +
    Returns
    NoMatchingViewException.Builder
    +
    -
    -

    - - public - - - - - NoMatchingViewException.Builder - - withRootView - (View rootView) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withRootView

    +
    +
    + +
    +
    +NoMatchingViewException.Builder withRootView (View rootView)
    + + + + +

    + + + + + + +
    Parameters
    rootView + View +
    + + + + + + +
    Returns
    NoMatchingViewException.Builder
    +
    -
    -

    - - public - - - - - NoMatchingViewException.Builder - - withViewMatcher - (Matcher<? super View> viewMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withViewMatcher

    +
    +
    + +
    +
    +NoMatchingViewException.Builder withViewMatcher (Matcher<? super View> viewMatcher)
    + + + + +

    + + + + + + +
    Parameters
    viewMatcher + Matcher +
    + + + + + + +
    Returns
    NoMatchingViewException.Builder
    +
    @@ -1427,193 +1082,64 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/NoMatchingViewException.html b/docs/html/reference/android/support/test/espresso/NoMatchingViewException.html index 111c2c8a5d38..e12133a3f417 100644 --- a/docs/html/reference/android/support/test/espresso/NoMatchingViewException.html +++ b/docs/html/reference/android/support/test/espresso/NoMatchingViewException.html @@ -1,4 +1,3 @@ - @@ -93,544 +92,112 @@ - - - - - - -NoMatchingViewException | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +NoMatchingViewException - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    NoMatchingViewException

    - - - - - - - - - - - - - - - - - extends RuntimeException
    - - - - - - +

    NoMatchingViewException

    +

    + + public + + final + + class + NoMatchingViewException + +
    + + + + + + + + + + + + + + + + + + + + + + + extends RuntimeException + + + + + + + + implements - - EspressoException - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + EspressoException + + + + + +

    java.lang.Object
       ↳java.lang.Throwable
        ↳java.lang.Exception
         ↳java.lang.RuntimeException
          ↳android.support.test.espresso.NoMatchingViewException
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Throwable +
        ↳java.lang.Exception +
         ↳java.lang.RuntimeException +
          ↳android.support.test.espresso.NoMatchingViewException +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Indicates that a given matcher did not match any elements in the view hierarchy. +

    Indicates that a given matcher did not match any elements in the view hierarchy.

    Contains details about the matcher and the current view hierarchy to aid in debugging.

    @@ -801,52 +368,35 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - classNoMatchingViewException.Builder
    + + + + + + - - + + @@ -875,33 +425,38 @@ Summary: -

    Nested classes

    + + + + + class - Builder for NoMatchingViewException.  - - - + NoMatchingViewException.Builder +

    Builder for NoMatchingViewException.  + + +

    - - - - - - -
    Public Methods
    - - - - - - String - - getViewMatcherDescription() - -
    - Returns a string description of the ViewMatcher that did not match any view + + + + + + + + + + + + - + + +

    + + + +

    Public methods

    + + + + + + String + + + getViewMatcherDescription() + + +

    Returns a string description of the ViewMatcher that did not match any view in the hierarchy. - - - - - -

    @@ -913,9 +468,8 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + @@ -923,233 +477,315 @@ Summary: - @@ -1157,201 +793,271 @@ From class - @@ -1364,16 +1070,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Throwable + + From +class + + + java.lang.Throwable + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1399,41 +1095,37 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - String - - getViewMatcherDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getViewMatcherDescription

    +
    +
    + + +
    +
    +String getViewMatcherDescription ()
    + + -

    Returns a string description of the ViewMatcher that did not match any view + +

    Returns a string description of the ViewMatcher that did not match any view in the hierarchy. -

    +

    + + + + + + +
    Returns
    String
    -
    @@ -1445,193 +1137,64 @@ From class - -
    - -
    - -
    - - - - - - + + diff --git a/docs/html/reference/android/support/test/espresso/PerformException.Builder.html b/docs/html/reference/android/support/test/espresso/PerformException.Builder.html index 0ecef9c26c9e..261d1542a87c 100644 --- a/docs/html/reference/android/support/test/espresso/PerformException.Builder.html +++ b/docs/html/reference/android/support/test/espresso/PerformException.Builder.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -PerformException.Builder | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +PerformException.Builder - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - class -

    PerformException.Builder

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    PerformException.Builder

    +

    + + public + static + + + class + PerformException.Builder + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.PerformException.Builder
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.PerformException.Builder +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Builder for PerformException. +

    Builder for PerformException.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -754,25 +294,23 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Constructors
    - + + - - - - - + + + + + + +

    Public constructors

    - PerformException.Builder() - -
    + + PerformException.Builder() + + +
    @@ -783,89 +321,120 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - PerformException - - build() - -
    - - - - - - PerformException.Builder - - from(PerformException instance) - -
    - - - - - - PerformException.Builder - - withActionDescription(String actionDescription) - -
    - - - - - - PerformException.Builder - - withCause(Throwable cause) - -
    - - - - - - PerformException.Builder - - withViewDescription(String viewDescription) - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + PerformException + + + build() + + +
    + + + + + + PerformException.Builder + + + from(PerformException instance) + + +
    + + + + + + PerformException.Builder + + + withActionDescription(String actionDescription) + + +
    + + + + + + PerformException.Builder + + + withCause(Throwable cause) + + +
    + + + + + + PerformException.Builder + + + withViewDescription(String viewDescription) + + +
    @@ -877,207 +446,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1086,16 +724,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1113,39 +741,28 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - PerformException.Builder - () -

    -
    -
    - - - -
    -
    - - +
    +

    PerformException.Builder

    +
    +
    + + +
    +
    +PerformException.Builder ()
    + + -

    + +

    -
    @@ -1160,167 +777,183 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - PerformException - - build - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    build

    +
    +
    + +
    +
    +PerformException build ()
    + + + + +

    + + + + + + +
    Returns
    PerformException
    +
    -
    -

    - - public - - - - - PerformException.Builder - - from - (PerformException instance) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    from

    +
    +
    + +
    +
    +PerformException.Builder from (PerformException instance)
    + + + + +

    + + + + + + +
    Parameters
    instance + PerformException +
    + + + + + + +
    Returns
    PerformException.Builder
    +
    -
    -

    - - public - - - - - PerformException.Builder - - withActionDescription - (String actionDescription) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withActionDescription

    +
    +
    + +
    +
    +PerformException.Builder withActionDescription (String actionDescription)
    + + + + +

    + + + + + + +
    Parameters
    actionDescription + String +
    + + + + + + +
    Returns
    PerformException.Builder
    +
    -
    -

    - - public - - - - - PerformException.Builder - - withCause - (Throwable cause) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withCause

    +
    +
    + +
    +
    +PerformException.Builder withCause (Throwable cause)
    + + + + +

    + + + + + + +
    Parameters
    cause + Throwable +
    + + + + + + +
    Returns
    PerformException.Builder
    +
    -
    -

    - - public - - - - - PerformException.Builder - - withViewDescription - (String viewDescription) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withViewDescription

    +
    +
    + +
    +
    +PerformException.Builder withViewDescription (String viewDescription)
    + + + + +

    + + + + + + +
    Parameters
    viewDescription + String +
    + + + + + + +
    Returns
    PerformException.Builder
    +
    @@ -1332,193 +965,64 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/PerformException.html b/docs/html/reference/android/support/test/espresso/PerformException.html index 458a966fc3ff..e36ecff558fc 100644 --- a/docs/html/reference/android/support/test/espresso/PerformException.html +++ b/docs/html/reference/android/support/test/espresso/PerformException.html @@ -1,4 +1,3 @@ - @@ -93,544 +92,112 @@ - - - - - - -PerformException | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +PerformException - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    PerformException

    - - - - - - - - - - - - - - - - - extends RuntimeException
    - - - - - - +

    PerformException

    +

    + + public + + final + + class + PerformException + +
    + + + + + + + + + + + + + + + + + + + + + + + extends RuntimeException + + + + + + + + implements - - EspressoException - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + EspressoException + + + + + +

    java.lang.Object
       ↳java.lang.Throwable
        ↳java.lang.Exception
         ↳java.lang.RuntimeException
          ↳android.support.test.espresso.PerformException
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Throwable +
        ↳java.lang.Exception +
         ↳java.lang.RuntimeException +
          ↳android.support.test.espresso.PerformException +
    + + +

    +

    Indicates that an exception occurred while performing a ViewAction on the UI thread. - - -

    - - -

    Class Overview

    -

    Indicates that an exception occurred while performing a ViewAction on the UI thread. - - A description of the ViewAction, the view being performed on and the cause are included - in the error. Note: FailureHandlers can mutate the exception later to make it more user + A description of the ViewAction, the view being performed on and the cause are included + in the error. Note: FailureHandlers can mutate the exception later to make it more user friendly. This is generally not recoverable so it is thrown on the instrumentation thread. @@ -795,52 +362,35 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - classPerformException.Builder
    + + + + + + - - + + @@ -869,41 +419,54 @@ Summary: -

    Nested classes

    + + + + + class - Builder for PerformException.  - - - + PerformException.Builder +

    Builder for PerformException.  + + +

    - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - String - - getActionDescription() - -
    - - - - - - String - - getViewDescription() - -
    + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + String + + + getActionDescription() + + +
    + + + + + + String + + + getViewDescription() + + +
    @@ -915,9 +478,8 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + @@ -925,233 +487,315 @@ Summary: - @@ -1159,201 +803,271 @@ From class - @@ -1366,16 +1080,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Throwable + + From +class + + + java.lang.Throwable + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1401,71 +1105,63 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - String - - getActionDescription - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getActionDescription

    +
    +
    + +
    +
    +String getActionDescription ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    -
    -

    - - public - - - - - String - - getViewDescription - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getViewDescription

    +
    +
    + +
    +
    +String getViewDescription ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    @@ -1477,193 +1173,64 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/Root.Builder.html b/docs/html/reference/android/support/test/espresso/Root.Builder.html index f1392e9187fc..77e33af1427e 100644 --- a/docs/html/reference/android/support/test/espresso/Root.Builder.html +++ b/docs/html/reference/android/support/test/espresso/Root.Builder.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -Root.Builder | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Root.Builder - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - class -

    Root.Builder

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    Root.Builder

    +

    + + public + static + + + class + Root.Builder + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.Root.Builder
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.Root.Builder +
    + + - - - - - -
    - - - - - - -
    - - - - - - - +

    @@ -721,11 +266,7 @@ Summary: - -
    - - -

    Summary

    +

    Summary

    @@ -750,25 +291,23 @@ Summary: - - - - - - - - - + +
    +CursorMatchers.CursorMatcher withRowFloat (int columnIndex, 
    +                float value)
    + + + + +

    Returns a matcher that matches a Float value at a given column index + in a Cursors data row. +

    +
    Public Constructors
    - - - + + - - - + + + + + + +

    Public constructors

    - Root.Builder() - -
    + + Root.Builder() + + +
    @@ -779,57 +318,76 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Root - - build() - -
    - - - - - - Root.Builder - - withDecorView(View view) - -
    - - - - - - Root.Builder - - withWindowLayoutParams(WindowManager.LayoutParams windowLayoutParams) - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Root + + + build() + + +
    + + + + + + Root.Builder + + + withDecorView(View view) + + +
    + + + + + + Root.Builder + + + withWindowLayoutParams(WindowManager.LayoutParams windowLayoutParams) + + +
    @@ -841,207 +399,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1050,16 +677,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1077,39 +694,28 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - Root.Builder - () -

    -
    -
    - - - -
    -
    - - +
    +

    Root.Builder

    +
    +
    + + +
    +
    +Root.Builder ()
    + + -

    + +

    -
    @@ -1124,103 +730,109 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Root - - build - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    build

    +
    +
    + +
    +
    +Root build ()
    + + + + +

    + + + + + + +
    Returns
    Root
    +
    -
    -

    - - public - - - - - Root.Builder - - withDecorView - (View view) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withDecorView

    +
    +
    + +
    +
    +Root.Builder withDecorView (View view)
    + + + + +

    + + + + + + +
    Parameters
    view + View +
    + + + + + + +
    Returns
    Root.Builder
    +
    -
    -

    - - public - - - - - Root.Builder - - withWindowLayoutParams - (WindowManager.LayoutParams windowLayoutParams) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withWindowLayoutParams

    +
    +
    + +
    +
    +Root.Builder withWindowLayoutParams (WindowManager.LayoutParams windowLayoutParams)
    + + + + +

    + + + + + + +
    Parameters
    windowLayoutParams + WindowManager.LayoutParams +
    + + + + + + +
    Returns
    Root.Builder
    +
    @@ -1232,193 +844,64 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/Root.html b/docs/html/reference/android/support/test/espresso/Root.html index d03b55814016..38ae4898b188 100644 --- a/docs/html/reference/android/support/test/espresso/Root.html +++ b/docs/html/reference/android/support/test/espresso/Root.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -Root | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Root - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    Root

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    Root

    +

    + + public + + final + + class + Root + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.Root
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.Root +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Represents a root view in the application and optionally the layout params of the window holding +

    Represents a root view in the application and optionally the layout params of the window holding it. This class is used internally to determine which view root to run user provided matchers against @@ -713,52 +271,35 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - classRoot.Builder
    + + + + + + - - + + @@ -787,57 +328,76 @@ Summary: -

    Nested classes

    + + + + + class -   - - - + Root.Builder +

      + + +

    - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - View - - getDecorView() - -
    - - - - - - Optional<WindowManager.LayoutParams> - - getWindowLayoutParams() - -
    - - - - - - String - - toString() - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + View + + + getDecorView() + + +
    + + + + + + Optional<WindowManager.LayoutParams> + + + getWindowLayoutParams() + + +
    + + + + + + String + + + toString() + + +
    @@ -849,207 +409,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1058,16 +687,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1093,103 +712,91 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - View - - getDecorView - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getDecorView

    +
    +
    + +
    +
    +View getDecorView ()
    + + + + +

    + + + + + + +
    Returns
    View
    +
    -
    -

    - - public - - - - - Optional<WindowManager.LayoutParams> - - getWindowLayoutParams - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getWindowLayoutParams

    +
    +
    + +
    +
    +Optional<WindowManager.LayoutParams> getWindowLayoutParams ()
    + + + + +

    + + + + + + +
    Returns
    Optional<WindowManager.LayoutParams>
    +
    -
    -

    - - public - - - - - String - - toString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toString

    +
    +
    + +
    +
    +String toString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    @@ -1201,193 +808,64 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/UiController.html b/docs/html/reference/android/support/test/espresso/UiController.html index d159045be185..0d6e19c3ea6b 100644 --- a/docs/html/reference/android/support/test/espresso/UiController.html +++ b/docs/html/reference/android/support/test/espresso/UiController.html @@ -1,4 +1,3 @@ - @@ -93,571 +92,127 @@ - - - - - - -UiController | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    + + + + -
    + + + + + + - -
    + + + -
    -
    +UiController - - -
    - public + + + - interface -

    UiController

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    UiController

    +

    + + public + + + + interface + UiController + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.espresso.UiController
    android.support.test.espresso.UiController +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Provides base-level UI operations (such as injection of MotionEvents) that can be used to +

    Provides base-level UI operations (such as injection of MotionEvents) that can be used to build user actions such as clicks, scrolls, swipes, etc. This replaces parts of the android Instrumentation class that provides similar functionality. However, it provides a more advanced synchronization mechanism for test actions. The key differentiators are: @@ -672,27 +227,9 @@ type="text/css"> -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -721,124 +258,145 @@ type="text/css"> - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Methods
    - abstract - - - - - boolean - - injectKeyEvent(KeyEvent event) - -
    - Injects a key event into the application. - - - -
    - -
    - abstract - - - - - boolean - - injectMotionEvent(MotionEvent event) - -
    - Injects a motion event into the application. - - - -
    - -
    - abstract - - - - - boolean - - injectString(String str) - -
    - Types a string into the application using series of KeyEvents. - - - -
    - -
    - abstract - - - - - void - - loopMainThreadForAtLeast(long millisDelay) - -
    - Loops the main thread for a specified period of time. + + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - abstract - - - - - void - - loopMainThreadUntilIdle() - -
    - Loops the main thread until the application goes idle. - - - -
    - -
    + abstract + + + + + boolean + + + injectKeyEvent(KeyEvent event) + + +

    Injects a key event into the application. + + +

    + +
    + abstract + + + + + boolean + + + injectMotionEvent(MotionEvent event) + + +

    Injects a motion event into the application. + + +

    + +
    + abstract + + + + + boolean + + + injectString(String str) + + +

    Types a string into the application using series of KeyEvents. + + +

    + +
    + abstract + + + + + void + + + loopMainThreadForAtLeast(long millisDelay) + + +

    Loops the main thread for a specified period of time. + + +

    + +
    + abstract + + + + + void + + + loopMainThreadUntilIdle() + + +

    Loops the main thread until the application goes idle. + + +

    + +
    @@ -849,16 +407,6 @@ type="text/css"> -
    - - - - - - - - - @@ -884,258 +432,209 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - boolean - - injectKeyEvent - (KeyEvent event) -

    -
    -
    - - +
    +

    injectKeyEvent

    +
    +
    + + -
    -
    - - - - -

    Injects a key event into the application.

    -
    -
    Parameters
    - - - - -
    event - the (non-null!) event to inject
    -
    -
    -
    Returns
    -
    • true if the event was injected, false otherwise
    -
    -
    -
    Throws
    - + +
    +boolean injectKeyEvent (KeyEvent event)
    + + + + +

    Injects a key event into the application.

    +
    + + + + + +
    Parameters
    event + KeyEvent: + the (non-null!) event to inject
    + + + + + + +
    Returns
    booleantrue if the event was injected, false otherwise
    + + - +
    Throws
    InjectEventSecurityException - if the event couldn't be injected because it would + InjectEventSecurityExceptionif the event couldn't be injected because it would interact with another application.
    -
    + -
    -
    -

    - - public - - - abstract - - boolean - - injectMotionEvent - (MotionEvent event) -

    -
    -
    - - +
    +

    injectMotionEvent

    +
    +
    + + -
    -
    - - - - -

    Injects a motion event into the application.

    -
    -
    Parameters
    - - - - -
    event - the (non-null!) event to inject
    -
    -
    -
    Returns
    -
    • true if the event was injected, false otherwise
    -
    -
    -
    Throws
    - + +
    +boolean injectMotionEvent (MotionEvent event)
    + + + + +

    Injects a motion event into the application.

    +
    + + + + + +
    Parameters
    event + MotionEvent: + the (non-null!) event to inject
    + + + + + + +
    Returns
    booleantrue if the event was injected, false otherwise
    + + - +
    Throws
    InjectEventSecurityException - if the event couldn't be injected because it would + InjectEventSecurityExceptionif the event couldn't be injected because it would interact with another application.
    -
    + -
    -
    -

    - - public - - - abstract - - boolean - - injectString - (String str) -

    -
    -
    - - +
    +

    injectString

    +
    +
    + + -
    -
    - - - - -

    Types a string into the application using series of KeyEvents. It is up to the - implementor to decide how to map the string to KeyEvent objects. if you need specific - control over the key events generated use injectKeyEvent(KeyEvent).

    -
    -
    Parameters
    - - - - -
    str - the (non-null!) string to type
    -
    -
    -
    Returns
    -
    • true if the string was injected, false otherwise
    -
    -
    -
    Throws
    - + +
    +boolean injectString (String str)
    + + + + +

    Types a string into the application using series of KeyEvents. It is up to the + implementor to decide how to map the string to KeyEvent objects. if you need specific + control over the key events generated use injectKeyEvent(KeyEvent).

    +
    + + + + + +
    Parameters
    str + String: + the (non-null!) string to type
    + + + + + + +
    Returns
    booleantrue if the string was injected, false otherwise
    + + - +
    Throws
    InjectEventSecurityException - if the events couldn't be injected because it would + InjectEventSecurityExceptionif the events couldn't be injected because it would interact with another application.
    -
    + -
    -
    -

    - - public - - - abstract - - void - - loopMainThreadForAtLeast - (long millisDelay) -

    -
    -
    - - - -
    -
    - - +
    +

    loopMainThreadForAtLeast

    +
    +
    + + +
    +
    +void loopMainThreadForAtLeast (long millisDelay)
    + + -

    Loops the main thread for a specified period of time. + +

    Loops the main thread for a specified period of time. Control may not return immediately, instead it'll return after the time has passed and the - queue is in an idle state again.

    -
    -
    Parameters
    - - - +
    millisDelay - time to spend in looping the main thread + queue is in an idle state again.

    + + + + + - -
    Parameters
    millisDelay + long: + time to spend in looping the main thread
    - +
    -
    -
    -

    - - public - - - abstract - - void - - loopMainThreadUntilIdle - () -

    -
    -
    - - - -
    -
    - - +
    +

    loopMainThreadUntilIdle

    +
    +
    + + +
    +
    +void loopMainThreadUntilIdle ()
    + + -

    Loops the main thread until the application goes idle. + +

    Loops the main thread until the application goes idle. An empty task is immediately inserted into the task queue to ensure that if we're idle at this moment we'll return instantly. -

    +

    -
    @@ -1147,193 +646,64 @@ type="text/css"> - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/ViewAction.html b/docs/html/reference/android/support/test/espresso/ViewAction.html index 46cccc5e2d30..fe8a71dddf07 100644 --- a/docs/html/reference/android/support/test/espresso/ViewAction.html +++ b/docs/html/reference/android/support/test/espresso/ViewAction.html @@ -1,5 +1,3 @@ - - @@ -93,508 +91,77 @@ - - - - - - -ViewAction | Android Developers - - - - - - - - - - - - - - - - - - - - -
    - + - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -614,268 +181,255 @@ Summary: Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public - +

    ViewAction

    +

    + + public + + + + interface + ViewAction + +
    - interface -

    ViewAction

    + + + + + +

    - - - - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.ViewAction
    android.support.test.espresso.ViewAction +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Responsible for performing an interaction on the given View element.
    +

    Responsible for performing an interaction on the given View element.

    This is part of the test framework public API - developers are free to write their own ViewAction implementations when necessary. When implementing a new ViewAction, follow these rules: @@ -898,27 +452,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -947,78 +483,91 @@ Summary: - - - - - - - - +
    Public Methods
    - abstract - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - abstract - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - abstract - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + abstract + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + abstract + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + abstract + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -1029,16 +578,6 @@ Summary: -
    - - - - - - - - - @@ -1064,129 +603,109 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - abstract - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - abstract - - void - - perform - (UiController uiController, View view) -

    -
    -
    - - - -
    -
    +
    +

    perform

    +
    +
    + + - - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1198,193 +717,64 @@ Summary: - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/ViewAssertion.html b/docs/html/reference/android/support/test/espresso/ViewAssertion.html index 225af1d2e6a1..f63a06c44b5c 100644 --- a/docs/html/reference/android/support/test/espresso/ViewAssertion.html +++ b/docs/html/reference/android/support/test/espresso/ViewAssertion.html @@ -1,7 +1,3 @@ - - - - @@ -93,571 +89,130 @@ - - - - - - -ViewAssertion | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    - -
    + + + + + + + + + + + - -
    + + + + -
    -
    +ViewAssertion - -
    - public + + + - interface -

    ViewAssertion

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    ViewAssertion

    +

    + + public + + + + interface + ViewAssertion + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.espresso.ViewAssertion
    android.support.test.espresso.ViewAssertion +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Responsible for performing assertions on a View element.
    +

    Responsible for performing assertions on a View element.

    This is considered part of the test framework public API - developers are free to write their own assertions as long as they meet the following requirements: @@ -679,27 +234,9 @@ type="text/css"> -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -728,32 +265,37 @@ type="text/css"> - - - - +
    Public Methods
    + - - - - + + + + + + + + +

    Public methods

    - abstract - - - void - - check(View view, NoMatchingViewException noViewFoundException) - -
    - Checks the state of the given view (if such a view is present). - - - -
    - -
    + abstract + + + + + void + + + check(View view, NoMatchingViewException noViewFoundException) + + +

    Checks the state of the given view (if such a view is present). + + +

    + +
    @@ -764,16 +306,6 @@ type="text/css"> -
    - - - - - - - - - @@ -799,55 +331,47 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - check - (View view, NoMatchingViewException noViewFoundException) -

    -
    -
    - - +
    +

    check

    +
    +
    + + -
    -
    - - - - -

    Checks the state of the given view (if such a view is present).

    -
    -
    Parameters
    - - - +
    view - the view, if one was found during the view interaction or null if it was not + +
    +void check (View view, 
    +                NoMatchingViewException noViewFoundException)
    + + + + +

    Checks the state of the given view (if such a view is present).

    + + + + + - - - + + + - -
    Parameters
    view + View: + the view, if one was found during the view interaction or null if it was not (which may be an acceptable option for an assertion)
    noViewFoundException - an exception detailing why the view could not be found or null if +
    noViewFoundException + NoMatchingViewException: + an exception detailing why the view could not be found or null if the view was found
    - +
    -
    @@ -859,193 +383,64 @@ type="text/css"> - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/ViewFinder.html b/docs/html/reference/android/support/test/espresso/ViewFinder.html index bdc219337c03..02c1c91aff33 100644 --- a/docs/html/reference/android/support/test/espresso/ViewFinder.html +++ b/docs/html/reference/android/support/test/espresso/ViewFinder.html @@ -1,4 +1,3 @@ - @@ -93,508 +92,76 @@ - - - - - - -ViewFinder | Android Developers - - - - - - - - - - - - - - - - - - - -
    - + - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -614,137 +181,106 @@ Summary: Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public +

    ViewFinder

    +

    + + public + + + + interface + ViewFinder + +
    + + + + + - interface -

    ViewFinder

    +

    - - - - - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.ViewFinder
    android.support.test.espresso.ViewFinder +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Uses matchers to locate particular views within the view hierarchy. +

    Uses matchers to locate particular views within the view hierarchy.

    -
    - - - - - - - - - - - - - - - - -
    -

    Summary

    +

    Summary

    @@ -773,32 +309,37 @@ Summary: - +
    Public Methods
    + - - - - - + + + + + + + + +

    Public methods

    - abstract - - - - - View - - getView() - -
    - Immediately locates a single view within the provided view hierarchy. - - - -
    - -
    + abstract + + + + + View + + + getView() + + +

    Immediately locates a single view within the provided view hierarchy. + + +

    + +
    @@ -809,16 +350,6 @@ Summary: -
    - - - - - - - - - @@ -844,59 +375,50 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - View - - getView - () -

    -
    -
    - - - -
    -
    - +
    +

    getView

    +
    +
    + + - - -

    Immediately locates a single view within the provided view hierarchy. - - If multiple views match, or if no views match the appropriate exception is thrown.

    -
    -
    Returns
    -
    • A singular view which matches the matcher we were constructed with.
    -
    -
    -
    Throws
    - + +
    +View getView ()
    + + + + +

    Immediately locates a single view within the provided view hierarchy. + + If multiple views match, or if no views match the appropriate exception is thrown.

    +
    + + + + + +
    Returns
    ViewA singular view which matches the matcher we were constructed with.
    + + - + + - +
    Throws
    AmbiguousViewMatcherException - when multiple views matchAmbiguousViewMatcherExceptionwhen multiple views match
    NoMatchingViewException - when no views match. + NoMatchingViewExceptionwhen no views match.
    -
    + -
    @@ -908,193 +430,64 @@ Summary: - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/ViewInteraction.html b/docs/html/reference/android/support/test/espresso/ViewInteraction.html index cc4fc2b071da..cd3f749592cd 100644 --- a/docs/html/reference/android/support/test/espresso/ViewInteraction.html +++ b/docs/html/reference/android/support/test/espresso/ViewInteraction.html @@ -1,4 +1,3 @@ - @@ -93,517 +92,85 @@ - - - - - - -ViewInteraction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ViewInteraction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ViewInteraction

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    ViewInteraction

    +

    + + public + + final + + class + ViewInteraction + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.ViewInteraction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.ViewInteraction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Provides the primary interface for test authors to perform actions or asserts on views. +

    Provides the primary interface for test authors to perform actions or asserts on views.

    Each interaction is associated with a view identified by a view matcher. All view actions and asserts are performed on the UI thread (thus ensuring sequential execution). The same goes for @@ -711,27 +269,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -760,102 +300,119 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -1199,16 +831,6 @@ From interface
    Public Methods
    - - - - - - ViewInteraction - - check(ViewAssertion viewAssert) - -
    - Checks the given ViewAssertion on the the view selected by the current view matcher. - - - -
    - -
    - - - - - - ViewInteraction - - inRoot(Matcher<Root> rootMatcher) - -
    - Makes this ViewInteraction scoped to the root selected by the given root matcher. - - - -
    - -
    - - - - - - ViewInteraction - - perform(ViewAction... viewActions) - -
    - Performs the given action(s) on the view selected by the current view matcher. - - - -
    - -
    - - - - - - ViewInteraction - - withFailureHandler(FailureHandler failureHandler) - -
    - Replaces the default failure handler (@see Espresso.setFailureHandler) with a custom + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + +

    + + + +

    Public methods

    + + + + + + ViewInteraction + + + check(ViewAssertion viewAssert) + + +

    Checks the given ViewAssertion on the the view selected by the current view matcher. + + +

    + +
    + + + + + + ViewInteraction + + + inRoot(Matcher<Root> rootMatcher) + + +

    Makes this ViewInteraction scoped to the root selected by the given root matcher. + + +

    + +
    + + + + + + ViewInteraction + + + perform(ViewAction... viewActions) + + +

    Performs the given action(s) on the view selected by the current view matcher. + + +

    + +
    + + + + + + ViewInteraction + + + withFailureHandler(FailureHandler failureHandler) + + +

    Replaces the default failure handler (@see Espresso.setFailureHandler) with a custom failurehandler for this particular interaction. - - - - - -

    @@ -867,207 +424,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1076,16 +702,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1111,181 +727,162 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - ViewInteraction - - check - (ViewAssertion viewAssert) -

    -
    -
    - - - -
    -
    - - - - -

    Checks the given ViewAssertion on the the view selected by the current view matcher.

    -
    -
    Parameters
    - - - - -
    viewAssert - the assertion to check.
    -
    -
    -
    Returns
    -
    • this interaction for further perform/verification calls. -
    -
    +
    +

    check

    +
    +
    + +
    +
    +ViewInteraction check (ViewAssertion viewAssert)
    + + + + +

    Checks the given ViewAssertion on the the view selected by the current view matcher.

    + + + + + + +
    Parameters
    viewAssert + ViewAssertion: + the assertion to check.
    + + + + + + +
    Returns
    ViewInteractionthis interaction for further perform/verification calls. +
    +
    -
    -

    - - public - - - - - ViewInteraction - - inRoot - (Matcher<Root> rootMatcher) -

    -
    -
    - - - -
    -
    - - +
    +

    inRoot

    +
    +
    + + +
    +
    +ViewInteraction inRoot (Matcher<Root> rootMatcher)
    + + -

    Makes this ViewInteraction scoped to the root selected by the given root matcher. -

    + +

    Makes this ViewInteraction scoped to the root selected by the given root matcher. +

    + + + + + + +
    Parameters
    rootMatcher + Matcher +
    + + + + + + +
    Returns
    ViewInteraction
    -
    -
    -

    - - public - - - - - ViewInteraction - - perform - (ViewAction... viewActions) -

    -
    -
    - - - -
    -
    - - +
    +

    perform

    +
    +
    + + +
    +
    +ViewInteraction perform (ViewAction... viewActions)
    + + -

    Performs the given action(s) on the view selected by the current view matcher. If more than one + +

    Performs the given action(s) on the view selected by the current view matcher. If more than one action is provided, actions are executed in the order provided with precondition checks running - prior to each action.

    -
    -
    Parameters
    - - - - -
    viewActions - one or more actions to execute.
    -
    -
    -
    Returns
    -
    • this interaction for further perform/verification calls. -
    -
    + prior to each action.

    + + + + + + +
    Parameters
    viewActions + ViewAction: + one or more actions to execute.
    + + + + + + +
    Returns
    ViewInteractionthis interaction for further perform/verification calls. +
    -
    -
    -

    - - public - - - - - ViewInteraction - - withFailureHandler - (FailureHandler failureHandler) -

    -
    -
    - - - -
    -
    - - - - -

    Replaces the default failure handler (@see Espresso.setFailureHandler) with a custom - failurehandler for this particular interaction.

    -
    -
    Parameters
    - - - - -
    failureHandler - a non-null failurehandler to use to report failures.
    -
    -
    -
    Returns
    -
    • this interaction for further perform/verification calls. -
    -
    +
    +

    withFailureHandler

    +
    +
    + +
    +
    +ViewInteraction withFailureHandler (FailureHandler failureHandler)
    + + + + +

    Replaces the default failure handler (@see Espresso.setFailureHandler) with a custom + failurehandler for this particular interaction.

    + + + + + + +
    Parameters
    failureHandler + FailureHandler: + a non-null failurehandler to use to report failures.
    + + + + + + +
    Returns
    ViewInteractionthis interaction for further perform/verification calls. +
    +
    @@ -1297,193 +894,64 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/ViewInteractionComponent.html b/docs/html/reference/android/support/test/espresso/ViewInteractionComponent.html index e47a2c7323d0..8e8f9f9b0f23 100644 --- a/docs/html/reference/android/support/test/espresso/ViewInteractionComponent.html +++ b/docs/html/reference/android/support/test/espresso/ViewInteractionComponent.html @@ -1,4 +1,3 @@ - @@ -93,598 +92,136 @@ - - - - - - -ViewInteractionComponent | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    + + + + -
    + + + + + + - -
    + + + -
    -
    +ViewInteractionComponent - - -
    - public + + + - interface -

    ViewInteractionComponent

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    ViewInteractionComponent

    +

    + + public + + + + interface + ViewInteractionComponent + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.espresso.ViewInteractionComponent
    android.support.test.espresso.ViewInteractionComponent +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Dagger component for view interaction classes. +

    Dagger component for view interaction classes.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -713,25 +250,32 @@ type="text/css"> - +
    Public Methods
    + - - - - - + + + + + + + + +

    Public methods

    - abstract - - - - - ViewInteraction - - viewInteraction() - -
    + abstract + + + + + ViewInteraction + + + viewInteraction() + + +
    @@ -742,16 +286,6 @@ type="text/css"> -
    - - - - - - - - - @@ -777,39 +311,35 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - ViewInteraction - - viewInteraction - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    viewInteraction

    +
    +
    + +
    +
    +ViewInteraction viewInteraction ()
    + + + + +

    + + + + + + +
    Returns
    ViewInteraction
    +
    @@ -821,193 +351,64 @@ type="text/css"> - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/AdapterDataLoaderAction.html b/docs/html/reference/android/support/test/espresso/action/AdapterDataLoaderAction.html index 87d083316042..cbae682955ec 100644 --- a/docs/html/reference/android/support/test/espresso/action/AdapterDataLoaderAction.html +++ b/docs/html/reference/android/support/test/espresso/action/AdapterDataLoaderAction.html @@ -1,4 +1,3 @@ - @@ -93,525 +92,92 @@ - - - - - - -AdapterDataLoaderAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +AdapterDataLoaderAction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    AdapterDataLoaderAction

    - - - - - extends Object
    - - - - - - +

    AdapterDataLoaderAction

    +

    + + public + + final + + class + AdapterDataLoaderAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.AdapterDataLoaderAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.AdapterDataLoaderAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Forces an AdapterView to ensure that the data matching a provided data matcher +

    Forces an AdapterView to ensure that the data matching a provided data matcher is loaded into the current view hierarchy.

    @@ -724,27 +281,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -769,25 +308,23 @@ Summary: - - - - - - - @@ -1201,16 +842,6 @@ From interface
    Public Constructors
    + + - - - - - - + + + + + + +

    Public constructors

    - AdapterDataLoaderAction(Matcher<? extends Object> dataToLoadMatcher, Optional<Integer> atPosition, AdapterViewProtocol adapterViewProtocol) - -
    + + AdapterDataLoaderAction(Matcher<? extends Object> dataToLoadMatcher, Optional<Integer> atPosition, AdapterViewProtocol adapterViewProtocol) + + +
    @@ -798,94 +335,113 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - AdapterViewProtocol.AdaptedData - - getAdaptedData() - -
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + AdapterViewProtocol.AdaptedData + + + getAdaptedData() + + +
    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -897,207 +453,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1105,94 +730,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1228,39 +859,51 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - AdapterDataLoaderAction - (Matcher<? extends Object> dataToLoadMatcher, Optional<Integer> atPosition, AdapterViewProtocol adapterViewProtocol) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    AdapterDataLoaderAction

    +
    +
    + +
    +
    +AdapterDataLoaderAction (Matcher<? extends Object> dataToLoadMatcher, 
    +                Optional<Integer> atPosition, 
    +                AdapterViewProtocol adapterViewProtocol)
    + + + + +

    + + + + + + + + + + + + + + +
    Parameters
    dataToLoadMatcher + Matcher +
    atPosition + Optional +
    adapterViewProtocol + AdapterViewProtocol +
    +
    @@ -1275,161 +918,137 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - AdapterViewProtocol.AdaptedData - - getAdaptedData - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getAdaptedData

    +
    +
    + +
    +
    +AdapterViewProtocol.AdaptedData getAdaptedData ()
    + + + + +

    + + + + + + +
    Returns
    AdapterViewProtocol.AdaptedData
    +
    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - void - - perform - (UiController uiController, View view) -

    -
    -
    - - - -
    -
    +
    +

    perform

    +
    +
    + + - - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1441,193 +1060,65 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.Builder.html b/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.Builder.html index 525d869b59d5..a12916bd150f 100644 --- a/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.Builder.html +++ b/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.Builder.html @@ -1,4 +1,3 @@ - @@ -93,518 +92,85 @@ - - - - - - -AdapterViewProtocol.AdaptedData.Builder | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +AdapterViewProtocol.AdaptedData.Builder - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - class -

    AdapterViewProtocol.AdaptedData.Builder

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    AdapterViewProtocol.AdaptedData.Builder

    +

    + + public + static + + + class + AdapterViewProtocol.AdaptedData.Builder + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.AdapterViewProtocol.AdaptedData.Builder
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.AdapterViewProtocol.AdaptedData.Builder +
    + + +

    -
    - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -751,25 +291,23 @@ Summary: - - - - +
    Public Constructors
    + - - - - + + + + + + +

    Public constructors

    - - - - - - AdapterViewProtocol.AdaptedData.Builder() - -
    + + AdapterViewProtocol.AdaptedData.Builder() + + +
    @@ -780,73 +318,98 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - AdapterViewProtocol.AdaptedData - - build() - -
    - - - - - - AdapterViewProtocol.AdaptedData.Builder - - withData(Object data) - -
    - - - - - - AdapterViewProtocol.AdaptedData.Builder - - withDataFunction(AdapterViewProtocol.DataFunction dataFunction) - -
    - - - - - - AdapterViewProtocol.AdaptedData.Builder - - withOpaqueToken(Object opaqueToken) - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + AdapterViewProtocol.AdaptedData + + + build() + + +
    + + + + + + AdapterViewProtocol.AdaptedData.Builder + + + withData(Object data) + + +
    + + + + + + AdapterViewProtocol.AdaptedData.Builder + + + withDataFunction(AdapterViewProtocol.DataFunction dataFunction) + + +
    + + + + + + AdapterViewProtocol.AdaptedData.Builder + + + withOpaqueToken(Object opaqueToken) + + +
    @@ -858,207 +421,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1067,16 +699,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1094,39 +716,28 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - AdapterViewProtocol.AdaptedData.Builder - () -

    -
    -
    - - - -
    -
    - - +
    +

    AdapterViewProtocol.AdaptedData.Builder

    +
    +
    + + +
    +
    +AdapterViewProtocol.AdaptedData.Builder ()
    + + -

    + +

    -
    @@ -1141,135 +752,146 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - AdapterViewProtocol.AdaptedData - - build - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    build

    +
    +
    + +
    +
    +AdapterViewProtocol.AdaptedData build ()
    + + + + +

    + + + + + + +
    Returns
    AdapterViewProtocol.AdaptedData
    +
    -
    -

    - - public - - - - - AdapterViewProtocol.AdaptedData.Builder - - withData - (Object data) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withData

    +
    +
    + +
    +
    +AdapterViewProtocol.AdaptedData.Builder withData (Object data)
    + + + + +

    + + + + + + +
    Parameters
    data + Object +
    + + + + + + +
    Returns
    AdapterViewProtocol.AdaptedData.Builder
    +
    -
    -

    - - public - - - - - AdapterViewProtocol.AdaptedData.Builder - - withDataFunction - (AdapterViewProtocol.DataFunction dataFunction) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withDataFunction

    +
    +
    + +
    +
    +AdapterViewProtocol.AdaptedData.Builder withDataFunction (AdapterViewProtocol.DataFunction dataFunction)
    + + + + +

    + + + + + + +
    Parameters
    dataFunction + AdapterViewProtocol.DataFunction +
    + + + + + + +
    Returns
    AdapterViewProtocol.AdaptedData.Builder
    +
    -
    -

    - - public - - - - - AdapterViewProtocol.AdaptedData.Builder - - withOpaqueToken - (Object opaqueToken) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withOpaqueToken

    +
    +
    + +
    +
    +AdapterViewProtocol.AdaptedData.Builder withOpaqueToken (Object opaqueToken)
    + + + + +

    + + + + + + +
    Parameters
    opaqueToken + Object +
    + + + + + + +
    Returns
    AdapterViewProtocol.AdaptedData.Builder
    +
    @@ -1281,193 +903,65 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.html b/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.html index a83e5246b7ec..e271f96f78e2 100644 --- a/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.html +++ b/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.html @@ -1,4 +1,3 @@ - @@ -93,518 +92,85 @@ - - - - - - -AdapterViewProtocol.AdaptedData | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +AdapterViewProtocol.AdaptedData - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - class -

    AdapterViewProtocol.AdaptedData

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    AdapterViewProtocol.AdaptedData

    +

    + + public + static + + + class + AdapterViewProtocol.AdaptedData + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.AdapterViewProtocol.AdaptedData
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.AdapterViewProtocol.AdaptedData +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A holder that associates a data object from an AdapterView with a token the +

    A holder that associates a data object from an AdapterView with a token the AdapterViewProtocol can use to force that data object to be rendered as a child or deeper descendant of the adapter view.

    @@ -715,52 +272,35 @@ Summary: -
    - - - - - - - - - - - - - - - -
    - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - classAdapterViewProtocol.AdaptedData.Builder
    + + + + + + - - + + @@ -780,45 +320,46 @@ Summary: -

    Nested classes

    + + + + + class -   - - - + AdapterViewProtocol.AdaptedData.Builder +

      + + +

    +
    Fields
    + - - - - + + + + - - - - - - - - - - + + - - + + +

    + + +

    Fields

    - public - - final - Objectdata - +
    + public + + final + Object + data +

    This field is deprecated. - use getData() instead. + use getData() instead. + + +

    +
    - public - - final - ObjectopaqueToken - A token the implementor of AdapterViewProtocol can use to force the adapterView to display +
    + public + + final + Object + opaqueToken +

    A token the implementor of AdapterViewProtocol can use to force the adapterView to display this data object as a child or deeper descendant in it. - - - -

    @@ -834,41 +375,54 @@ Summary: - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Object - - getData() - -
    - - - - - - String - - toString() - -
    + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Object + + + getData() + + +
    + + + + + + String + + + toString() + + +
    @@ -880,207 +434,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1089,16 +712,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1113,77 +726,61 @@ From class -

    Fields

    +

    Fields

    -
    -

    - - public - - final - Object - - data -

    -
    - - - - -
    -
    - +
    +

    data

    +
    + + + +
    +
    +Object data
    + + -

    +

    This field is deprecated.
    - use getData() instead. + use getData() instead.

    -

    One of the objects the AdapterView is exposing to the user.

    - +

    One of the objects the AdapterView is exposing to the user.

    -
    +
    -
    -

    - - public - - final - Object - - opaqueToken -

    -
    - - - - -
    -
    - - +
    +

    opaqueToken

    +
    + + + +
    +
    +Object opaqueToken
    + + -

    A token the implementor of AdapterViewProtocol can use to force the adapterView to display + +

    A token the implementor of AdapterViewProtocol can use to force the adapterView to display this data object as a child or deeper descendant in it. Equal opaqueToken point to the same data object on the AdapterView. -

    - +

    -
    +
    @@ -1201,71 +798,63 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Object - - getData - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getData

    +
    +
    + +
    +
    +Object getData ()
    + + + + +

    + + + + + + +
    Returns
    Object
    +
    -
    -

    - - public - - - - - String - - toString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toString

    +
    +
    + +
    +
    +String toString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    @@ -1277,193 +866,65 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.DataFunction.html b/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.DataFunction.html index 01cd848b4309..be2729968a6c 100644 --- a/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.DataFunction.html +++ b/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.DataFunction.html @@ -1,4 +1,3 @@ - @@ -93,509 +92,76 @@ - - - - - - -AdapterViewProtocol.DataFunction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +AdapterViewProtocol.DataFunction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -603,93 +169,63 @@ type="text/css"> -
    - - - - -
    +
    -
    - public - static - - - interface -

    AdapterViewProtocol.DataFunction

    - +

    AdapterViewProtocol.DataFunction

    +

    + + public + static + + + interface + AdapterViewProtocol.DataFunction + +
    + + + + + +

    - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.action.AdapterViewProtocol.DataFunction
    android.support.test.espresso.action.AdapterViewProtocol.DataFunction +
    + + +

    +

    A custom function that is applied when getData() is executed.

    -
    - - -

    Class Overview

    -

    A custom function that is applied when getData() is executed.

    - - - - - - - - - - - - - - - - - - - -
    - -

    Summary

    +

    Summary

    @@ -718,25 +254,32 @@ type="text/css"> - - - - - - - @@ -1183,16 +818,6 @@ From interface
    Public Methods
    - abstract - - - + + - Object - - + + + + + + + + +

    Public methods

    - getData() -
    + abstract + + + + + Object + + + getData() + + +
    @@ -747,16 +290,6 @@ type="text/css"> - - - - - - - - - - @@ -782,39 +315,35 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - Object - - getData - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getData

    +
    +
    + +
    +
    +Object getData ()
    + + + + +

    + + + + + + +
    Returns
    Object
    +
    @@ -826,193 +355,65 @@ type="text/css"> - -
    - -
    - -
    - - -
    - - - + + diff --git a/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.html b/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.html index 29f924d6f123..de735ac4a738 100644 --- a/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.html +++ b/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocol.html @@ -1,4 +1,3 @@ - @@ -93,572 +92,127 @@ - - - - - - -AdapterViewProtocol | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    + + + -
    + + + + - -
    + +AdapterViewProtocol -
    -
    - - - - -
    - public + + + - interface -

    AdapterViewProtocol

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    AdapterViewProtocol

    +

    + + public + + + + interface + AdapterViewProtocol + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.espresso.action.AdapterViewProtocol
    android.support.test.espresso.action.AdapterViewProtocol +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A sadly necessary layer of indirection to interact with AdapterViews. +

    A sadly necessary layer of indirection to interact with AdapterViews.

    Generally any subclass should respect the contracts and behaviors of its superclass. Otherwise it becomes impossible to work generically with objects that all claim to share a supertype - you @@ -689,71 +243,54 @@ type="text/css"> -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - classAdapterViewProtocol.AdaptedData
    + + + + + + - - - - - + + + + - - + + @@ -782,102 +319,119 @@ type="text/css"> -

    Nested classes

    + + + + + class - A holder that associates a data object from an AdapterView with a token the + AdapterViewProtocol.AdaptedData +

    A holder that associates a data object from an AdapterView with a token the AdapterViewProtocol can use to force that data object to be rendered as a child or deeper descendant of the adapter view.  - - - + + +

    - - - - - interfaceAdapterViewProtocol.DataFunction
    + + + + + interface - A custom function that is applied when getData() is executed.  - - - + AdapterViewProtocol.DataFunction +

    A custom function that is applied when getData() is executed.  + + +

    - - - - - - - - - - - - - @@ -1183,16 +818,6 @@ From interface
    Public Methods
    - abstract - - - - - Iterable<AdapterViewProtocol.AdaptedData> - - getDataInAdapterView(AdapterView<? extends Adapter> adapterView) - -
    - Returns all data this AdapterViewProtocol can find within the given AdapterView. - - - -
    - -
    - abstract - - - - - Optional<AdapterViewProtocol.AdaptedData> - - getDataRenderedByView(AdapterView<? extends Adapter> adapterView, View descendantView) - -
    - Returns the data object this particular view is rendering if possible. - + + - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - + + +

    + + + + + + + + + + + + + +

    Public methods

    - abstract - - - - - boolean - - isDataRenderedWithinAdapterView(AdapterView<? extends Adapter> adapterView, AdapterViewProtocol.AdaptedData adaptedData) - -
    - Indicates whether or not there now exists a descendant view within adapterView that + +
    + abstract + + + + + Iterable<AdapterViewProtocol.AdaptedData> + + + getDataInAdapterView(AdapterView<? extends Adapter> adapterView) + + +

    Returns all data this AdapterViewProtocol can find within the given AdapterView. + + +

    + +
    + abstract + + + + + Optional<AdapterViewProtocol.AdaptedData> + + + getDataRenderedByView(AdapterView<? extends Adapter> adapterView, View descendantView) + + +

    Returns the data object this particular view is rendering if possible. + + +

    + +
    + abstract + + + + + boolean + + + isDataRenderedWithinAdapterView(AdapterView<? extends Adapter> adapterView, AdapterViewProtocol.AdaptedData adaptedData) + + +

    Indicates whether or not there now exists a descendant view within adapterView that is rendering this data. - - - - - -

    - abstract - - - - - void - - makeDataRenderedWithinAdapterView(AdapterView<? extends Adapter> adapterView, AdapterViewProtocol.AdaptedData data) - -
    - Requests that a particular piece of data held in this AdapterView is actually rendered by it. - - - -
    - -
    + abstract + + + + + void + + + makeDataRenderedWithinAdapterView(AdapterView<? extends Adapter> adapterView, AdapterViewProtocol.AdaptedData data) + + +

    Requests that a particular piece of data held in this AdapterView is actually rendered by it. + + +

    + +
    @@ -888,16 +442,6 @@ type="text/css"> -
    - - - - - - - - - @@ -923,99 +467,81 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - Iterable<AdapterViewProtocol.AdaptedData> - - getDataInAdapterView - (AdapterView<? extends Adapter> adapterView) -

    -
    -
    - - - -
    -
    - - +
    +

    getDataInAdapterView

    +
    +
    + + +
    +
    +Iterable<AdapterViewProtocol.AdaptedData> getDataInAdapterView (AdapterView<? extends Adapter> adapterView)
    + + -

    Returns all data this AdapterViewProtocol can find within the given AdapterView. + +

    Returns all data this AdapterViewProtocol can find within the given AdapterView.

    Any AdaptedData returned by this method can be passed to makeDataRenderedWithinView and the implementation should make the AdapterView bring that data item onto the screen. -

    -
    -
    Parameters
    - - - - -
    adapterView - the AdapterView we want to interrogate the contents of.
    -
    -
    -
    Returns
    -
    • an Iterable of AdaptedDatas representing all data the implementation sees in - this view
    -
    -
    -
    Throws
    - +

    +
    + + + + + +
    Parameters
    adapterView + AdapterView: + the AdapterView we want to interrogate the contents of.
    + + + + + + +
    Returns
    Iterable<AdapterViewProtocol.AdaptedData>an Iterable of AdaptedDatas representing all data the implementation sees in + this view
    + + - +
    Throws
    IllegalArgumentException - if the implementation doesn't know how to manipulate the given + IllegalArgumentExceptionif the implementation doesn't know how to manipulate the given adapter view.
    -
    + -
    -
    -

    - - public - - - abstract - - Optional<AdapterViewProtocol.AdaptedData> - - getDataRenderedByView - (AdapterView<? extends Adapter> adapterView, View descendantView) -

    -
    -
    - - - -
    -
    - - +
    +

    getDataRenderedByView

    +
    +
    + + +
    +
    +Optional<AdapterViewProtocol.AdaptedData> getDataRenderedByView (AdapterView<? extends Adapter> adapterView, 
    +                View descendantView)
    + + -

    Returns the data object this particular view is rendering if possible. + +

    Returns the data object this particular view is rendering if possible.

    Implementations are expected to create a relationship between the data in the AdapterView and @@ -1040,117 +566,106 @@ type="text/css"> It would be expected that getDataRenderedByView(adapter, LinearLayout) would return the PersonObject. If it were called instead with the TextView or ImageView it would return Object.absent(). -

    -
    -
    Parameters
    - - - - - - - -
    adapterView - the adapterview hosting the data.
    descendantView - a view which is a child, grand-child, or deeper descendant of adapterView
    -
    -
    -
    Returns
    -
    • an optional data object the descendant view is rendering.
    -
    -
    -
    Throws
    - +

    +
    + + + + + + + + + +
    Parameters
    adapterView + AdapterView: + the adapterview hosting the data.
    descendantView + View: + a view which is a child, grand-child, or deeper descendant of adapterView
    + + + + + + +
    Returns
    Optional<AdapterViewProtocol.AdaptedData>an optional data object the descendant view is rendering.
    + + - +
    Throws
    IllegalArgumentException - if this protocol cannot interrogate this class of adapterView + IllegalArgumentExceptionif this protocol cannot interrogate this class of adapterView
    -
    + -
    -
    -

    - - public - - - abstract - - boolean - - isDataRenderedWithinAdapterView - (AdapterView<? extends Adapter> adapterView, AdapterViewProtocol.AdaptedData adaptedData) -

    -
    -
    - - - -
    -
    - - - - -

    Indicates whether or not there now exists a descendant view within adapterView that - is rendering this data.

    -
    -
    Parameters
    - - - - - - - -
    adapterView - the AdapterView hosting this data.
    adaptedData - the data we are checking the display state for.
    -
    -
    -
    Returns
    -
    • true if the data is rendered by a view in the adapterView, false otherwise. -
    -
    +
    +

    isDataRenderedWithinAdapterView

    +
    +
    + +
    +
    +boolean isDataRenderedWithinAdapterView (AdapterView<? extends Adapter> adapterView, 
    +                AdapterViewProtocol.AdaptedData adaptedData)
    + + + + +

    Indicates whether or not there now exists a descendant view within adapterView that + is rendering this data.

    + + + + + + + + + + +
    Parameters
    adapterView + AdapterView: + the AdapterView hosting this data.
    adaptedData + AdapterViewProtocol.AdaptedData: + the data we are checking the display state for.
    + + + + + + +
    Returns
    booleantrue if the data is rendered by a view in the adapterView, false otherwise. +
    +
    -
    -

    - - public - - - abstract - - void - - makeDataRenderedWithinAdapterView - (AdapterView<? extends Adapter> adapterView, AdapterViewProtocol.AdaptedData data) -

    -
    -
    - - - -
    -
    - - +
    +

    makeDataRenderedWithinAdapterView

    +
    +
    + + +
    +
    +void makeDataRenderedWithinAdapterView (AdapterView<? extends Adapter> adapterView, 
    +                AdapterViewProtocol.AdaptedData data)
    + + -

    Requests that a particular piece of data held in this AdapterView is actually rendered by it. + +

    Requests that a particular piece of data held in this AdapterView is actually rendered by it.

    After calling this method it expected that there will exist some descendant view of adapterView @@ -1163,33 +678,33 @@ type="text/css"> the list to the given position. The animation may be in progress after this call returns. The only guarantee is that eventually - with no further interaction necessary - this data item will be rendered as a child or deeper descendant of this AdapterView. -

    -
    -
    Parameters
    - +

    +
    + + + + + + + + + +
    Parameters
    adapterView + AdapterView: + the adapterView hosting the data.
    data + AdapterViewProtocol.AdaptedData: + an AdaptedData instance retrieved by a prior call to getDataInAdapterView
    + + - - - - - -
    Throws
    adapterView - the adapterView hosting the data.
    data - an AdaptedData instance retrieved by a prior call to getDataInAdapterView
    -
    -
    -
    Throws
    - - - +
    IllegalArgumentException - if this protocol cannot manipulate adapterView or if data is + IllegalArgumentExceptionif this protocol cannot manipulate adapterView or if data is not owned by this AdapterViewProtocol.
    -
    + -
    @@ -1201,193 +716,65 @@ type="text/css"> - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocols.html b/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocols.html index 8abdd3ea14bd..157dba9d4bec 100644 --- a/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocols.html +++ b/docs/html/reference/android/support/test/espresso/action/AdapterViewProtocols.html @@ -1,4 +1,3 @@ - @@ -93,518 +92,85 @@ - - - - - - -AdapterViewProtocols | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +AdapterViewProtocols - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    AdapterViewProtocols

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    AdapterViewProtocols

    +

    + + public + + final + + class + AdapterViewProtocols + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.AdapterViewProtocols
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.AdapterViewProtocols +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Implementations of AdapterViewProtocol for standard SDK Widgets. +

    Implementations of AdapterViewProtocol for standard SDK Widgets.

    @@ -708,27 +265,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -757,33 +296,38 @@ Summary: - - - - +
    Public Methods
    + - - - + + + + + - + + +

    + + + +

    Public methods

    - - static - - AdapterViewProtocol - - standardProtocol() - -
    - Creates an implementation of AdapterViewProtocol that can work with AdapterViews that do not + +
    + + + static + + + AdapterViewProtocol + + + standardProtocol() + + +

    Creates an implementation of AdapterViewProtocol that can work with AdapterViews that do not break method contracts on AdapterView. - - - - - -

    @@ -795,207 +339,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1004,16 +617,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1039,42 +642,38 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - AdapterViewProtocol - - standardProtocol - () -

    -
    -
    - - - -
    -
    - - +
    +

    standardProtocol

    +
    +
    + + +
    +
    +AdapterViewProtocol standardProtocol ()
    + + -

    Creates an implementation of AdapterViewProtocol that can work with AdapterViews that do not + +

    Creates an implementation of AdapterViewProtocol that can work with AdapterViews that do not break method contracts on AdapterView. -

    +

    + + + + + + +
    Returns
    AdapterViewProtocol
    -
    @@ -1086,193 +685,65 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/CloseKeyboardAction.html b/docs/html/reference/android/support/test/espresso/action/CloseKeyboardAction.html index 0cb2a96078f2..bb71d018bedc 100644 --- a/docs/html/reference/android/support/test/espresso/action/CloseKeyboardAction.html +++ b/docs/html/reference/android/support/test/espresso/action/CloseKeyboardAction.html @@ -1,4 +1,3 @@ - @@ -93,525 +92,92 @@ - - - - - - -CloseKeyboardAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +CloseKeyboardAction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    CloseKeyboardAction

    - - - - - extends Object
    - - - - - - +

    CloseKeyboardAction

    +

    + + public + + final + + class + CloseKeyboardAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.CloseKeyboardAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.CloseKeyboardAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Closes soft keyboard. +

    Closes soft keyboard.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -767,25 +306,23 @@ Summary: - - - - +
    Public Constructors
    + - - - - + + + + + + +

    Public constructors

    - - - - - - CloseKeyboardAction() - -
    + + CloseKeyboardAction() + + +
    @@ -796,78 +333,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -879,207 +429,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1087,94 +706,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1210,39 +835,28 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - CloseKeyboardAction - () -

    -
    -
    - - - -
    -
    - - +
    +

    CloseKeyboardAction

    +
    +
    + + +
    +
    +CloseKeyboardAction ()
    + + -

    + +

    -
    @@ -1257,129 +871,109 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - void - - perform - (UiController uiController, View view) -

    -
    -
    - - - -
    -
    - +
    +

    perform

    +
    +
    + + - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1391,193 +985,65 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/CoordinatesProvider.html b/docs/html/reference/android/support/test/espresso/action/CoordinatesProvider.html index 43c1c07baa4c..edfda31674c7 100644 --- a/docs/html/reference/android/support/test/espresso/action/CoordinatesProvider.html +++ b/docs/html/reference/android/support/test/espresso/action/CoordinatesProvider.html @@ -1,4 +1,3 @@ - @@ -93,509 +92,76 @@ - - - - - - -CoordinatesProvider | Android Developers - - - - - - - - - - - - - - - - - - - -
    - + - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -615,137 +181,106 @@ Summary: Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public +

    CoordinatesProvider

    +

    + + public + + + + interface + CoordinatesProvider + +
    + + + + + - interface -

    CoordinatesProvider

    +

    - - - - - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.action.CoordinatesProvider
    android.support.test.espresso.action.CoordinatesProvider +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Interface to implement calculation of Coordinates. +

    Interface to implement calculation of Coordinates.

    -
    - - - - - - - - - - - - - - - - -
    -

    Summary

    +

    Summary

    @@ -774,32 +309,37 @@ Summary: - +
    Public Methods
    + - - - - - + + + + + + + + +

    Public methods

    - abstract - - - - - float[] - - calculateCoordinates(View view) - -
    - Calculates coordinates of given view. - - - -
    - -
    + abstract + + + + + float[] + + + calculateCoordinates(View view) + + +

    Calculates coordinates of given view. + + +

    + +
    @@ -810,16 +350,6 @@ Summary: -
    - - - - - - - - - @@ -845,53 +375,45 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - float[] - - calculateCoordinates - (View view) -

    -
    -
    - - - -
    -
    - - - - -

    Calculates coordinates of given view.

    -
    -
    Parameters
    - - - - -
    view - the View which is used for the calculation.
    -
    -
    -
    Returns
    -
    • a float[] with x and y values of the calculated coordinates. -
    -
    +
    +

    calculateCoordinates

    +
    +
    + +
    +
    +float[] calculateCoordinates (View view)
    + + + + +

    Calculates coordinates of given view.

    + + + + + + +
    Parameters
    view + View: + the View which is used for the calculation.
    + + + + + + +
    Returns
    float[]a float[] with x and y values of the calculated coordinates. +
    +
    @@ -903,193 +425,65 @@ Summary: - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/EditorAction.html b/docs/html/reference/android/support/test/espresso/action/EditorAction.html index 3d5f2126a615..2b419266bc46 100644 --- a/docs/html/reference/android/support/test/espresso/action/EditorAction.html +++ b/docs/html/reference/android/support/test/espresso/action/EditorAction.html @@ -1,4 +1,3 @@ - @@ -93,525 +92,92 @@ - - - - - - -EditorAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +EditorAction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    EditorAction

    - - - - - extends Object
    - - - - - - +

    EditorAction

    +

    + + public + + final + + class + EditorAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.EditorAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.EditorAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Performs whatever editor (IME) action is available on a view. +

    Performs whatever editor (IME) action is available on a view.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -767,25 +306,23 @@ Summary: - - - - +
    Public Constructors
    + - - - - + + + + + + +

    Public constructors

    - - - - - - EditorAction() - -
    + + EditorAction() + + +
    @@ -796,78 +333,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -879,207 +429,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1087,94 +706,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1210,39 +835,28 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - EditorAction - () -

    -
    -
    - - - -
    -
    - - +
    +

    EditorAction

    +
    +
    + + +
    +
    +EditorAction ()
    + + -

    + +

    -
    @@ -1257,129 +871,109 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - void - - perform - (UiController uiController, View view) -

    -
    -
    - - - -
    -
    - +
    +

    perform

    +
    +
    + + - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1391,193 +985,65 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/EspressoKey.Builder.html b/docs/html/reference/android/support/test/espresso/action/EspressoKey.Builder.html index c66f60f874aa..5bb6334407bc 100644 --- a/docs/html/reference/android/support/test/espresso/action/EspressoKey.Builder.html +++ b/docs/html/reference/android/support/test/espresso/action/EspressoKey.Builder.html @@ -1,4 +1,3 @@ - @@ -93,518 +92,85 @@ - - - - - - -EspressoKey.Builder | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +EspressoKey.Builder - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - class -

    EspressoKey.Builder

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    EspressoKey.Builder

    +

    + + public + static + + + class + EspressoKey.Builder + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.EspressoKey.Builder
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.EspressoKey.Builder +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Builder for the EspressoKey class. +

    Builder for the EspressoKey class.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -755,25 +294,23 @@ Summary: - - - - +
    Public Constructors
    + - - - - + + + + + + +

    Public constructors

    - - - - - - EspressoKey.Builder() - -
    + + EspressoKey.Builder() + + +
    @@ -784,110 +321,135 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - EspressoKey - - build() - -
    - - - - - - EspressoKey.Builder - - withAltPressed(boolean altPressed) - -
    - Sets the ALT_ON meta state of the resulting key. - - - -
    - -
    - - - - - - EspressoKey.Builder - - withCtrlPressed(boolean ctrlPressed) - -
    - On Honeycomb and above, sets the CTRL_ON meta state of the resulting key. - - - -
    - -
    - - - - - - EspressoKey.Builder - - withKeyCode(int keyCode) - -
    - - - - - - EspressoKey.Builder - - withShiftPressed(boolean shiftPressed) - -
    - Sets the SHIFT_ON meta state of the resulting key. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + EspressoKey + + + build() + + +
    + + + + + + EspressoKey.Builder + + + withAltPressed(boolean altPressed) + + +

    Sets the ALT_ON meta state of the resulting key. + + +

    + +
    + + + + + + EspressoKey.Builder + + + withCtrlPressed(boolean ctrlPressed) + + +

    On Honeycomb and above, sets the CTRL_ON meta state of the resulting key. + + +

    + +
    + + + + + + EspressoKey.Builder + + + withKeyCode(int keyCode) + + +
    + + + + + + EspressoKey.Builder + + + withShiftPressed(boolean shiftPressed) + + +

    Sets the SHIFT_ON meta state of the resulting key. + + +

    + +
    @@ -899,207 +461,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1108,16 +739,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1135,39 +756,28 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - EspressoKey.Builder - () -

    -
    -
    - - - -
    -
    - - +
    +

    EspressoKey.Builder

    +
    +
    + + +
    +
    +EspressoKey.Builder ()
    + + -

    + +

    -
    @@ -1182,171 +792,187 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - EspressoKey - - build - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    build

    +
    +
    + +
    +
    +EspressoKey build ()
    + + + + +

    + + + + + + +
    Returns
    EspressoKey
    +
    -
    -

    - - public - - - - - EspressoKey.Builder - - withAltPressed - (boolean altPressed) -

    -
    -
    - - - -
    -
    - - +
    +

    withAltPressed

    +
    +
    + + +
    +
    +EspressoKey.Builder withAltPressed (boolean altPressed)
    + + -

    Sets the ALT_ON meta state of the resulting key. -

    + +

    Sets the ALT_ON meta state of the resulting key. +

    + + + + + + +
    Parameters
    altPressed + boolean +
    + + + + + + +
    Returns
    EspressoKey.Builder
    -
    -
    -

    - - public - - - - - EspressoKey.Builder - - withCtrlPressed - (boolean ctrlPressed) -

    -
    -
    - - - -
    -
    - - +
    +

    withCtrlPressed

    +
    +
    + + +
    +
    +EspressoKey.Builder withCtrlPressed (boolean ctrlPressed)
    + + -

    On Honeycomb and above, sets the CTRL_ON meta state of the resulting key. On Gingerbread and + +

    On Honeycomb and above, sets the CTRL_ON meta state of the resulting key. On Gingerbread and below, this is a noop. -

    +

    + + + + + + +
    Parameters
    ctrlPressed + boolean +
    + + + + + + +
    Returns
    EspressoKey.Builder
    -
    -
    -

    - - public - - - - - EspressoKey.Builder - - withKeyCode - (int keyCode) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withKeyCode

    +
    +
    + +
    +
    +EspressoKey.Builder withKeyCode (int keyCode)
    + + + + +

    + + + + + + +
    Parameters
    keyCode + int +
    + + + + + + +
    Returns
    EspressoKey.Builder
    +
    -
    -

    - - public - - - - - EspressoKey.Builder - - withShiftPressed - (boolean shiftPressed) -

    -
    -
    - - - -
    -
    - - +
    +

    withShiftPressed

    +
    +
    + + +
    +
    +EspressoKey.Builder withShiftPressed (boolean shiftPressed)
    + + -

    Sets the SHIFT_ON meta state of the resulting key. -

    + +

    Sets the SHIFT_ON meta state of the resulting key. +

    + + + + + + +
    Parameters
    shiftPressed + boolean +
    + + + + + + +
    Returns
    EspressoKey.Builder
    -
    @@ -1358,193 +984,65 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/EspressoKey.html b/docs/html/reference/android/support/test/espresso/action/EspressoKey.html index bb56e78e9f7d..4dd41f5854a3 100644 --- a/docs/html/reference/android/support/test/espresso/action/EspressoKey.html +++ b/docs/html/reference/android/support/test/espresso/action/EspressoKey.html @@ -1,4 +1,3 @@ - @@ -93,518 +92,85 @@ - - - - - - -EspressoKey | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +EspressoKey - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    EspressoKey

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    EspressoKey

    +

    + + public + + final + + class + EspressoKey + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.EspressoKey
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.EspressoKey +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Class that wraps the key code and meta state of the desired key press. +

    Class that wraps the key code and meta state of the desired key press.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - classEspressoKey.Builder
    + + + + + + - - + + @@ -784,57 +324,76 @@ Summary: -

    Nested classes

    + + + + + class - Builder for the EspressoKey class.  - - - + EspressoKey.Builder +

    Builder for the EspressoKey class.  + + +

    - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - int - - getKeyCode() - -
    - - - - - - int - - getMetaState() - -
    - - - - - - String - - toString() - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + int + + + getKeyCode() + + +
    + + + + + + int + + + getMetaState() + + +
    + + + + + + String + + + toString() + + +
    @@ -846,207 +405,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1055,16 +683,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1090,103 +708,91 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - int - - getKeyCode - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getKeyCode

    +
    +
    + +
    +
    +int getKeyCode ()
    + + + + +

    + + + + + + +
    Returns
    int
    +
    -
    -

    - - public - - - - - int - - getMetaState - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getMetaState

    +
    +
    + +
    +
    +int getMetaState ()
    + + + + +

    + + + + + + +
    Returns
    int
    +
    -
    -

    - - public - - - - - String - - toString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toString

    +
    +
    + +
    +
    +String toString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    @@ -1198,193 +804,65 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/GeneralClickAction.html b/docs/html/reference/android/support/test/espresso/action/GeneralClickAction.html index 36b63e519b11..9ff34193e886 100644 --- a/docs/html/reference/android/support/test/espresso/action/GeneralClickAction.html +++ b/docs/html/reference/android/support/test/espresso/action/GeneralClickAction.html @@ -1,4 +1,3 @@ - @@ -93,525 +92,92 @@ - - - - - - -GeneralClickAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +GeneralClickAction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    GeneralClickAction

    - - - - - extends Object
    - - - - - - +

    GeneralClickAction

    +

    + + public + + final + + class + GeneralClickAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.GeneralClickAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.GeneralClickAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Enables clicking on views. +

    Enables clicking on views.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -767,41 +306,36 @@ Summary: - - - - - - - - - - - - - - - +
    Public Constructors
    - - - - - - - - GeneralClickAction(Tapper tapper, CoordinatesProvider coordinatesProvider, PrecisionDescriber precisionDescriber) - -
    - - - - - - - - GeneralClickAction(Tapper tapper, CoordinatesProvider coordinatesProvider, PrecisionDescriber precisionDescriber, ViewAction rollbackAction) - -
    + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + GeneralClickAction(Tapper tapper, CoordinatesProvider coordinatesProvider, PrecisionDescriber precisionDescriber) + + +
    + + GeneralClickAction(Tapper tapper, CoordinatesProvider coordinatesProvider, PrecisionDescriber precisionDescriber, ViewAction rollbackAction) + + +
    @@ -812,78 +346,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -895,207 +442,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1103,94 +719,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1226,71 +848,102 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - GeneralClickAction - (Tapper tapper, CoordinatesProvider coordinatesProvider, PrecisionDescriber precisionDescriber) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    GeneralClickAction

    +
    +
    + +
    +
    +GeneralClickAction (Tapper tapper, 
    +                CoordinatesProvider coordinatesProvider, 
    +                PrecisionDescriber precisionDescriber)
    + + + + +

    + + + + + + + + + + + + + + +
    Parameters
    tapper + Tapper +
    coordinatesProvider + CoordinatesProvider +
    precisionDescriber + PrecisionDescriber +
    +
    -
    -

    - - public - - - - - - - GeneralClickAction - (Tapper tapper, CoordinatesProvider coordinatesProvider, PrecisionDescriber precisionDescriber, ViewAction rollbackAction) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    GeneralClickAction

    +
    +
    + +
    +
    +GeneralClickAction (Tapper tapper, 
    +                CoordinatesProvider coordinatesProvider, 
    +                PrecisionDescriber precisionDescriber, 
    +                ViewAction rollbackAction)
    + + + + +

    + + + + + + + + + + + + + + + + + + +
    Parameters
    tapper + Tapper +
    coordinatesProvider + CoordinatesProvider +
    precisionDescriber + PrecisionDescriber +
    rollbackAction + ViewAction +
    +
    @@ -1305,129 +958,109 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - void - - perform - (UiController uiController, View view) -

    -
    -
    - - - -
    -
    +
    +

    perform

    +
    +
    + + - - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1439,193 +1072,65 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/GeneralLocation.html b/docs/html/reference/android/support/test/espresso/action/GeneralLocation.html index c62721bf6cc8..cc32c59a4db2 100644 --- a/docs/html/reference/android/support/test/espresso/action/GeneralLocation.html +++ b/docs/html/reference/android/support/test/espresso/action/GeneralLocation.html @@ -1,1488 +1,324 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -GeneralLocation | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - - - - enum -

    GeneralLocation

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - implements - - CoordinatesProvider - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.espresso.action.GeneralLocation
    - - - - - - - -
    - - -

    Class Overview

    -

    Calculates coordinate position for general locations. -

    - - - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Enum Values
    GeneralLocation BOTTOM_CENTER  -   - - - -
    GeneralLocation BOTTOM_LEFT  -   - - - -
    GeneralLocation BOTTOM_RIGHT  -   - - - -
    GeneralLocation CENTER  -   - - - -
    GeneralLocation CENTER_LEFT  -   - - - -
    GeneralLocation CENTER_RIGHT  -   - - - -
    GeneralLocation TOP_CENTER  -   - - - -
    GeneralLocation TOP_LEFT  -   - - - -
    GeneralLocation TOP_RIGHT  -   - - - -
    GeneralLocation VISIBLE_CENTER  -   - - - -
    - - - - - - - - - - - - - - - - -
    Public Methods
    - - - - static - - GeneralLocation - - valueOf(String name) - -
    - - - final - static - - GeneralLocation[] - - values() - -
    - - - - - - - - - - - - - - - - - - - - + | Methods + - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Enum - -
    - - -
    -
    - -From class - - java.lang.Object - -
    - -
    -
    - -From interface + + + + + + - android.support.test.espresso.action.CoordinatesProvider + + + + + + -
    - - -
    -
    - -From interface + | Inherited Methods - java.lang.Comparable +| [Expand All] -
    - -
    - compareTo(T arg0) +

    Calculates coordinate position for general locations. +

    -
    -
    -
    -
    -
    +

    Summary

    - @@ -1491,324 +327,1111 @@ From interface - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -

    Enum Values

    - -
    -

    - - public - static - final - GeneralLocation - - BOTTOM_CENTER -

    -
    -
    -
    -

    -
    -
    + +

    Enum values

    GeneralLocation  + BOTTOM_CENTER +

      + + +

    +
    GeneralLocation  + BOTTOM_LEFT +

      + + +

    +
    GeneralLocation  + BOTTOM_RIGHT +

      + + +

    +
    GeneralLocation  + CENTER +

      + + +

    +
    GeneralLocation  + CENTER_LEFT +

      + + +

    +
    GeneralLocation  + CENTER_RIGHT +

      + + +

    +
    GeneralLocation  + TOP_CENTER +

      + + +

    +
    GeneralLocation  + TOP_LEFT +

      + + +

    +
    GeneralLocation  + TOP_RIGHT +

      + + +

    +
    GeneralLocation  + VISIBLE_CENTER +

      + + +

    +
    + - -
    -

    - - public + +

    + + + + + + + + + + + + + + + + + - - -
    +

    Public methods

    + + + static + + + GeneralLocation + + + valueOf(String name) + + +
    + + static final - GeneralLocation - - BOTTOM_LEFT - - + + values() + + +
    -

    -
    -
    + + + - + + + + -

    + + - - -
    -

    - - public - static - final - GeneralLocation - - CENTER -

    -
    - - - - -
    -
    +
    + -

    +

    Inherited methods

    -
    -

    - - public - static + From +class + + + java.lang.Enum + + +
    + + +
    +

    - -
    + From +class + + + java.lang.Object + + +
    + + +
    +
    - + From +interface + + + java.lang.Comparable + + +
    + +
    +
    + From +interface + + + android.support.test.espresso.action.CoordinatesProvider + + +
    + + +
    +
    -
    -
    + - -
    -

    - - public - static - final - GeneralLocation - - CENTER_LEFT -

    -
    + + +

    Enum values

    -
    -
    + +
    +

    BOTTOM_CENTER

    +
    + + + -

    +
    +
    +GeneralLocation BOTTOM_CENTER
    + + + +

    -
    +
    - + -
    -

    - - public - static - final - GeneralLocation - - CENTER_RIGHT -

    -
    +
    +

    BOTTOM_LEFT

    +
    + + + +
    +
    +GeneralLocation BOTTOM_LEFT
    + + + +

    + +
    -
    -
    + +
    +

    BOTTOM_RIGHT

    +
    + + + -

    +
    +
    +GeneralLocation BOTTOM_RIGHT
    + + + +

    -
    +
    - + -
    -

    - - public - static - final - GeneralLocation - - TOP_CENTER -

    -
    +
    +

    CENTER

    +
    + + + +
    +
    +GeneralLocation CENTER
    + + + +

    + +
    -
    -
    + +
    +

    CENTER_LEFT

    +
    + + + -

    +
    +
    +GeneralLocation CENTER_LEFT
    + + + +

    -
    +
    - + -
    -

    - - public - static - final - GeneralLocation - - TOP_LEFT -

    -
    +
    +

    CENTER_RIGHT

    +
    + + + +
    +
    +GeneralLocation CENTER_RIGHT
    + + + +

    + +
    -
    -
    + +
    +

    TOP_CENTER

    +
    + + + -

    +
    +
    +GeneralLocation TOP_CENTER
    + + + +

    -
    +
    - + -
    -

    - - public - static - final - GeneralLocation - - TOP_RIGHT -

    -
    +
    +

    TOP_LEFT

    +
    + + + +
    +
    +GeneralLocation TOP_LEFT
    + + + +

    + +
    -
    -
    + +
    +

    TOP_RIGHT

    +
    + + + -

    +
    +
    +GeneralLocation TOP_RIGHT
    + + + +

    -
    +
    -
    -

    - - public - static - final - GeneralLocation - - VISIBLE_CENTER -

    -
    - - - - -
    -
    +
    +

    VISIBLE_CENTER

    +
    + + + +
    +
    +GeneralLocation VISIBLE_CENTER
    + + + +

    - -

    - - -
    +
    @@ -1832,71 +1455,72 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - GeneralLocation - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +GeneralLocation valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    GeneralLocation
    +
    -
    -

    - - public - static - final - - - GeneralLocation[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +GeneralLocation[] values ()
    + + + + +

    + + + + + + +
    Returns
    GeneralLocation[]
    +
    @@ -1908,193 +1532,65 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/GeneralSwipeAction.html b/docs/html/reference/android/support/test/espresso/action/GeneralSwipeAction.html index 85ef9f6ed1e8..fde74b02245f 100644 --- a/docs/html/reference/android/support/test/espresso/action/GeneralSwipeAction.html +++ b/docs/html/reference/android/support/test/espresso/action/GeneralSwipeAction.html @@ -1,4 +1,3 @@ - @@ -93,525 +92,92 @@ - - - - - - -GeneralSwipeAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +GeneralSwipeAction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    GeneralSwipeAction

    - - - - - extends Object
    - - - - - - +

    GeneralSwipeAction

    +

    + + public + + final + + class + GeneralSwipeAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.GeneralSwipeAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.GeneralSwipeAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Enables swiping across a view. +

    Enables swiping across a view.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -767,25 +306,23 @@ Summary: - - - - - - - @@ -1183,16 +818,6 @@ From interface
    Public Constructors
    + + - - - - - - + + + + + + +

    Public constructors

    - GeneralSwipeAction(Swiper swiper, CoordinatesProvider startCoordinatesProvider, CoordinatesProvider endCoordinatesProvider, PrecisionDescriber precisionDescriber) - -
    + + GeneralSwipeAction(Swiper swiper, CoordinatesProvider startCoordinatesProvider, CoordinatesProvider endCoordinatesProvider, PrecisionDescriber precisionDescriber) + + +
    @@ -796,78 +333,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -879,207 +429,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1087,94 +706,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1210,39 +835,58 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - GeneralSwipeAction - (Swiper swiper, CoordinatesProvider startCoordinatesProvider, CoordinatesProvider endCoordinatesProvider, PrecisionDescriber precisionDescriber) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    GeneralSwipeAction

    +
    +
    + +
    +
    +GeneralSwipeAction (Swiper swiper, 
    +                CoordinatesProvider startCoordinatesProvider, 
    +                CoordinatesProvider endCoordinatesProvider, 
    +                PrecisionDescriber precisionDescriber)
    + + + + +

    + + + + + + + + + + + + + + + + + + +
    Parameters
    swiper + Swiper +
    startCoordinatesProvider + CoordinatesProvider +
    endCoordinatesProvider + CoordinatesProvider +
    precisionDescriber + PrecisionDescriber +
    +
    @@ -1257,129 +901,109 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - void - - perform - (UiController uiController, View view) -

    -
    -
    - - - -
    -
    - +
    +

    perform

    +
    +
    + + - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1391,193 +1015,65 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/KeyEventAction.html b/docs/html/reference/android/support/test/espresso/action/KeyEventAction.html index 4a7bf4ade6dd..92c688ccccf6 100644 --- a/docs/html/reference/android/support/test/espresso/action/KeyEventAction.html +++ b/docs/html/reference/android/support/test/espresso/action/KeyEventAction.html @@ -1,4 +1,3 @@ - @@ -93,525 +92,92 @@ - - - - - - -KeyEventAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +KeyEventAction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    KeyEventAction

    - - - - - extends Object
    - - - - - - +

    KeyEventAction

    +

    + + public + + final + + class + KeyEventAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.KeyEventAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.KeyEventAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Enables pressing KeyEvents on views. +

    Enables pressing KeyEvents on views.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -760,46 +299,47 @@ Summary: - - - - - - - - - - + + - - - + +
    +

    withRowFloat

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowFloat (String columnName, 
    +                float value)
    + + + + +

    Returns a matcher that matches a Float value at a given column index + in a Cursors data row. +

    +
    Constants
    intBACK_ACTIVITY_TRANSITION_MILLIS_DELAY - - - - + + + + + + + + - - - - - - + + - - - - - - + + - - + +

    Constants

    int + BACK_ACTIVITY_TRANSITION_MILLIS_DELAY +

    + + +

    intCLEAR_TRANSITIONING_ACTIVITIES_ATTEMPTS - - - - + + +
    int + CLEAR_TRANSITIONING_ACTIVITIES_ATTEMPTS +

    + + +

    intCLEAR_TRANSITIONING_ACTIVITIES_MILLIS_DELAY - - - - + + +
    int + CLEAR_TRANSITIONING_ACTIVITIES_MILLIS_DELAY +

    + + +

    @@ -815,25 +355,23 @@ Summary: - - - - - - - @@ -1231,16 +867,6 @@ From interface
    Public Constructors
    + + - - - - - - + + + + + + +

    Public constructors

    - KeyEventAction(EspressoKey key) - -
    + + KeyEventAction(EspressoKey key) + + +
    @@ -844,78 +382,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -927,207 +478,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1135,94 +755,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    - - - - - - - - - - @@ -1252,130 +878,94 @@ From interface -

    Constants

    +

    Constants

    -
    -

    - - public - static - final - int - - BACK_ACTIVITY_TRANSITION_MILLIS_DELAY -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - 150 - (0x00000096) - - -
    +
    +

    BACK_ACTIVITY_TRANSITION_MILLIS_DELAY

    +
    + + +
    +
    +int BACK_ACTIVITY_TRANSITION_MILLIS_DELAY
    + + + + +

    + + +

    Constant Value: + + 150 + (0x00000096) + +

    -
    -

    - - public - static - final - int - - CLEAR_TRANSITIONING_ACTIVITIES_ATTEMPTS -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - 4 - (0x00000004) - - -
    +
    +

    CLEAR_TRANSITIONING_ACTIVITIES_ATTEMPTS

    +
    + + +
    +
    +int CLEAR_TRANSITIONING_ACTIVITIES_ATTEMPTS
    + + + + +

    + + +

    Constant Value: + + 4 + (0x00000004) + +

    -
    -

    - - public - static - final - int - - CLEAR_TRANSITIONING_ACTIVITIES_MILLIS_DELAY -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - 150 - (0x00000096) - - -
    +
    +

    CLEAR_TRANSITIONING_ACTIVITIES_MILLIS_DELAY

    +
    + + +
    +
    +int CLEAR_TRANSITIONING_ACTIVITIES_MILLIS_DELAY
    + + + + +

    + + +

    Constant Value: + + 150 + (0x00000096) + +

    @@ -1388,39 +978,37 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - KeyEventAction - (EspressoKey key) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    KeyEventAction

    +
    +
    + +
    +
    +KeyEventAction (EspressoKey key)
    + + + + +

    + + + + + + +
    Parameters
    key + EspressoKey +
    +
    @@ -1435,129 +1023,109 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - +
    +

    perform

    +
    +
    + + - void - - perform - (UiController uiController, View view) -

    -
    -
    - - - -
    -
    - - - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1569,193 +1137,65 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/MotionEvents.DownResultHolder.html b/docs/html/reference/android/support/test/espresso/action/MotionEvents.DownResultHolder.html index b16784562991..b9a1f1720d49 100644 --- a/docs/html/reference/android/support/test/espresso/action/MotionEvents.DownResultHolder.html +++ b/docs/html/reference/android/support/test/espresso/action/MotionEvents.DownResultHolder.html @@ -1,4 +1,3 @@ - @@ -93,518 +92,85 @@ - - - - - - -MotionEvents.DownResultHolder | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +MotionEvents.DownResultHolder - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - class -

    MotionEvents.DownResultHolder

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    MotionEvents.DownResultHolder

    +

    + + public + static + + + class + MotionEvents.DownResultHolder + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.MotionEvents.DownResultHolder
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.MotionEvents.DownResultHolder +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Holds the result of a down motion. +

    Holds the result of a down motion.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -747,41 +286,42 @@ Summary: - - +
    Fields
    + - - - - - - - - - - - - + + + + + + + + + +

    Fields

    - public - final - MotionEventdown - - - - -
    - public - - final - booleanlongPress - - - - -
    + public + + final + MotionEvent + down +

    + + +

    +
    + public + + final + boolean + longPress +

    + + +

    +
    @@ -802,207 +342,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1011,16 +620,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1035,69 +634,53 @@ From class -

    Fields

    +

    Fields

    -
    -

    - - public - - final - MotionEvent - - down -

    -
    - - - - -
    -
    - +
    +

    down

    +
    + + + +
    +
    +MotionEvent down
    + + + +

    -

    - - -
    +
    -
    -

    - - public - - final - boolean - - longPress -

    -
    - - - +
    +

    longPress

    +
    + + + -
    -
    - - - - -

    +
    +
    +boolean longPress
    + + + +

    -
    +
    @@ -1122,193 +705,65 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/MotionEvents.html b/docs/html/reference/android/support/test/espresso/action/MotionEvents.html index ac84b8b1c156..0b955ccf30b8 100644 --- a/docs/html/reference/android/support/test/espresso/action/MotionEvents.html +++ b/docs/html/reference/android/support/test/espresso/action/MotionEvents.html @@ -1,4 +1,3 @@ - @@ -93,518 +92,85 @@ - - - - - - -MotionEvents | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +MotionEvents - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    MotionEvents

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    MotionEvents

    +

    + + public + + final + + class + MotionEvents + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.MotionEvents
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.MotionEvents +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Facilitates sending of motion events to a UiController. +

    Facilitates sending of motion events to a UiController.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - classMotionEvents.DownResultHolder
    + + + + + + - - + + @@ -784,89 +324,120 @@ Summary: -

    Nested classes

    + + + + + class - Holds the result of a down motion.  - - - + MotionEvents.DownResultHolder +

    Holds the result of a down motion.  + + +

    - - - - - - - - - - - - @@ -1307,16 +1009,6 @@ From interface
    Public Methods
    - - - - static - - void - - sendCancel(UiController uiController, MotionEvent downEvent) - -
    - - + + - static - MotionEvents.DownResultHolder - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - sendDown(UiController uiController, float[] coordinates, float[] precision) - -
    - - - - static - - boolean - - sendMovement(UiController uiController, MotionEvent downEvent, float[] coordinates) - -
    - - - - static - - boolean - - sendUp(UiController uiController, MotionEvent downEvent) - -
    - - - - static - - boolean - - sendUp(UiController uiController, MotionEvent downEvent, float[] coordinates) - -
    + + + static + + + void + + + sendCancel(UiController uiController, MotionEvent downEvent) + + +
    + + + static + + + MotionEvents.DownResultHolder + + + sendDown(UiController uiController, float[] coordinates, float[] precision) + + +
    + + + static + + + boolean + + + sendMovement(UiController uiController, MotionEvent downEvent, float[] coordinates) + + +
    + + + static + + + boolean + + + sendUp(UiController uiController, MotionEvent downEvent) + + +
    + + + static + + + boolean + + + sendUp(UiController uiController, MotionEvent downEvent, float[] coordinates) + + +
    @@ -878,207 +449,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1087,16 +727,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1122,167 +752,241 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - void - - sendCancel - (UiController uiController, MotionEvent downEvent) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    sendCancel

    +
    +
    + +
    +
    +void sendCancel (UiController uiController, 
    +                MotionEvent downEvent)
    + + + + +

    + + + + + + + + + + +
    Parameters
    uiController + UiController +
    downEvent + MotionEvent +
    +
    -
    -

    - - public - static - - - - MotionEvents.DownResultHolder - - sendDown - (UiController uiController, float[] coordinates, float[] precision) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    sendDown

    +
    +
    + +
    +
    +MotionEvents.DownResultHolder sendDown (UiController uiController, 
    +                float[] coordinates, 
    +                float[] precision)
    + + + + +

    + + + + + + + + + + + + + + +
    Parameters
    uiController + UiController +
    coordinates + float +
    precision + float +
    + + + + + + +
    Returns
    MotionEvents.DownResultHolder
    +
    -
    -

    - - public - static - - - - boolean - - sendMovement - (UiController uiController, MotionEvent downEvent, float[] coordinates) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    sendMovement

    +
    +
    + +
    +
    +boolean sendMovement (UiController uiController, 
    +                MotionEvent downEvent, 
    +                float[] coordinates)
    + + + + +

    + + + + + + + + + + + + + + +
    Parameters
    uiController + UiController +
    downEvent + MotionEvent +
    coordinates + float +
    + + + + + + +
    Returns
    boolean
    +
    -
    -

    - - public - static - - - - boolean - - sendUp - (UiController uiController, MotionEvent downEvent) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    sendUp

    +
    +
    + +
    +
    +boolean sendUp (UiController uiController, 
    +                MotionEvent downEvent)
    + + + + +

    + + + + + + + + + + +
    Parameters
    uiController + UiController +
    downEvent + MotionEvent +
    + + + + + + +
    Returns
    boolean
    +
    -
    -

    - - public - static - - - - boolean - - sendUp - (UiController uiController, MotionEvent downEvent, float[] coordinates) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    sendUp

    +
    +
    + +
    +
    +boolean sendUp (UiController uiController, 
    +                MotionEvent downEvent, 
    +                float[] coordinates)
    + + + + +

    + + + + + + + + + + + + + + +
    Parameters
    uiController + UiController +
    downEvent + MotionEvent +
    coordinates + float +
    + + + + + + +
    Returns
    boolean
    +
    @@ -1294,193 +998,65 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/OpenLinkAction.html b/docs/html/reference/android/support/test/espresso/action/OpenLinkAction.html index db3af2259df6..fc8e32ebe85f 100644 --- a/docs/html/reference/android/support/test/espresso/action/OpenLinkAction.html +++ b/docs/html/reference/android/support/test/espresso/action/OpenLinkAction.html @@ -1,4 +1,3 @@ - @@ -93,525 +92,92 @@ - - - - - - -OpenLinkAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +OpenLinkAction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    OpenLinkAction

    - - - - - extends Object
    - - - - - - +

    OpenLinkAction

    +

    + + public + + final + + class + OpenLinkAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.OpenLinkAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.OpenLinkAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Invokes onClick of a link within a TextView (made with Linkify or via another method). +

    Invokes onClick of a link within a TextView (made with Linkify or via another method). Why not issue a real click event to the screen? Unfortunately, it does not seem to be possible (at least using public APIs) to determine the location of the link on the screen.

    @@ -724,27 +281,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -769,25 +308,23 @@ Summary: - - - - - - - @@ -1185,16 +820,6 @@ From interface
    Public Constructors
    + + - - - - - - + + + + + + +

    Public constructors

    - OpenLinkAction(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher) - -
    + + OpenLinkAction(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher) + + +
    @@ -798,78 +335,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -881,207 +431,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1089,94 +708,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1212,39 +837,44 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - OpenLinkAction - (Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    OpenLinkAction

    +
    +
    + +
    +
    +OpenLinkAction (Matcher<String> linkTextMatcher, 
    +                Matcher<Uri> uriMatcher)
    + + + + +

    + + + + + + + + + + +
    Parameters
    linkTextMatcher + Matcher +
    uriMatcher + Matcher +
    +
    @@ -1259,129 +889,109 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - void - - perform - (UiController uiController, View view) -

    -
    -
    - - - -
    -
    - +
    +

    perform

    +
    +
    + + - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1393,193 +1003,65 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/PrecisionDescriber.html b/docs/html/reference/android/support/test/espresso/action/PrecisionDescriber.html index a73878d1110c..964340c1cd32 100644 --- a/docs/html/reference/android/support/test/espresso/action/PrecisionDescriber.html +++ b/docs/html/reference/android/support/test/espresso/action/PrecisionDescriber.html @@ -1,4 +1,3 @@ - @@ -93,509 +92,76 @@ - - - - - - -PrecisionDescriber | Android Developers - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -615,137 +181,106 @@ Summary: Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public - - - - interface -

    PrecisionDescriber

    - - - - - - +

    PrecisionDescriber

    +

    + + public + + + + interface + PrecisionDescriber + +
    + + + + + +

    - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.action.PrecisionDescriber
    android.support.test.espresso.action.PrecisionDescriber +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Interface to implement size of click area. +

    Interface to implement size of click area.

    -
    - - - - - - - - - - - - - - - -
    - -

    Summary

    +

    Summary

    @@ -774,32 +309,37 @@ Summary: - - - - - - - - @@ -1183,16 +818,6 @@ From interface
    Public Methods
    - abstract - - - - - float[] - - describePrecision() + + -
    - Different touch target sizes. - -
    - - - + + + + + + + + +

    Public methods

    + abstract + + + + + float[] + + + describePrecision() + + +

    Different touch target sizes. + + +

    + +
    @@ -810,16 +350,6 @@ Summary: - - - - - - - - - - @@ -845,44 +375,36 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - float[] - - describePrecision - () -

    -
    -
    - - - -
    -
    - - - - -

    Different touch target sizes.

    -
    -
    Returns
    -
    • a float[] with x and y values of size of click area. -
    -
    +
    +

    describePrecision

    +
    +
    + +
    +
    +float[] describePrecision ()
    + + + + +

    Different touch target sizes.

    + + + + + + +
    Returns
    float[]a float[] with x and y values of size of click area. +
    +
    @@ -894,193 +416,65 @@ Summary: - -
    - -
    - -
    - - - -
    - - + + diff --git a/docs/html/reference/android/support/test/espresso/action/Press.html b/docs/html/reference/android/support/test/espresso/action/Press.html index f027a7bb0525..cb406717ef3a 100644 --- a/docs/html/reference/android/support/test/espresso/action/Press.html +++ b/docs/html/reference/android/support/test/espresso/action/Press.html @@ -1,770 +1,3 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Press | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - - - - enum -

    Press

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - implements - - PrecisionDescriber - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.espresso.action.Press
    - - - - - - - -
    - - -

    Class Overview

    -

    Returns different touch target sizes. -

    - - - - - -
    - - - - - - - - - @@ -772,62 +5,6 @@ Summary: -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -845,456 +22,702 @@ Summary: - -
    Enum Values
    Press FINGER  -   - - - -
    Press PINPOINT  -   - - - -
    Press THUMB  -   - - - -
    - - - - - - - - - - -
    Public Methods
    - - - - static - Press - - valueOf(String name) -
    - final - static - Press[] - - values() -
    - - - - - - - - - - - @@ -1396,16 +1109,6 @@ From interface
    - [Expand] -
    Inherited Methods
    - -From class - java.lang.Enum -
    - -
    -
    - -From class - - java.lang.Object - -
    - -
    -
    - - - - - - - - - @@ -1414,100 +1117,76 @@ From interface -

    Enum Values

    +

    Enum values

    -
    -

    - - public - static - final - Press - - FINGER -

    -
    - - +
    +

    FINGER

    +
    + + + +
    +
    +Press FINGER
    + + -
    -
    - - - - -

    - + +

    -
    +
    -
    -

    - - public - static - final - Press - - PINPOINT -

    -
    - - - - -
    -
    - - - +
    +

    PINPOINT

    +
    + + + -

    +
    +
    +Press PINPOINT
    + + + +

    -
    +
    -
    -

    - - public - static - final - Press - - THUMB -

    -
    - - - - -
    -
    +
    +

    THUMB

    +
    + + + +
    +
    +Press THUMB
    + + + +

    - -

    - - -
    +
    @@ -1531,71 +1210,72 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Press - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +Press valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    Press
    +
    -
    -

    - - public - static - final - - - Press[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +Press[] values ()
    + + + + +

    + + + + + + +
    Returns
    Press[]
    +
    @@ -1607,193 +1287,65 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/ReplaceTextAction.html b/docs/html/reference/android/support/test/espresso/action/ReplaceTextAction.html index 3f1d4e3a0d3a..9b71f632474a 100644 --- a/docs/html/reference/android/support/test/espresso/action/ReplaceTextAction.html +++ b/docs/html/reference/android/support/test/espresso/action/ReplaceTextAction.html @@ -1,4 +1,3 @@ - @@ -93,525 +92,92 @@ - - - - - - -ReplaceTextAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ReplaceTextAction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ReplaceTextAction

    - - - - - extends Object
    - - - - - - +

    ReplaceTextAction

    +

    + + public + + final + + class + ReplaceTextAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.ReplaceTextAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.ReplaceTextAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Replaces view text by setting EditTexts text property to given String. +

    Replaces view text by setting EditTexts text property to given String.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -767,25 +306,23 @@ Summary: - - - - - - - @@ -1183,16 +818,6 @@ From interface
    Public Constructors
    + + - - - - - - + + + + + + +

    Public constructors

    - ReplaceTextAction(String value) - -
    + + ReplaceTextAction(String value) + + +
    @@ -796,78 +333,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -879,207 +429,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1087,94 +706,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1210,39 +835,37 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - ReplaceTextAction - (String value) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    ReplaceTextAction

    +
    +
    + +
    +
    +ReplaceTextAction (String value)
    + + + + +

    + + + + + + +
    Parameters
    value + String +
    +
    @@ -1257,129 +880,109 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - void - - perform - (UiController uiController, View view) -

    -
    -
    - - - -
    -
    - +
    +

    perform

    +
    +
    + + - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1391,193 +994,65 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/ScrollToAction.html b/docs/html/reference/android/support/test/espresso/action/ScrollToAction.html index 63061cfdf070..bc064a2ad46e 100644 --- a/docs/html/reference/android/support/test/espresso/action/ScrollToAction.html +++ b/docs/html/reference/android/support/test/espresso/action/ScrollToAction.html @@ -1,4 +1,3 @@ - @@ -93,525 +92,92 @@ - - - - - - -ScrollToAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ScrollToAction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ScrollToAction

    - - - - - extends Object
    - - - - - - +

    ScrollToAction

    +

    + + public + + final + + class + ScrollToAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.ScrollToAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.ScrollToAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Enables scrolling to the given view. View must be a descendant of a ScrollView. +

    Enables scrolling to the given view. View must be a descendant of a ScrollView.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -767,25 +306,23 @@ Summary: - - - - +
    Public Constructors
    + - - - - + + + + + + +

    Public constructors

    - - - - - - ScrollToAction() - -
    + + ScrollToAction() + + +
    @@ -796,78 +333,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -879,207 +429,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1087,94 +706,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1210,39 +835,28 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - ScrollToAction - () -

    -
    -
    - - - -
    -
    - - +
    +

    ScrollToAction

    +
    +
    + + +
    +
    +ScrollToAction ()
    + + -

    + +

    -
    @@ -1257,129 +871,109 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - void - - perform - (UiController uiController, View view) -

    -
    -
    - - - -
    -
    - +
    +

    perform

    +
    +
    + + - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1391,193 +985,65 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/Swipe.html b/docs/html/reference/android/support/test/espresso/action/Swipe.html index c03b3d6b22c3..c8d8c03bb2ae 100644 --- a/docs/html/reference/android/support/test/espresso/action/Swipe.html +++ b/docs/html/reference/android/support/test/espresso/action/Swipe.html @@ -1,4 +1,3 @@ - @@ -93,544 +92,111 @@ - - - - - - -Swipe | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Swipe - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - enum -

    Swipe

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - +

    Swipe

    +

    + + public + + + + enum + Swipe + +
    + + + + + + + + + + + extends Enum<Swipe> + + + + + + + + implements - - Swiper - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - + + Swiper + + + + + +

    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.espresso.action.Swipe
    + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Enum<android.support.test.espresso.action.Swipe> +
        ↳android.support.test.espresso.action.Swipe +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Executes different swipe types to given positions. +

    Executes different swipe types to given positions.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -788,33 +330,34 @@ Summary: - - - - - - - - - - - - - - - - - +
    Enum Values
    Swipe FAST  - Swipes quickly between the co-ordinates.  - - - -
    Swipe SLOW  - Swipes deliberately slowly between the co-ordinates, to aid in visual debugging.  - - - -
    + + + + + + + + + + + + + + + @@ -834,41 +377,54 @@ Summary: -

    Enum values

    Swipe  + FAST +

    Swipes quickly between the co-ordinates.  + + +

    +
    Swipe  + SLOW +

    Swipes deliberately slowly between the co-ordinates, to aid in visual debugging.  + + +

    +
    - - - - - - @@ -1385,16 +1098,6 @@ From interface
    Public Methods
    - - - - static + + - Swipe - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - valueOf(String name) -
    - - - final - static - - Swipe[] - - values() - -
    + + + static + + + Swipe + + + valueOf(String name) + + +
    + + + static + final + + Swipe[] + + + values() + + +
    @@ -880,207 +436,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1088,295 +713,383 @@ From class - - - - - -

    Inherited methods

    - -From class - - java.lang.Enum + + From +class + + + java.lang.Enum + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - android.support.test.espresso.action.Swiper -
    -
    +
    + + From +interface + + + java.lang.Comparable + + +
    + -
    - -From interface - - java.lang.Comparable + -
    -
    From +interface + + + android.support.test.espresso.action.Swiper + + +
    + -
    -
    - - - - - - - - - @@ -1403,69 +1106,53 @@ From interface -

    Enum Values

    +

    Enum values

    -
    -

    - - public - static - final - Swipe - - FAST -

    -
    - +
    +

    FAST

    +
    + + + +
    +
    +Swipe FAST
    + + + +

    Swipes quickly between the co-ordinates.

    -
    -
    - - - - -

    Swipes quickly between the co-ordinates.

    - - -
    +
    -
    -

    - - public - static - final - Swipe - - SLOW -

    -
    - - - - -
    -
    - - +
    +

    SLOW

    +
    + + + +
    +
    +Swipe SLOW
    + + -

    Swipes deliberately slowly between the co-ordinates, to aid in visual debugging.

    - + +

    Swipes deliberately slowly between the co-ordinates, to aid in visual debugging.

    -
    +
    @@ -1489,71 +1176,72 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Swipe - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +Swipe valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    Swipe
    +
    -
    -

    - - public - static - final - - - Swipe[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +Swipe[] values ()
    + + + + +

    + + + + + + +
    Returns
    Swipe[]
    +
    @@ -1565,193 +1253,65 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/Swiper.Status.html b/docs/html/reference/android/support/test/espresso/action/Swiper.Status.html index ecd066653a94..68aab49d173d 100644 --- a/docs/html/reference/android/support/test/espresso/action/Swiper.Status.html +++ b/docs/html/reference/android/support/test/espresso/action/Swiper.Status.html @@ -1,4 +1,3 @@ - @@ -93,537 +92,104 @@ - - - - - - -Swiper.Status | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Swiper.Status - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - final - - enum -

    Swiper.Status

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - +

    Swiper.Status

    +

    + + public + static + final + + enum + Swiper.Status + +
    + + + + + + + + + + + extends Enum<Swiper.Status> + + + + + + + + + + + +

    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.espresso.action.Swiper.Status
    + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Enum<android.support.test.espresso.action.Swiper.Status> +
        ↳android.support.test.espresso.action.Swiper.Status +
    + + +

    - - - -
    - - -

    Class Overview

    -

    The result of the swipe. +

    The result of the swipe.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -776,33 +318,34 @@ Summary: - - - - - - - - - - - - - - - - - +
    Enum Values
    Swiper.Status FAILURE  - Injecting the event was a complete failure.  - - - -
    Swiper.Status SUCCESS  - The swipe action completed successfully.  - - - -
    + + + + + + + + + + + + + + + @@ -822,41 +365,54 @@ Summary: -

    Enum values

    Swiper.Status  + FAILURE +

    Injecting the event was a complete failure.  + + +

    +
    Swiper.Status  + SUCCESS +

    The swipe action completed successfully.  + + +

    +
    - - - - - - - - - + -
    Public Methods
    + + - static - - Swiper.Status - - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - valueOf(String name) - -
    - - - final - static - - Status[] - - values() - -
    + + + static + + + Swiper.Status + + + valueOf(String name) + + +
    + + + static + final + + Status[] + + + values() + + +
    @@ -868,207 +424,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1076,201 +701,271 @@ From class - @@ -1280,41 +975,51 @@ From class - @@ -1323,16 +1028,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Enum + + From +class + + + java.lang.Enum + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - java.lang.Comparable + + From +interface + + + java.lang.Comparable + +
    - - - - - - - - - - @@ -1341,71 +1036,55 @@ From interface -

    Enum Values

    +

    Enum values

    -
    -

    - - public - static - final - Swiper.Status - - FAILURE -

    -
    - +
    +

    FAILURE

    +
    + + + +
    +
    +Swiper.Status FAILURE
    + + + +

    Injecting the event was a complete failure. +

    -
    -
    - - - - -

    Injecting the event was a complete failure. -

    - - -
    +
    -
    -

    - - public - static - final - Swiper.Status - - SUCCESS -

    -
    - - - - -
    -
    +
    +

    SUCCESS

    +
    + + + +
    +
    +Swiper.Status SUCCESS
    + + + +

    The swipe action completed successfully. +

    - -

    The swipe action completed successfully. -

    - - -
    +
    @@ -1429,71 +1108,72 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Swiper.Status - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +Swiper.Status valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    Swiper.Status
    +
    -
    -

    - - public - static - final - - - Status[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +Status[] values ()
    + + + + +

    + + + + + + +
    Returns
    Status[]
    +
    @@ -1505,193 +1185,65 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/Swiper.html b/docs/html/reference/android/support/test/espresso/action/Swiper.html index b10ef303ab5f..708033361a8a 100644 --- a/docs/html/reference/android/support/test/espresso/action/Swiper.html +++ b/docs/html/reference/android/support/test/espresso/action/Swiper.html @@ -1,4 +1,3 @@ - @@ -93,509 +92,76 @@ - - - - - - -Swiper | Android Developers - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -605,7 +171,7 @@ type="text/css"> Summary: Nested Classes - + @@ -618,162 +184,132 @@ Summary: | Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public - - - - interface -

    Swiper

    +

    Swiper

    +

    + + public + + + + interface + Swiper + +
    + + + + + +

    - - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.action.Swiper
    android.support.test.espresso.action.Swiper +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Interface to implement different swipe types. +

    Interface to implement different swipe types.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - enumSwiper.Status
    + + + + + + - - + + @@ -802,33 +338,38 @@ Summary: -

    Nested classes

    + + + + + enum - The result of the swipe.  - - - + Swiper.Status +

    The result of the swipe.  + + +

    - - - - - -
    Public Methods
    - abstract - + + - Swiper.Status - - - + + + + + + + + +

    Public methods

    - sendSwipe(UiController uiController, float[] startCoordinates, float[] endCoordinates, float[] precision) - -
    - Swipes from startCoordinates to endCoordinates using the given - uiController to send MotionEvents. - - - -
    - -
    + abstract + + + + + Swiper.Status + + + sendSwipe(UiController uiController, float[] startCoordinates, float[] endCoordinates, float[] precision) + + +

    Swipes from startCoordinates to endCoordinates using the given + uiController to send MotionEvents. + + +

    + +
    @@ -839,16 +380,6 @@ Summary: - - - - - - - - - - @@ -874,66 +405,67 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - Swiper.Status - - sendSwipe - (UiController uiController, float[] startCoordinates, float[] endCoordinates, float[] precision) -

    -
    -
    - - - -
    -
    - - - - -

    Swipes from startCoordinates to endCoordinates using the given - uiController to send MotionEvents.

    -
    -
    Parameters
    - - - - - - - - - - - - - -
    uiController - a UiController to use to send MotionEvents to the screen.
    startCoordinates - a float[] with x and y co-ordinates of the start of the swipe.
    endCoordinates - a float[] with x and y co-ordinates of the end of the swipe.
    precision - a float[] with x and y values of precision of the tap.
    -
    -
    -
    Returns
    -
    • The status of the swipe. -
    -
    +
    +

    sendSwipe

    +
    +
    + +
    +
    +Swiper.Status sendSwipe (UiController uiController, 
    +                float[] startCoordinates, 
    +                float[] endCoordinates, 
    +                float[] precision)
    + + + + +

    Swipes from startCoordinates to endCoordinates using the given + uiController to send MotionEvents.

    + + + + + + + + + + + + + + + + + + +
    Parameters
    uiController + UiController: + a UiController to use to send MotionEvents to the screen.
    startCoordinates + float: + a float[] with x and y co-ordinates of the start of the swipe.
    endCoordinates + float: + a float[] with x and y co-ordinates of the end of the swipe.
    precision + float: + a float[] with x and y values of precision of the tap.
    + + + + + + +
    Returns
    Swiper.StatusThe status of the swipe. +
    +
    @@ -945,193 +477,65 @@ Summary: - -
    - -
    - -
    - - - -
    - - - + + diff --git a/docs/html/reference/android/support/test/espresso/action/Tap.html b/docs/html/reference/android/support/test/espresso/action/Tap.html index ce5392c5f8b6..4ad4e48ffc6e 100644 --- a/docs/html/reference/android/support/test/espresso/action/Tap.html +++ b/docs/html/reference/android/support/test/espresso/action/Tap.html @@ -1,770 +1,3 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Tap | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - - - - enum -

    Tap

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - implements - - Tapper - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.espresso.action.Tap
    - - - - - - - -
    - - -

    Class Overview

    -

    Executes different click types to given position. -

    - - - - - -
    - - - - - - - - - @@ -772,62 +5,6 @@ Summary: -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -845,456 +22,702 @@ Summary: - -
    Enum Values
    Tap DOUBLE  -   - - - -
    Tap LONG  -   - - - -
    Tap SINGLE  -   - - - -
    - - - - - - - - - - -
    Public Methods
    - - - - static - Tap - - valueOf(String name) -
    - final - static - Tap[] - - values() -
    - - - - - - - - - - - @@ -1396,16 +1109,6 @@ From interface
    - [Expand] -
    Inherited Methods
    - -From class - java.lang.Enum -
    - -
    -
    - -From class - - java.lang.Object - -
    - -
    -
    - - - - - - - - - @@ -1414,100 +1117,76 @@ From interface -

    Enum Values

    +

    Enum values

    -
    -

    - - public - static - final - Tap - - DOUBLE -

    -
    - - +
    +

    DOUBLE

    +
    + + + +
    +
    +Tap DOUBLE
    + + -
    -
    - - - - -

    - + +

    -
    +
    -
    -

    - - public - static - final - Tap - - LONG -

    -
    - - - - -
    -
    - - - +
    +

    LONG

    +
    + + + -

    +
    +
    +Tap LONG
    + + + +

    -
    +
    -
    -

    - - public - static - final - Tap - - SINGLE -

    -
    - - - - -
    -
    +
    +

    SINGLE

    +
    + + + +
    +
    +Tap SINGLE
    + + + +

    - -

    - - -
    +
    @@ -1531,71 +1210,72 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Tap - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +Tap valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    Tap
    +
    -
    -

    - - public - static - final - - - Tap[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +Tap[] values ()
    + + + + +

    + + + + + + +
    Returns
    Tap[]
    +
    @@ -1607,193 +1287,65 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/Tapper.Status.html b/docs/html/reference/android/support/test/espresso/action/Tapper.Status.html index 76d842005d8c..5c576f0455f2 100644 --- a/docs/html/reference/android/support/test/espresso/action/Tapper.Status.html +++ b/docs/html/reference/android/support/test/espresso/action/Tapper.Status.html @@ -1,4 +1,3 @@ - @@ -93,537 +92,104 @@ - - - - - - -Tapper.Status | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Tapper.Status - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - final - - enum -

    Tapper.Status

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - +

    Tapper.Status

    +

    + + public + static + final + + enum + Tapper.Status + +
    + + + + + + + + + + + extends Enum<Tapper.Status> + + + + + + + + + + + +

    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.espresso.action.Tapper.Status
    + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Enum<android.support.test.espresso.action.Tapper.Status> +
        ↳android.support.test.espresso.action.Tapper.Status +
    + + +

    - - - -
    - - -

    Class Overview

    -

    The result of the tap. +

    The result of the tap.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -776,46 +318,47 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - + + - - - + + - - - + + - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Enum Values
    Tapper.Status FAILURE  - Injecting the event was a complete failure.  - - - -
    Tapper.Status SUCCESS  - The Tap action completed successfully.  - - - -
    Tapper.Status WARNING  - The action seemed to have completed - but may have been misinterpreted + + + + + + + + + + + + + + + + + + + - - - + + +

    + + + + @@ -835,41 +378,54 @@ Summary: -

    Enum values

    Tapper.Status  + FAILURE +

    Injecting the event was a complete failure.  + + +

    +
    Tapper.Status  + SUCCESS +

    The Tap action completed successfully.  + + +

    +
    Tapper.Status  + WARNING +

    The action seemed to have completed - but may have been misinterpreted by the application.  - - - -

    - - - +
    Public Methods
    + - - - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - - static - - Tapper.Status - - valueOf(String name) - -
    - - - final - static - - Status[] - - values() - -
    + + + static + + + Tapper.Status + + + valueOf(String name) + + +
    + + + static + final + + Status[] + + + values() + + +
    @@ -881,207 +437,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1089,201 +714,271 @@ From class - @@ -1293,41 +988,51 @@ From class - @@ -1336,16 +1041,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Enum + + From +class + + + java.lang.Enum + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - java.lang.Comparable + + From +interface + + + java.lang.Comparable + +
    - - - - - - - - - - @@ -1354,105 +1049,81 @@ From interface -

    Enum Values

    +

    Enum values

    -
    -

    - - public - static - final - Tapper.Status - - FAILURE -

    -
    - - - +
    +

    FAILURE

    +
    + + + -
    -
    - - - - -

    Injecting the event was a complete failure. -

    +
    +
    +Tapper.Status FAILURE
    + + + +

    Injecting the event was a complete failure. +

    -
    +
    -
    -

    - - public - static - final - Tapper.Status - - SUCCESS -

    -
    - - - - -
    -
    - - +
    +

    SUCCESS

    +
    + + + +
    +
    +Tapper.Status SUCCESS
    + + -

    The Tap action completed successfully. -

    - + +

    The Tap action completed successfully. +

    -
    +
    -
    -

    - - public - static - final - Tapper.Status - - WARNING -

    -
    - - - - -
    -
    - - +
    +

    WARNING

    +
    + + + +
    +
    +Tapper.Status WARNING
    + + -

    The action seemed to have completed - but may have been misinterpreted + +

    The action seemed to have completed - but may have been misinterpreted by the application. (For Example a TAP became a LONG PRESS by measuring its time between the down and up events). -

    - +

    -
    +
    @@ -1476,71 +1147,72 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Tapper.Status - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +Tapper.Status valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    Tapper.Status
    +
    -
    -

    - - public - static - final - - - Status[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +Status[] values ()
    + + + + +

    + + + + + + +
    Returns
    Status[]
    +
    @@ -1552,193 +1224,65 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/Tapper.html b/docs/html/reference/android/support/test/espresso/action/Tapper.html index 36b742aa526e..4bff6059cbba 100644 --- a/docs/html/reference/android/support/test/espresso/action/Tapper.html +++ b/docs/html/reference/android/support/test/espresso/action/Tapper.html @@ -1,4 +1,3 @@ - @@ -93,509 +92,76 @@ - - - - - - -Tapper | Android Developers - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -605,7 +171,7 @@ type="text/css"> Summary: Nested Classes - + @@ -618,162 +184,132 @@ Summary: | Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public - - - - interface -

    Tapper

    - - - - - - - - - - +

    Tapper

    +

    + + public + + + + interface + Tapper + +
    -

    - -
    - -
    - + + + + + - +

    - - + + + + +
    android.support.test.espresso.action.Tapper
    android.support.test.espresso.action.Tapper +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Interface to implement different click types. +

    Interface to implement different click types.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - enumTapper.Status
    + + + + + + - - + + @@ -802,32 +338,37 @@ Summary: -

    Nested classes

    + + + + + enum - The result of the tap.  - - - + Tapper.Status +

    The result of the tap.  + + +

    - - - - - - @@ -1213,16 +841,6 @@ From interface
    Public Methods
    - abstract + + - - Tapper.Status - - - + + + + + + + + +

    Public methods

    - sendTap(UiController uiController, float[] coordinates, float[] precision) - -
    - Sends a MotionEvent to the given UiController. - - - -
    - -
    + abstract + + + + + Tapper.Status + + + sendTap(UiController uiController, float[] coordinates, float[] precision) + + +

    Sends a MotionEvent to the given UiController. + + +

    + +
    @@ -838,16 +379,6 @@ Summary: - - - - - - - - - - @@ -873,61 +404,59 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - Tapper.Status - - sendTap - (UiController uiController, float[] coordinates, float[] precision) -

    -
    -
    - - - -
    -
    - - - - -

    Sends a MotionEvent to the given UiController.

    -
    -
    Parameters
    - - - - - - - - - - -
    uiController - a UiController to use to send MotionEvents to the screen.
    coordinates - a float[] with x and y values of center of the tap.
    precision - a float[] with x and y values of precision of the tap.
    -
    -
    -
    Returns
    -
    • The status of the tap. -
    -
    +
    +

    sendTap

    +
    +
    + +
    +
    +Tapper.Status sendTap (UiController uiController, 
    +                float[] coordinates, 
    +                float[] precision)
    + + + + +

    Sends a MotionEvent to the given UiController.

    + + + + + + + + + + + + + + +
    Parameters
    uiController + UiController: + a UiController to use to send MotionEvents to the screen.
    coordinates + float: + a float[] with x and y values of center of the tap.
    precision + float: + a float[] with x and y values of precision of the tap.
    + + + + + + +
    Returns
    Tapper.StatusThe status of the tap. +
    +
    @@ -939,193 +468,65 @@ Summary: - -
    - -
    - -
    - - - -
    - - - + + diff --git a/docs/html/reference/android/support/test/espresso/action/TypeTextAction.html b/docs/html/reference/android/support/test/espresso/action/TypeTextAction.html index 87af578e4c5d..53301945c74c 100644 --- a/docs/html/reference/android/support/test/espresso/action/TypeTextAction.html +++ b/docs/html/reference/android/support/test/espresso/action/TypeTextAction.html @@ -1,4 +1,3 @@ - @@ -93,525 +92,92 @@ - - - - - - -TypeTextAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +TypeTextAction - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    TypeTextAction

    - - - - - extends Object
    - - - - - - +

    TypeTextAction

    +

    + + public + + final + + class + TypeTextAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.action.TypeTextAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.action.TypeTextAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Enables typing text on views. +

    Enables typing text on views.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -767,55 +306,46 @@ Summary: - - - - - - - - - - - - - - - +
    Public Constructors
    - - - - - - - - TypeTextAction(String stringToBeTyped) - -
    - Constructs TypeTextAction with given string. - - - -
    - -
    - - - - - - - - TypeTextAction(String stringToBeTyped, boolean tapToFocus) - -
    - Constructs TypeTextAction with given string. - - - -
    - -
    + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + TypeTextAction(String stringToBeTyped) + + +

    Constructs TypeTextAction with given string. + + +

    + +
    + + TypeTextAction(String stringToBeTyped, boolean tapToFocus) + + +

    Constructs TypeTextAction with given string. + + +

    + +
    @@ -826,78 +356,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController uiController, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController uiController, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -909,207 +452,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1117,94 +729,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1240,98 +858,79 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - TypeTextAction - (String stringToBeTyped) -

    -
    -
    - - +
    +

    TypeTextAction

    +
    +
    + + -
    -
    - - - - -

    Constructs TypeTextAction with given string. If the string is empty it results in no-op - (nothing is typed). By default this action sends a tap event to the center of the view to - attain focus before typing.

    -
    -
    Parameters
    - - - +
    stringToBeTyped - String To be typed by TypeTextAction + +
    +TypeTextAction (String stringToBeTyped)
    + + + + +

    Constructs TypeTextAction with given string. If the string is empty it results in no-op + (nothing is typed). By default this action sends a tap event to the center of the view to + attain focus before typing.

    + + + + + - -
    Parameters
    stringToBeTyped + String: + String To be typed by TypeTextAction
    - +
    -
    -
    -

    - - public - - - - - - - TypeTextAction - (String stringToBeTyped, boolean tapToFocus) -

    -
    -
    - +
    +

    TypeTextAction

    +
    +
    + + - -
    -
    - - - - -

    Constructs TypeTextAction with given string. If the string is empty it results in no-op - (nothing is typed).

    -
    -
    Parameters
    - - - - - - +
    stringToBeTyped - String To be typed by TypeTextAction
    tapToFocus - indicates whether a tap should be sent to the underlying view before typing. + +
    +TypeTextAction (String stringToBeTyped, 
    +                boolean tapToFocus)
    + + + + +

    Constructs TypeTextAction with given string. If the string is empty it results in no-op + (nothing is typed).

    + + + + + + + + + - -
    Parameters
    stringToBeTyped + String: + String To be typed by TypeTextAction
    tapToFocus + boolean: + indicates whether a tap should be sent to the underlying view before typing.
    - +
    -
    @@ -1346,129 +945,109 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - void - - perform - (UiController uiController, View view) -

    -
    -
    - - +
    +

    perform

    +
    +
    + + -
    -
    - - - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    uiController - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController uiController, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    uiController + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1480,193 +1059,65 @@ From interface - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/ViewActions.html b/docs/html/reference/android/support/test/espresso/action/ViewActions.html index 303ea322b415..37489f3aa222 100644 --- a/docs/html/reference/android/support/test/espresso/action/ViewActions.html +++ b/docs/html/reference/android/support/test/espresso/action/ViewActions.html @@ -1,4 +1,3 @@ - @@ -93,518 +92,85 @@ - - - - - - -ViewActions | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ViewActions - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    +
    +
    + +

    ViewActions

    +

    + + public + + final + + class + ViewActions + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + - - +
    java.lang.Object +
       ↳android.support.test.espresso.action.ViewActions +
    + + - +

    -
    - public - final +

    A collection of common ViewActions. +

    - class -

    ViewActions

    - extends Object
    +

    Summary

    @@ -666,1796 +277,1867 @@ Summary: -
    -
    -
    - - - - - - - - -
    java.lang.Object
       ↳android.support.test.espresso.action.ViewActions
    + + + -
    -

    Class Overview

    -

    A collection of common ViewActions. + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + static + + + ViewAction + + + actionWithAssertions(ViewAction viewAction) + + +

    Performs all assertions before the ViewActions in this class and then performs the + given ViewAction + + +

    + +
    + + + static + + + void + + + addGlobalAssertion(String name, ViewAssertion viewAssertion) + + +

    Adds a ViewAssertion to be run every time a ViewAction in this class is + performed. + + +

    + +
    + + + static + + + void + + + clearGlobalAssertions() + + +
    + + + static + + + ViewAction + + + clearText() + + +

    Returns an action that clears text on the view. + +

    + +
    + + + static + + + ViewAction + + + click() + + +

    Returns an action that clicks the view. + + +

    + +
    + + + static + + + ViewAction + + + click(ViewAction rollbackAction) + + +

    Returns an action that performs a single click on the view. + + +

    + +
    + + + static + + + ViewAction + + + closeSoftKeyboard() + + +

    Returns an action that closes soft keyboard. + + +

    + +
    + + + static + + + ViewAction + + + doubleClick() + + +

    Returns an action that double clicks the view. + + +

    + +
    + + + static + + + ViewAction + + + longClick() + + +

    Returns an action that long clicks the view. + + +

    + +
    + + + static + + + ViewAction + + + openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher) + + +

    Returns an action that opens a link matching the given link text and uri matchers. + + +

    + +
    + + + static + + + ViewAction + + + openLinkWithText(String linkText) + + +

    Same as openLinkWithText(Matcher<String> linkTextMatcher), but uses + is(linkText) as the linkTextMatcher. + + +

    + +
    + + + static + + + ViewAction + + + openLinkWithText(Matcher<String> linkTextMatcher) + + +

    Same as openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher), but uses + any(Uri.class) as the uriMatcher. + + +

    + +
    + + + static + + + ViewAction + + + openLinkWithUri(String uri) + + +

    Same as openLinkWithUri(Matcher<Uri> uriMatcher), but uses is(uri) as the + uriMatcher. + + +

    + +
    + + + static + + + ViewAction + + + openLinkWithUri(Matcher<Uri> uriMatcher) + + +

    Same as openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher), but uses + any(String.class) as the linkTextMatcher. + + +

    + +
    + + + static + + + ViewAction + + + pressBack() + + +

    Returns an action that clicks the back button. + + +

    + +
    + + + static + + + ViewAction + + + pressImeActionButton() + + +

    Returns an action that presses the current action button (next, done, search, etc) on the IME + (Input Method Editor). + + +

    + +
    + + + static + + + ViewAction + + + pressKey(int keyCode) + + +

    Returns an action that presses the key specified by the keyCode (eg. + + +

    + +
    + + + static + + + ViewAction + + + pressKey(EspressoKey key) + + +

    Returns an action that presses the specified key with the specified modifiers. + + +

    + +
    + + + static + + + ViewAction + + + pressMenuKey() + + +

    Returns an action that presses the hardware menu key. + + +

    + +
    + + + static + + + void + + + removeGlobalAssertion(ViewAssertion viewAssertion) + + +

    Removes the given assertion from the set of assertions to be run before actions are performed. + + +

    + +
    + + + static + + + ViewAction + + + replaceText(String stringToBeSet) + + +

    Returns an action that updates the text attribute of a view. + + +

    + +
    + + + static + + + ViewAction + + + scrollTo() + + +

    Returns an action that scrolls to the view. + + +

    + +
    + + + static + + + ViewAction + + + swipeDown() + + +

    Returns an action that performs a swipe top-to-bottom across the horizontal center of the view. + + +

    + +
    + + + static + + + ViewAction + + + swipeLeft() + + +

    Returns an action that performs a swipe right-to-left across the vertical center of the + view. + + +

    + +
    + + + static + + + ViewAction + + + swipeRight() + + +

    Returns an action that performs a swipe left-to-right across the vertical center of the + view. + + +

    + +
    + + + static + + + ViewAction + + + swipeUp() + + +

    Returns an action that performs a swipe bottom-to-top across the horizontal center of the view. + + +

    + +
    + + + static + + + ViewAction + + + typeText(String stringToBeTyped) + + +

    Returns an action that selects the view (by clicking on it) and types the provided string into + the view. + + +

    + +
    + + + static + + + ViewAction + + + typeTextIntoFocusedView(String stringToBeTyped) + + +

    Returns an action that types the provided string into the view. + + +

    + +
    -
    + + + + + +

    Inherited methods

    + From +class + + + java.lang.Object + + +
    + + +
    +
    + + -
    + -

    Summary

    + + + + + + +

    Public methods

    + +
    +

    actionWithAssertions

    +
    +
    + + +
    +
    +ViewAction actionWithAssertions (ViewAction viewAction)
    + + + + +

    Performs all assertions before the ViewActions in this class and then performs the + given ViewAction

    + + + + + + +
    Parameters
    viewAction + ViewAction: + the ViewAction to perform after the assertions +
    + + + + + + +
    Returns
    ViewAction
    +
    + +
    +

    addGlobalAssertion

    +
    +
    + + +
    +
    +void addGlobalAssertion (String name, 
    +                ViewAssertion viewAssertion)
    + + + + +

    Adds a ViewAssertion to be run every time a ViewAction in this class is + performed. The assertion will be run prior to performing the action.

    + + + + + + + + + + +
    Parameters
    name + String: + a name of the assertion to be added
    viewAssertion + ViewAssertion: + a ViewAssertion to be added
    + + + + + + +
    Throws
    IllegalArgumentExceptionif the name/viewAssertion pair is already contained in the + global assertions. +
    + +
    + +
    +

    clearGlobalAssertions

    +
    +
    + + +
    +
    +void clearGlobalAssertions ()
    + + + +

    +
    - - + +
    +

    clearText

    +
    +
    + + +
    +
    +ViewAction clearText ()
    + + -
    - - + +
    +

    click

    +
    +
    + + +
    +
    +ViewAction click (ViewAction rollbackAction)
    + + -
    - - + +
    +ViewAction closeSoftKeyboard ()
    + + + +

    Returns an action that closes soft keyboard. If the keyboard is already closed, it is a no-op. +

    +
    Public Methods
    + +

    Returns an action that clears text on the view.
    +
    + View constraints: +

    - actionWithAssertions(ViewAction viewAction) +
    +

    click

    +
    +
    + + -
    - Performs all assertions before the ViewActions in this class and then performs the - given ViewAction +
    +
    +ViewAction click ()
    + + + +

    Returns an action that clicks the view.
    +
    + View constraints: +

      +
    • must be displayed on screen +
    -
    -
    + +

    Returns an action that performs a single click on the view. + If the click takes longer than the 'long press' duration (which is possible) the provided + rollback action is invoked on the view and a click is attempted again. + This is only necessary if the view being clicked on has some different behaviour for long press + versus a normal tap. - static + For example - if a long press on a particular view element opens a popup menu - + ViewActions.pressBack() may be an acceptable rollback action. - void -

    - addGlobalAssertion(String name, ViewAssertion viewAssertion) +
    + View constraints: +
      +
    • must be displayed on screen
    • +
    • any constraints of the rollbackAction
    • +
        +

        + + + + + + +
        Parameters
        rollbackAction + ViewAction +
        + + + + + + +
        Returns
        ViewAction
        -
        - Adds a ViewAssertion to be run every time a ViewAction in this class is - performed. +
        + - +
        +

        closeSoftKeyboard

        +
        +
        + + -
    + + + + + +
    Returns
    ViewAction
    +
    -
    + +
    +

    doubleClick

    +
    +
    + + - static +
    +
    +ViewAction doubleClick ()
    + + - void
    -
    - clearGlobalAssertions() + +

    Returns an action that double clicks the view.
    +
    + View preconditions: +

      +
    • must be displayed on screen +
    +
    +

    longClick

    +
    +
    + + +
    +
    +ViewAction longClick ()
    + + + +

    Returns an action that long clicks the view.
    - static +
    + View preconditions: +

    - clearText() + -
    - Returns an action that clears text on the view. + +
    +

    openLink

    +
    +
    + + -
    +
    +
    +ViewAction openLink (Matcher<String> linkTextMatcher, 
    +                Matcher<Uri> uriMatcher)
    + + + + +

    Returns an action that opens a link matching the given link text and uri matchers. The action + is performed by invoking the link's onClick method (as opposed to actually issuing a click on + the screen). +
    +
    + View preconditions: +

      +
    • must be displayed on screen +
    • must be assignable from TextView +
    • must have links +
        +

        + + + + + + + + + + +
        Parameters
        linkTextMatcher + Matcher +
        uriMatcher + Matcher +
        + + + + + + +
        Returns
        ViewAction
        -
    +
    +

    openLinkWithText

    +
    +
    + + +
    +
    +ViewAction openLinkWithText (String linkText)
    + + + +

    Same as openLinkWithText(Matcher<String> linkTextMatcher), but uses + is(linkText) as the linkTextMatcher. +

    + + + + + + +
    Parameters
    linkText + String +
    + + + + + + +
    Returns
    ViewAction
    - static +
    - ViewAction
    -
    - click(ViewAction rollbackAction) -
    - Returns an action that performs a single click on the view. + +
    +

    openLinkWithText

    +
    +
    + + +
    +
    +ViewAction openLinkWithText (Matcher<String> linkTextMatcher)
    + + -
    + +

    Same as openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher), but uses + any(Uri.class) as the uriMatcher. +

    + + + + + + +
    Parameters
    linkTextMatcher + Matcher +
    + + + + + + +
    Returns
    ViewAction
    -
    +
    +

    openLinkWithUri

    +
    +
    + + +
    +
    +ViewAction openLinkWithUri (String uri)
    + + + +

    Same as openLinkWithUri(Matcher<Uri> uriMatcher), but uses is(uri) as the + uriMatcher. +

    + + + + + + +
    Parameters
    uri + String +
    + + + + + + +
    Returns
    ViewAction
    - static +
    - ViewAction
    -
    - click() -
    - Returns an action that clicks the view. + +
    +

    openLinkWithUri

    +
    +
    + + +
    +
    +ViewAction openLinkWithUri (Matcher<Uri> uriMatcher)
    + + -
    + +

    Same as openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher), but uses + any(String.class) as the linkTextMatcher. +

    + + + + + + +
    Parameters
    uriMatcher + Matcher +
    + + + + + + +
    Returns
    ViewAction
    -
    +
    +

    pressBack

    +
    +
    + + +
    +
    +ViewAction pressBack ()
    + + + +

    Returns an action that clicks the back button. +

    + + + + + + +
    Returns
    ViewAction
    - static +
    - ViewAction
    -
    - closeSoftKeyboard() -
    - Returns an action that closes soft keyboard. + +
    +

    pressImeActionButton

    +
    +
    + + +
    +
    +ViewAction pressImeActionButton ()
    + + -
    - -
    - - - - static - - ViewAction - - doubleClick() - -
    - Returns an action that double clicks the view. - - - -
    - -
    - - - - static - - ViewAction - - longClick() - -
    - Returns an action that long clicks the view. - - - -
    - -
    - - - - static - - ViewAction - - openLink(Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher) - -
    - Returns an action that opens a link matching the given link text and uri matchers. - - - -
    - -
    - - - - static - - ViewAction - - openLinkWithText(Matcher<String> linkTextMatcher) - -
    - Same as openLink(Matcher linkTextMatcher, Matcher uriMatcher), but uses - any(Uri.class) as the uriMatcher. - - - -
    - -
    - - - - static - - ViewAction - - openLinkWithText(String linkText) - -
    - Same as openLinkWithText(Matcher linkTextMatcher), but uses - is(linkText) as the linkTextMatcher. - - - -
    - -
    - - - - static - - ViewAction - - openLinkWithUri(Matcher<Uri> uriMatcher) - -
    - Same as openLink(Matcher linkTextMatcher, Matcher uriMatcher), but uses - any(String.class) as the linkTextMatcher. - - - -
    - -
    - - - - static - - ViewAction - - openLinkWithUri(String uri) - -
    - Same as openLinkWithUri(Matcher uriMatcher), but uses is(uri) as the - uriMatcher. - - - -
    - -
    - - - - static - - ViewAction - - pressBack() - -
    - Returns an action that clicks the back button. - - - -
    - -
    - - - - static - - ViewAction - - pressImeActionButton() - -
    - Returns an action that presses the current action button (next, done, search, etc) on the IME - (Input Method Editor). - - - -
    - -
    - - - - static - - ViewAction - - pressKey(int keyCode) - -
    - Returns an action that presses the key specified by the keyCode (eg. - - - -
    - -
    - - - - static - - ViewAction - - pressKey(EspressoKey key) - -
    - Returns an action that presses the specified key with the specified modifiers. - - - -
    - -
    - - - - static - - ViewAction - - pressMenuKey() - -
    - Returns an action that presses the hardware menu key. - - - -
    - -
    - - - - static - - void - - removeGlobalAssertion(ViewAssertion viewAssertion) - -
    - Removes the given assertion from the set of assertions to be run before actions are performed. - - - -
    - -
    - - - - static - - ViewAction - - replaceText(String stringToBeSet) - -
    - Returns an action that updates the text attribute of a view. - - - -
    - -
    - - - - static - - ViewAction - - scrollTo() - -
    - Returns an action that scrolls to the view. - - - -
    - -
    - - - - static - - ViewAction - - swipeDown() - -
    - Returns an action that performs a swipe top-to-bottom across the horizontal center of the view. - - - -
    - -
    - - - - static - - ViewAction - - swipeLeft() - -
    - Returns an action that performs a swipe right-to-left across the vertical center of the - view. - - - -
    - -
    - - - - static - - ViewAction - - swipeRight() - -
    - Returns an action that performs a swipe left-to-right across the vertical center of the - view. - - - -
    - -
    - - - - static - - ViewAction - - swipeUp() - -
    - Returns an action that performs a swipe bottom-to-top across the horizontal center of the view. - - - -
    - -
    - - - - static - - ViewAction - - typeText(String stringToBeTyped) - -
    - Returns an action that selects the view (by clicking on it) and types the provided string into - the view. - - - -
    - -
    - - - - static - - ViewAction - - typeTextIntoFocusedView(String stringToBeTyped) - -
    - Returns an action that types the provided string into the view. - - - -
    - -
    - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - static - - - - ViewAction - - actionWithAssertions - (ViewAction viewAction) -

    -
    -
    - - - -
    -
    - - - - -

    Performs all assertions before the ViewActions in this class and then performs the - given ViewAction

    -
    -
    Parameters
    - - - - -
    viewAction - the ViewAction to perform after the assertions -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - void - - addGlobalAssertion - (String name, ViewAssertion viewAssertion) -

    -
    -
    - - - -
    -
    - - - - -

    Adds a ViewAssertion to be run every time a ViewAction in this class is - performed. The assertion will be run prior to performing the action.

    -
    -
    Parameters
    - - - - - - - -
    name - a name of the assertion to be added
    viewAssertion - a ViewAssertion to be added
    -
    -
    -
    Throws
    - - - - -
    IllegalArgumentException - if the name/viewAssertion pair is already contained in the - global assertions. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - void - - clearGlobalAssertions - () -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - clearText - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns an action that clears text on the view.
    -
    - View constraints: -

      -
    • must be displayed on screen -
        -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - click - (ViewAction rollbackAction) -

    -
    -
    - - - -
    -
    - - - - -

    Returns an action that performs a single click on the view. - - If the click takes longer than the 'long press' duration (which is possible) the provided - rollback action is invoked on the view and a click is attempted again. - - This is only necessary if the view being clicked on has some different behaviour for long press - versus a normal tap. - - For example - if a long press on a particular view element opens a popup menu - - ViewActions.pressBack() may be an acceptable rollback action. - -
    - View constraints: -

      -
    • must be displayed on screen
    • -
    • any constraints of the rollbackAction
    • -
        -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - click - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns an action that clicks the view.
    -
    - View constraints: -

      -
    • must be displayed on screen -
        -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - closeSoftKeyboard - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns an action that closes soft keyboard. If the keyboard is already closed, it is a no-op. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - doubleClick - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns an action that double clicks the view.
    -
    - View preconditions: -

      -
    • must be displayed on screen -
        -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - longClick - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns an action that long clicks the view.
    - -
    - View preconditions: -

      -
    • must be displayed on screen -
        -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - openLink - (Matcher<String> linkTextMatcher, Matcher<Uri> uriMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns an action that opens a link matching the given link text and uri matchers. The action - is performed by invoking the link's onClick method (as opposed to actually issuing a click on - the screen). -
    -
    - View preconditions: -

      -
    • must be displayed on screen -
    • must be assignable from TextView -
    • must have links -
        -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - openLinkWithText - (Matcher<String> linkTextMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Same as openLink(Matcher linkTextMatcher, Matcher uriMatcher), but uses - any(Uri.class) as the uriMatcher. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - openLinkWithText - (String linkText) -

    -
    -
    - - - -
    -
    - - - - -

    Same as openLinkWithText(Matcher linkTextMatcher), but uses - is(linkText) as the linkTextMatcher. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - openLinkWithUri - (Matcher<Uri> uriMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Same as openLink(Matcher linkTextMatcher, Matcher uriMatcher), but uses - any(String.class) as the linkTextMatcher. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - openLinkWithUri - (String uri) -

    -
    -
    - - - -
    -
    - - - - -

    Same as openLinkWithUri(Matcher uriMatcher), but uses is(uri) as the - uriMatcher. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - pressBack - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns an action that clicks the back button. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - ViewAction - - pressImeActionButton - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns an action that presses the current action button (next, done, search, etc) on the IME + +

    Returns an action that presses the current action button (next, done, search, etc) on the IME (Input Method Editor). The selected view will have its onEditorAction method called. -

    +

    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - pressKey - (int keyCode) -

    -
    -
    - - - -
    -
    - - +
    +

    pressKey

    +
    +
    + + +
    +
    +ViewAction pressKey (int keyCode)
    + + -

    Returns an action that presses the key specified by the keyCode (eg. Keyevent.KEYCODE_BACK). -

    + +

    Returns an action that presses the key specified by the keyCode (eg. Keyevent.KEYCODE_BACK). +

    + + + + + + +
    Parameters
    keyCode + int +
    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - pressKey - (EspressoKey key) -

    -
    -
    - - - -
    -
    - - +
    +

    pressKey

    +
    +
    + + +
    +
    +ViewAction pressKey (EspressoKey key)
    + + -

    Returns an action that presses the specified key with the specified modifiers. -

    + +

    Returns an action that presses the specified key with the specified modifiers. +

    + + + + + + +
    Parameters
    key + EspressoKey +
    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - pressMenuKey - () -

    -
    -
    - - - -
    -
    - - +
    +

    pressMenuKey

    +
    +
    + + +
    +
    +ViewAction pressMenuKey ()
    + + -

    Returns an action that presses the hardware menu key. -

    + +

    Returns an action that presses the hardware menu key. +

    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - void - - removeGlobalAssertion - (ViewAssertion viewAssertion) -

    -
    -
    +
    +

    removeGlobalAssertion

    +
    +
    + + - - -
    -
    - - - - -

    Removes the given assertion from the set of assertions to be run before actions are performed.

    -
    -
    Parameters
    - - - - -
    viewAssertion - the assertion to remove
    -
    -
    -
    Throws
    - + +
    +void removeGlobalAssertion (ViewAssertion viewAssertion)
    + + + + +

    Removes the given assertion from the set of assertions to be run before actions are performed.

    +
    + + + + + +
    Parameters
    viewAssertion + ViewAssertion: + the assertion to remove
    + + - +
    Throws
    IllegalArgumentException - if the name/viewAssertion pair is not already contained in the + IllegalArgumentExceptionif the name/viewAssertion pair is not already contained in the global assertions.
    -
    + -
    -
    -

    - - public - static - - - - ViewAction - - replaceText - (String stringToBeSet) -

    -
    -
    - - - -
    -
    - - +
    +

    replaceText

    +
    +
    + + +
    +
    +ViewAction replaceText (String stringToBeSet)
    + + -

    Returns an action that updates the text attribute of a view. + +

    Returns an action that updates the text attribute of a view.

    View preconditions: @@ -2463,234 +2145,219 @@ From class

  • must be displayed on screen
  • must be assignable from EditText
      -

  • +

    + + + + + + +
    Parameters
    stringToBeSet + String +
    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - scrollTo - () -

    -
    -
    - - - -
    -
    - - +
    +

    scrollTo

    +
    +
    + + +
    +
    +ViewAction scrollTo ()
    + + -

    Returns an action that scrolls to the view.
    + +

    Returns an action that scrolls to the view.

    View preconditions:

    • must be a descendant of ScrollView
    • must have visibility set to View.VISIBLE
        -

    +

    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - swipeDown - () -

    -
    -
    - - - -
    -
    - - +
    +

    swipeDown

    +
    +
    + + +
    +
    +ViewAction swipeDown ()
    + + -

    Returns an action that performs a swipe top-to-bottom across the horizontal center of the view. + +

    Returns an action that performs a swipe top-to-bottom across the horizontal center of the view. The swipe doesn't start at the very edge of the view, but has a bit of offset.

    View constraints:

    • must be displayed on screen
        -

    +

    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - swipeLeft - () -

    -
    -
    - - - -
    -
    - - +
    +

    swipeLeft

    +
    +
    + + +
    +
    +ViewAction swipeLeft ()
    + + -

    Returns an action that performs a swipe right-to-left across the vertical center of the + +

    Returns an action that performs a swipe right-to-left across the vertical center of the view. The swipe doesn't start at the very edge of the view, but is a bit offset.

    View constraints:

    • must be displayed on screen
        -

    +

    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - swipeRight - () -

    -
    -
    - - - -
    -
    - - +
    +

    swipeRight

    +
    +
    + + +
    +
    +ViewAction swipeRight ()
    + + -

    Returns an action that performs a swipe left-to-right across the vertical center of the + +

    Returns an action that performs a swipe left-to-right across the vertical center of the view. The swipe doesn't start at the very edge of the view, but is a bit offset.

    View constraints:

    • must be displayed on screen
        -

    +

    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - swipeUp - () -

    -
    -
    - - - -
    -
    - - +
    +

    swipeUp

    +
    +
    + + +
    +
    +ViewAction swipeUp ()
    + + -

    Returns an action that performs a swipe bottom-to-top across the horizontal center of the view. + +

    Returns an action that performs a swipe bottom-to-top across the horizontal center of the view. The swipe doesn't start at the very edge of the view, but has a bit of offset.

    View constraints:

    • must be displayed on screen
        -

    +

    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - typeText - (String stringToBeTyped) -

    -
    -
    - - - -
    -
    - - +
    +

    typeText

    +
    +
    + + +
    +
    +ViewAction typeText (String stringToBeTyped)
    + + -

    Returns an action that selects the view (by clicking on it) and types the provided string into + +

    Returns an action that selects the view (by clicking on it) and types the provided string into the view. Appending a \n to the end of the string translates to a ENTER key event. Note: this method performs a tap on the view before typing to force the view into focus, if the view already contains text this tap may place the cursor at an arbitrary position within the text. @@ -2701,39 +2368,44 @@ From class

  • must be displayed on screen
  • must support input methods
      -

  • +

    + + + + + + +
    Parameters
    stringToBeTyped + String +
    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - typeTextIntoFocusedView - (String stringToBeTyped) -

    -
    -
    - - - -
    -
    - - +
    +

    typeTextIntoFocusedView

    +
    +
    + + +
    +
    +ViewAction typeTextIntoFocusedView (String stringToBeTyped)
    + + -

    Returns an action that types the provided string into the view. + +

    Returns an action that types the provided string into the view. Appending a \n to the end of the string translates to a ENTER key event. Note: this method does not change cursor position in the focused view - text is inserted at the location where the cursor is currently pointed.
    @@ -2744,9 +2416,24 @@ From class

  • must support input methods
  • must be already focused
      -

  • +

    + + + + + + +
    Parameters
    stringToBeTyped + String +
    + + + + + + +
    Returns
    ViewAction
    -
    @@ -2758,193 +2445,65 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/action/package-summary.html b/docs/html/reference/android/support/test/espresso/action/package-summary.html index 58447bf23eba..2f482df16044 100644 --- a/docs/html/reference/android/support/test/espresso/action/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/action/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,1100 +92,500 @@ - - - - - - -android.support.test.espresso.action | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.action - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.action

    -
    - -
    - -
    - - +

    android.support.test.espresso.action

    + +

    Interfaces

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + +
    AdapterViewProtocolAdapterViewProtocol A sadly necessary layer of indirection to interact with AdapterViews.  - - + +
    AdapterViewProtocol.DataFunctionAdapterViewProtocol.DataFunction - A custom function that is applied when getData() is executed.  - - + A custom function that is applied when getData() is executed.  + +
    CoordinatesProviderCoordinatesProvider Interface to implement calculation of Coordinates.  - - + +
    PrecisionDescriberPrecisionDescriber Interface to implement size of click area.  - - + +
    SwiperSwiper Interface to implement different swipe types.  - - + +
    TapperTapper Interface to implement different click types.  - - + +
    -
    - - + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + +
    AdapterDataLoaderActionAdapterDataLoaderAction Forces an AdapterView to ensure that the data matching a provided data matcher is loaded into the current view hierarchy.  - - + +
    AdapterViewProtocol.AdaptedDataAdapterViewProtocol.AdaptedData A holder that associates a data object from an AdapterView with a token the AdapterViewProtocol can use to force that data object to be rendered as a child or deeper descendant of the adapter view.  - - + +
    AdapterViewProtocol.AdaptedData.BuilderAdapterViewProtocol.AdaptedData.Builder   - - + +
    AdapterViewProtocolsAdapterViewProtocols - Implementations of AdapterViewProtocol for standard SDK Widgets.  - - + Implementations of AdapterViewProtocol for standard SDK Widgets.  + +
    CloseKeyboardActionCloseKeyboardAction Closes soft keyboard.  - - + +
    EditorActionEditorAction Performs whatever editor (IME) action is available on a view.  - - + +
    EspressoKeyEspressoKey Class that wraps the key code and meta state of the desired key press.  - - + +
    EspressoKey.BuilderEspressoKey.Builder Builder for the EspressoKey class.  - - + +
    GeneralClickActionGeneralClickAction Enables clicking on views.  - - + +
    GeneralSwipeActionGeneralSwipeAction Enables swiping across a view.  - - + +
    KeyEventActionKeyEventAction Enables pressing KeyEvents on views.  - - + +
    MotionEventsMotionEvents - Facilitates sending of motion events to a UiController.  - - + Facilitates sending of motion events to a UiController.  + +
    MotionEvents.DownResultHolderMotionEvents.DownResultHolder Holds the result of a down motion.  - - + +
    OpenLinkActionOpenLinkAction Invokes onClick of a link within a TextView (made with Linkify or via another method).  - - + +
    ReplaceTextActionReplaceTextAction - Replaces view text by setting EditTexts text property to given String.  - - + Replaces view text by setting EditTexts text property to given String.  + +
    ScrollToActionScrollToAction Enables scrolling to the given view.  - - + +
    TypeTextActionTypeTextAction Enables typing text on views.  - - + +
    ViewActionsViewActions - A collection of common ViewActions.  - - + A collection of common ViewActions.  + +
    -
    - - + +

    Enums

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + + + +
    GeneralLocationGeneralLocation Calculates coordinate position for general locations.  - - + +
    PressPress Returns different touch target sizes.  - - + +
    SwipeSwipe Executes different swipe types to given positions.  - - + +
    Swiper.StatusSwiper.Status The result of the swipe.  - - + +
    TapTap Executes different click types to given position.  - - + +
    Tapper.StatusTapper.Status The result of the tap.  - - + +
    + -
    -
    - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + + +
    + + + + diff --git a/docs/html/reference/android/support/test/espresso/assertion/LayoutAssertions.html b/docs/html/reference/android/support/test/espresso/assertion/LayoutAssertions.html index 73bfe571df11..c705da86e98d 100644 --- a/docs/html/reference/android/support/test/espresso/assertion/LayoutAssertions.html +++ b/docs/html/reference/android/support/test/espresso/assertion/LayoutAssertions.html @@ -1,4 +1,3 @@ - @@ -93,483 +92,85 @@ - - - - - - -LayoutAssertions | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +LayoutAssertions - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    LayoutAssertions

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    LayoutAssertions

    +

    + + public + + final + + class + LayoutAssertions + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.assertion.LayoutAssertions
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.assertion.LayoutAssertions +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of layout ViewAssertions. +

    A collection of layout ViewAssertions.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -721,105 +295,122 @@ Summary: - - - - - - - - - - + -
    Public Methods
    - - + + - static - ViewAssertion - - + + + + + - - - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + - + + +

    + + + +

    Public methods

    - noEllipsizedText() -
    - Returns a ViewAssertion that asserts that view hierarchy does not contain + +
    + + + static + + + ViewAssertion + + + noEllipsizedText() + + +

    Returns a ViewAssertion that asserts that view hierarchy does not contain ellipsized or cut off text views. - - - - - -

    - - - - static - - ViewAssertion - - noMultilineButtons() - -
    - Returns a ViewAssertion that asserts that view hierarchy does not contain + + +

    + +
    + + + static + + + ViewAssertion + + + noMultilineButtons() + + +

    Returns a ViewAssertion that asserts that view hierarchy does not contain multiline buttons. - - - - - -

    - - - - static - - ViewAssertion - - noOverlaps(Matcher<View> selector) - -
    - Returns a ViewAssertion that asserts that descendant views matching the selector + + +

    + +
    + + + static + + + ViewAssertion + + + noOverlaps(Matcher<View> selector) + + +

    Returns a ViewAssertion that asserts that descendant views matching the selector do not overlap each other. - - - - - -

    - - - - static - - ViewAssertion - - noOverlaps() - -
    - Returns a ViewAssertion that asserts that descendant objects assignable + + +

    + +
    + + + static + + + ViewAssertion + + + noOverlaps() + + +

    Returns a ViewAssertion that asserts that descendant objects assignable to TextView or ImageView do not overlap each other. - - - - - -

    @@ -831,207 +422,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1040,16 +700,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1075,147 +725,140 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - ViewAssertion - - noEllipsizedText - () -

    -
    -
    - - - -
    -
    - - +
    +

    noEllipsizedText

    +
    +
    + + +
    +
    +ViewAssertion noEllipsizedText ()
    + + -

    Returns a ViewAssertion that asserts that view hierarchy does not contain + +

    Returns a ViewAssertion that asserts that view hierarchy does not contain ellipsized or cut off text views. -

    +

    + + + + + + +
    Returns
    ViewAssertion
    -
    -
    -

    - - public - static - - - - ViewAssertion - - noMultilineButtons - () -

    -
    -
    - - - -
    -
    - - +
    +

    noMultilineButtons

    +
    +
    + + +
    +
    +ViewAssertion noMultilineButtons ()
    + + -

    Returns a ViewAssertion that asserts that view hierarchy does not contain + +

    Returns a ViewAssertion that asserts that view hierarchy does not contain multiline buttons. -

    +

    + + + + + + +
    Returns
    ViewAssertion
    -
    -
    -

    - - public - static - - - - ViewAssertion - - noOverlaps - (Matcher<View> selector) -

    -
    -
    - - - -
    -
    - - +
    +

    noOverlaps

    +
    +
    + + +
    +
    +ViewAssertion noOverlaps (Matcher<View> selector)
    + + -

    Returns a ViewAssertion that asserts that descendant views matching the selector + +

    Returns a ViewAssertion that asserts that descendant views matching the selector do not overlap each other.

    Example: onView(rootView).check(noOverlaps(isAssignableFrom(TextView.class)); -

    +

    + + + + + + +
    Parameters
    selector + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    -
    -
    -

    - - public - static - - - - ViewAssertion - - noOverlaps - () -

    -
    -
    - - - -
    -
    - - +
    +

    noOverlaps

    +
    +
    + + +
    +
    +ViewAssertion noOverlaps ()
    + + -

    Returns a ViewAssertion that asserts that descendant objects assignable + +

    Returns a ViewAssertion that asserts that descendant objects assignable to TextView or ImageView do not overlap each other.

    Example: onView(rootView).check(noOverlaps()) -

    +

    + + + + + + +
    Returns
    ViewAssertion
    -
    @@ -1227,193 +870,30 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/assertion/PositionAssertions.html b/docs/html/reference/android/support/test/espresso/assertion/PositionAssertions.html index c54c3614bd31..ea87f096120b 100644 --- a/docs/html/reference/android/support/test/espresso/assertion/PositionAssertions.html +++ b/docs/html/reference/android/support/test/espresso/assertion/PositionAssertions.html @@ -1,4 +1,3 @@ - @@ -93,483 +92,85 @@ - - - - - - -PositionAssertions | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +PositionAssertions - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    PositionAssertions

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    PositionAssertions

    +

    + + public + + final + + class + PositionAssertions + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.assertion.PositionAssertions
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.assertion.PositionAssertions +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of ViewAssertions for checking relative position of elements on the screen. +

    A collection of ViewAssertions for checking relative position of elements on the screen.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -721,201 +295,234 @@ Summary: - +
    Public Methods
    + - - - - + + + + + - - - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + - + + +

    + + + +

    Public methods

    - - - - static - - ViewAssertion - - isAbove(Matcher<View> matcher) - -
    - Returns an Assertion that asserts that view displayed is completely above + +
    + + + static + + + ViewAssertion + + + isAbove(Matcher<View> matcher) + + +

    Returns an Assertion that asserts that view displayed is completely above the view matching the given matcher. - - - - - -

    - - - - static - - ViewAssertion - - isBelow(Matcher<View> matcher) - -
    - Returns a ViewAssertion that asserts that view displayed is completely + + +

    + +
    + + + static + + + ViewAssertion + + + isBelow(Matcher<View> matcher) + + +

    Returns a ViewAssertion that asserts that view displayed is completely below the view matching the given matcher. - - - - - -

    - - - - static - - ViewAssertion - - isBottomAlignedWith(Matcher<View> matcher) - -
    - Returns a ViewAssertion that asserts that view displayed is completely + + +

    + +
    + + + static + + + ViewAssertion + + + isBottomAlignedWith(Matcher<View> matcher) + + +

    Returns a ViewAssertion that asserts that view displayed is completely aligned to bottom with the view matching the given matcher. - - - - - -

    - - - - static - - ViewAssertion - - isLeftAlignedWith(Matcher<View> matcher) - -
    - Returns a ViewAssertion that asserts that view displayed is completely aligned + + +

    + +
    + + + static + + + ViewAssertion + + + isLeftAlignedWith(Matcher<View> matcher) + + +

    Returns a ViewAssertion that asserts that view displayed is completely aligned to the left as the view matching the given matcher. - - - - - -

    - - - - static - - ViewAssertion - - isLeftOf(Matcher<View> matcher) - -
    - Returns a ViewAssertion that asserts that view displayed is completely left of + + +

    + +
    + + + static + + + ViewAssertion + + + isLeftOf(Matcher<View> matcher) + + +

    Returns a ViewAssertion that asserts that view displayed is completely left of the view matching the given matcher. - - - - - -

    - - - - static - - ViewAssertion - - isRightAlignedWith(Matcher<View> matcher) - -
    - Returns a ViewAssertion that asserts that view displayed is completely aligned + + +

    + +
    + + + static + + + ViewAssertion + + + isRightAlignedWith(Matcher<View> matcher) + + +

    Returns a ViewAssertion that asserts that view displayed is completely aligned to the right as the view matching the given matcher. - - - - - -

    - - - - static - - ViewAssertion - - isRightOf(Matcher<View> matcher) - -
    - Returns a ViewAssertion that asserts that view displayed is completely right of + + +

    + +
    + + + static + + + ViewAssertion + + + isRightOf(Matcher<View> matcher) + + +

    Returns a ViewAssertion that asserts that view displayed is completely right of the view matching the given matcher. - - - - - -

    - - - - static - - ViewAssertion - - isTopAlignedWith(Matcher<View> matcher) - -
    - Returns a ViewAssertion that asserts that view displayed is completely + + +

    + +
    + + + static + + + ViewAssertion + + + isTopAlignedWith(Matcher<View> matcher) + + +

    Returns a ViewAssertion that asserts that view displayed is completely aligned to top with the view matching the given matcher. - - - - - -

    @@ -927,207 +534,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1136,16 +812,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1171,427 +837,459 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - ViewAssertion - - isAbove - (Matcher<View> matcher) -

    -
    -
    - - +
    +

    isAbove

    +
    +
    + + -
    -
    - - - - -

    Returns an Assertion that asserts that view displayed is completely above - the view matching the given matcher.

    -
    -
    Throws
    - + +
    +ViewAssertion isAbove (Matcher<View> matcher)
    + + + + +

    Returns an Assertion that asserts that view displayed is completely above + the view matching the given matcher.

    +
    + + + + + +
    Parameters
    matcher + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    + + - + + - + + - +
    Throws
    - if there is more than 1 pixel of vertical overlap.if there is more than 1 pixel of vertical overlap.
    AmbiguousViewMatcherException - if more than one view matches the given matcher.AmbiguousViewMatcherExceptionif more than one view matches the given matcher.
    NoMatchingViewException - if no views match the given matcher. + NoMatchingViewExceptionif no views match the given matcher.
    -
    + -
    -
    -

    - - public - static - - - - ViewAssertion - - isBelow - (Matcher<View> matcher) -

    -
    -
    - - - -
    -
    +
    +

    isBelow

    +
    +
    + + - - - -

    Returns a ViewAssertion that asserts that view displayed is completely - below the view matching the given matcher.

    -
    -
    Throws
    - + +
    +ViewAssertion isBelow (Matcher<View> matcher)
    + + + + +

    Returns a ViewAssertion that asserts that view displayed is completely + below the view matching the given matcher.

    +
    + + + + + +
    Parameters
    matcher + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    + + - + + - + + - +
    Throws
    - if there is more than 1 pixel of vertical overlap.if there is more than 1 pixel of vertical overlap.
    AmbiguousViewMatcherException - if more than one view matches the given matcher.AmbiguousViewMatcherExceptionif more than one view matches the given matcher.
    NoMatchingViewException - if no views match the given matcher. + NoMatchingViewExceptionif no views match the given matcher.
    -
    + -
    -
    -

    - - public - static - - - - ViewAssertion - - isBottomAlignedWith - (Matcher<View> matcher) -

    -
    -
    - - - -
    -
    - - +
    +

    isBottomAlignedWith

    +
    +
    + + +
    +
    +ViewAssertion isBottomAlignedWith (Matcher<View> matcher)
    + + -

    Returns a ViewAssertion that asserts that view displayed is completely + +

    Returns a ViewAssertion that asserts that view displayed is completely aligned to bottom with the view matching the given matcher.

    The bottom 'y' coordinate of the view displayed must equal the bottom 'y' - coordinate of the view matching the given matcher.

    -
    -
    Throws
    - + coordinate of the view matching the given matcher.

    +
    + + + + + +
    Parameters
    matcher + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    + + - + + - + + - +
    Throws
    - if the views are not aligned bottom.if the views are not aligned bottom.
    AmbiguousViewMatcherException - if more than one view matches the given matcher.AmbiguousViewMatcherExceptionif more than one view matches the given matcher.
    NoMatchingViewException - if no views match the given matcher. + NoMatchingViewExceptionif no views match the given matcher.
    -
    + -
    -
    -

    - - public - static - - - - ViewAssertion - - isLeftAlignedWith - (Matcher<View> matcher) -

    -
    -
    - - - -
    -
    - - +
    +

    isLeftAlignedWith

    +
    +
    + + +
    +
    +ViewAssertion isLeftAlignedWith (Matcher<View> matcher)
    + + -

    Returns a ViewAssertion that asserts that view displayed is completely aligned + +

    Returns a ViewAssertion that asserts that view displayed is completely aligned to the left as the view matching the given matcher.

    The left 'x' coordinate of the view displayed must equal the left 'x' - coordinate of the view matching the given matcher.

    -
    -
    Throws
    - + coordinate of the view matching the given matcher.

    +
    + + + + + +
    Parameters
    matcher + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    + + - + + - + + - +
    Throws
    - if the views are not aligned to the left.if the views are not aligned to the left.
    AmbiguousViewMatcherException - if more than one view matches the given matcher.AmbiguousViewMatcherExceptionif more than one view matches the given matcher.
    NoMatchingViewException - if no views match the given matcher. + NoMatchingViewExceptionif no views match the given matcher.
    -
    + -
    -
    -

    - - public - static - - - - ViewAssertion - - isLeftOf - (Matcher<View> matcher) -

    -
    -
    - - - -
    -
    - - +
    +

    isLeftOf

    +
    +
    + + - -

    Returns a ViewAssertion that asserts that view displayed is completely left of - the view matching the given matcher.

    -
    -
    Throws
    - + +
    +ViewAssertion isLeftOf (Matcher<View> matcher)
    + + + + +

    Returns a ViewAssertion that asserts that view displayed is completely left of + the view matching the given matcher.

    +
    + + + + + +
    Parameters
    matcher + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    + + - + + - + + - +
    Throws
    - if there is more than 1 pixel of horizontal overlap.if there is more than 1 pixel of horizontal overlap.
    AmbiguousViewMatcherException - if more than one view matches the given matcher.AmbiguousViewMatcherExceptionif more than one view matches the given matcher.
    NoMatchingViewException - if no views match the given matcher. + NoMatchingViewExceptionif no views match the given matcher.
    -
    + -
    -
    -

    - - public - static - - - - ViewAssertion - - isRightAlignedWith - (Matcher<View> matcher) -

    -
    -
    - - - -
    -
    - - +
    +

    isRightAlignedWith

    +
    +
    + + +
    +
    +ViewAssertion isRightAlignedWith (Matcher<View> matcher)
    + + -

    Returns a ViewAssertion that asserts that view displayed is completely aligned + +

    Returns a ViewAssertion that asserts that view displayed is completely aligned to the right as the view matching the given matcher.

    The right 'x' coordinate of the view displayed must equal the right 'x' - coordinate of the view matching the given matcher.

    -
    -
    Throws
    - + coordinate of the view matching the given matcher.

    +
    + + + + + +
    Parameters
    matcher + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    + + - + + - + + - +
    Throws
    - if the views are not aligned to the right.if the views are not aligned to the right.
    AmbiguousViewMatcherException - if more than one view matches the given matcher.AmbiguousViewMatcherExceptionif more than one view matches the given matcher.
    NoMatchingViewException - if no views match the given matcher. + NoMatchingViewExceptionif no views match the given matcher.
    -
    + -
    -
    -

    - - public - static - - - - ViewAssertion - - isRightOf - (Matcher<View> matcher) -

    -
    -
    - - - -
    -
    - - - +
    +

    isRightOf

    +
    +
    + + -

    Returns a ViewAssertion that asserts that view displayed is completely right of - the view matching the given matcher.

    -
    -
    Throws
    - + +
    +ViewAssertion isRightOf (Matcher<View> matcher)
    + + + + +

    Returns a ViewAssertion that asserts that view displayed is completely right of + the view matching the given matcher.

    +
    + + + + + +
    Parameters
    matcher + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    + + - + + - + + - +
    Throws
    - if there is more than 1 pixel of horizontal overlap.if there is more than 1 pixel of horizontal overlap.
    AmbiguousViewMatcherException - if more than one view matches the given matcher.AmbiguousViewMatcherExceptionif more than one view matches the given matcher.
    NoMatchingViewException - if no views match the given matcher. + NoMatchingViewExceptionif no views match the given matcher.
    -
    + -
    -
    -

    - - public - static - - - - ViewAssertion - - isTopAlignedWith - (Matcher<View> matcher) -

    -
    -
    - - - -
    -
    - - +
    +

    isTopAlignedWith

    +
    +
    + + +
    +
    +ViewAssertion isTopAlignedWith (Matcher<View> matcher)
    + + -

    Returns a ViewAssertion that asserts that view displayed is completely + +

    Returns a ViewAssertion that asserts that view displayed is completely aligned to top with the view matching the given matcher.

    The top 'y' coordinate of the view displayed must equal the top 'y' - coordinate of the view matching the given matcher.

    -
    -
    Throws
    - + coordinate of the view matching the given matcher.

    +
    + + + + + +
    Parameters
    matcher + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    + + - + + - + + - +
    Throws
    - if the views are not aligned top.if the views are not aligned top.
    AmbiguousViewMatcherException - if more than one view matches the given matcher.AmbiguousViewMatcherExceptionif more than one view matches the given matcher.
    NoMatchingViewException - if no views match the given matcher. + NoMatchingViewExceptionif no views match the given matcher.
    -
    + -
    @@ -1603,193 +1301,30 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/assertion/ViewAssertions.html b/docs/html/reference/android/support/test/espresso/assertion/ViewAssertions.html index b22bcd7acdb9..06a9132bcb7f 100644 --- a/docs/html/reference/android/support/test/espresso/assertion/ViewAssertions.html +++ b/docs/html/reference/android/support/test/espresso/assertion/ViewAssertions.html @@ -1,4 +1,3 @@ - @@ -93,483 +92,85 @@ - - - - - - -ViewAssertions | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ViewAssertions - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ViewAssertions

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    ViewAssertions

    +

    + + public + + final + + class + ViewAssertions + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.assertion.ViewAssertions
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.assertion.ViewAssertions +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of common ViewAssertions. +

    A collection of common ViewAssertions.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -721,81 +295,94 @@ Summary: - - - - +
    Public Methods
    + - - - + + + + + - - - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + - + + +

    + + + +

    Public methods

    - - static - - ViewAssertion - - doesNotExist() - -
    - Returns an assert that ensures the view matcher does not find any matching view in the + +
    + + + static + + + ViewAssertion + + + doesNotExist() + + +

    Returns an assert that ensures the view matcher does not find any matching view in the hierarchy. - - - - - -

    - - - - static - - ViewAssertion - - matches(Matcher<? super View> viewMatcher) - -
    - Returns a generic ViewAssertion that asserts that a view exists in the view hierarchy + + +

    + +
    + + + static + + + ViewAssertion + + + matches(Matcher<? super View> viewMatcher) + + +

    Returns a generic ViewAssertion that asserts that a view exists in the view hierarchy and is matched by the given view matcher. - - - - - -

    - - - - static - - ViewAssertion - - selectedDescendantsMatch(Matcher<View> selector, Matcher<View> matcher) - -
    - Returns a generic ViewAssertion that asserts that the descendant views selected by the + + +

    + +
    + + + static + + + ViewAssertion + + + selectedDescendantsMatch(Matcher<View> selector, Matcher<View> matcher) + + +

    Returns a generic ViewAssertion that asserts that the descendant views selected by the selector match the specified matcher. - - - - - -

    @@ -807,207 +394,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1016,16 +672,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1051,112 +697,125 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - ViewAssertion - - doesNotExist - () -

    -
    -
    - - - -
    -
    - - +
    +

    doesNotExist

    +
    +
    + + +
    +
    +ViewAssertion doesNotExist ()
    + + -

    Returns an assert that ensures the view matcher does not find any matching view in the + +

    Returns an assert that ensures the view matcher does not find any matching view in the hierarchy. -

    +

    + + + + + + +
    Returns
    ViewAssertion
    -
    -
    -

    - - public - static - - - - ViewAssertion - - matches - (Matcher<? super View> viewMatcher) -

    -
    -
    - - - -
    -
    - - +
    +

    matches

    +
    +
    + + +
    +
    +ViewAssertion matches (Matcher<? super View> viewMatcher)
    + + -

    Returns a generic ViewAssertion that asserts that a view exists in the view hierarchy + +

    Returns a generic ViewAssertion that asserts that a view exists in the view hierarchy and is matched by the given view matcher. -

    +

    + + + + + + +
    Parameters
    viewMatcher + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    -
    -
    -

    - - public - static - - - - ViewAssertion - - selectedDescendantsMatch - (Matcher<View> selector, Matcher<View> matcher) -

    -
    -
    - - +
    +

    selectedDescendantsMatch

    +
    +
    + + -
    -
    - - - - -

    Returns a generic ViewAssertion that asserts that the descendant views selected by the +

    +
    +ViewAssertion selectedDescendantsMatch (Matcher<View> selector, 
    +                Matcher<View> matcher)
    + + + + +

    Returns a generic ViewAssertion that asserts that the descendant views selected by the selector match the specified matcher. Example: onView(rootView).check(selectedDescendantsMatch( not(isAssignableFrom(TextView.class)), hasContentDescription())); -

    +

    + + + + + + + + + + +
    Parameters
    selector + Matcher +
    matcher + Matcher +
    + + + + + + +
    Returns
    ViewAssertion
    -
    @@ -1168,193 +827,30 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/assertion/package-summary.html b/docs/html/reference/android/support/test/espresso/assertion/package-summary.html index 708e955b5cc8..6f8d42a11117 100644 --- a/docs/html/reference/android/support/test/espresso/assertion/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/assertion/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,744 +92,148 @@ - - - - - - -android.support.test.espresso.assertion | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.assertion - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.assertion

    -
    - -
    - -
    - - - +

    android.support.test.espresso.assertion

    + + +

    Classes

    -
    - - + + - + - + - - + + - + + + + + + + + + +
    LayoutAssertionsLayoutAssertions - A collection of layout ViewAssertions.  - - + A collection of layout ViewAssertions.  + +
    PositionAssertionsPositionAssertions - A collection of ViewAssertions for checking relative position of elements on the screen.  - + A collection of ViewAssertions for checking relative position of elements on the screen.  + + +
    ViewAssertions + A collection of common ViewAssertions.  + +
    + -
    ViewAssertions - A collection of common ViewAssertions.  + -
    + -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/base/ActiveRootLister.html b/docs/html/reference/android/support/test/espresso/base/ActiveRootLister.html index 768e6f12abf8..94d8ce9ce51c 100644 --- a/docs/html/reference/android/support/test/espresso/base/ActiveRootLister.html +++ b/docs/html/reference/android/support/test/espresso/base/ActiveRootLister.html @@ -1,5 +1,3 @@ - - @@ -93,579 +91,137 @@ - - - - - - -ActiveRootLister | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    - -
    + + + + + + + + + + + - -
    + + + + -
    -
    +ActiveRootLister - -
    - public + + + - interface -

    ActiveRootLister

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    ActiveRootLister

    +

    + + public + + + + interface + ActiveRootLister + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.espresso.base.ActiveRootLister
    android.support.test.espresso.base.ActiveRootLister +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Provides access to all root views in an application. +

    Provides access to all root views in an application.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -694,32 +250,37 @@ type="text/css"> - - - - +
    Public Methods
    + - - - - + + + + + + + + +

    Public methods

    - abstract - - - List<Root> - - listActiveRoots() - -
    - Lists the active roots in an application at this moment. - - - -
    - -
    + abstract + + + + + List<Root> + + + listActiveRoots() + + +

    Lists the active roots in an application at this moment. + + +

    + +
    @@ -730,16 +291,6 @@ type="text/css"> -
    - - - - - - - - - @@ -765,53 +316,44 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - List<Root> - - listActiveRoots - () -

    -
    -
    - - +
    +

    listActiveRoots

    +
    +
    + + -
    -
    - - - - -

    Lists the active roots in an application at this moment.

    -
    -
    Returns
    -
    • a list of all the active roots in the application.
    -
    -
    -
    Throws
    - + +
    +List<Root> listActiveRoots ()
    + + + + +

    Lists the active roots in an application at this moment.

    +
    + + + + + +
    Returns
    List<Root>a list of all the active roots in the application.
    + + - +
    Throws
    IllegalStateException - if invoked from a thread besides the main thread. + IllegalStateExceptionif invoked from a thread besides the main thread.
    -
    + -
    @@ -823,193 +365,45 @@ type="text/css"> - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/base/BaseLayerModule.FailureHandlerHolder.html b/docs/html/reference/android/support/test/espresso/base/BaseLayerModule.FailureHandlerHolder.html index e2ab59ea5f0a..fea9cd5453bf 100644 --- a/docs/html/reference/android/support/test/espresso/base/BaseLayerModule.FailureHandlerHolder.html +++ b/docs/html/reference/android/support/test/espresso/base/BaseLayerModule.FailureHandlerHolder.html @@ -1,4 +1,3 @@ - @@ -93,498 +92,85 @@ - - - - - - -BaseLayerModule.FailureHandlerHolder | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +BaseLayerModule.FailureHandlerHolder - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - class -

    BaseLayerModule.FailureHandlerHolder

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    BaseLayerModule.FailureHandlerHolder

    +

    + + public + static + + + class + BaseLayerModule.FailureHandlerHolder + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.base.BaseLayerModule.FailureHandlerHolder
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.base.BaseLayerModule.FailureHandlerHolder +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Holder for AtomicReference which allows updating it at runtime. +

    Holder for AtomicReference which allows updating it at runtime.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -735,25 +294,23 @@ Summary: - +
    Public Constructors
    + - - - - - + + + + + + +

    Public constructors

    - - - - - - - - BaseLayerModule.FailureHandlerHolder(FailureHandler defaultHandler) - -
    + + BaseLayerModule.FailureHandlerHolder(FailureHandler defaultHandler) + + +
    @@ -764,41 +321,54 @@ Summary: - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - FailureHandler - - get() - -
    - - - - - - void - - update(FailureHandler handler) - -
    + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + FailureHandler + + + get() + + +
    + + + + + + void + + + update(FailureHandler handler) + + +
    @@ -810,207 +380,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1019,16 +658,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1046,39 +675,37 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - BaseLayerModule.FailureHandlerHolder - (FailureHandler defaultHandler) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    BaseLayerModule.FailureHandlerHolder

    +
    +
    + +
    +
    +BaseLayerModule.FailureHandlerHolder (FailureHandler defaultHandler)
    + + + + +

    + + + + + + +
    Parameters
    defaultHandler + FailureHandler +
    +
    @@ -1093,71 +720,65 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - FailureHandler - - get - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    get

    +
    +
    + +
    +
    +FailureHandler get ()
    + + + + +

    + + + + + + +
    Returns
    FailureHandler
    +
    -
    -

    - - public - - - - - void - - update - (FailureHandler handler) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    update

    +
    +
    + +
    +
    +void update (FailureHandler handler)
    + + + + +

    + + + + + + +
    Parameters
    handler + FailureHandler +
    +
    @@ -1169,193 +790,45 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/base/BaseLayerModule.html b/docs/html/reference/android/support/test/espresso/base/BaseLayerModule.html index 0ed54af27c58..d77e70ffb676 100644 --- a/docs/html/reference/android/support/test/espresso/base/BaseLayerModule.html +++ b/docs/html/reference/android/support/test/espresso/base/BaseLayerModule.html @@ -1,4 +1,3 @@ - @@ -93,498 +92,85 @@ - - - - - - -BaseLayerModule | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +BaseLayerModule - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    BaseLayerModule

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    BaseLayerModule

    +

    + + public + + + + class + BaseLayerModule + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.base.BaseLayerModule
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.base.BaseLayerModule +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Dagger module for creating the implementation classes within the base package. +

    Dagger module for creating the implementation classes within the base package.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - classBaseLayerModule.FailureHandlerHolder
    + + + + + + - - + + @@ -763,25 +323,23 @@ Summary: -

    Nested classes

    + + + + + class - Holder for AtomicReference which allows updating it at runtime.  - - - + BaseLayerModule.FailureHandlerHolder +

    Holder for AtomicReference which allows updating it at runtime.  + + +

    - - - - - -
    Public Constructors
    + + - - - - - - + + + + + + +

    Public constructors

    - BaseLayerModule() - -
    + + BaseLayerModule() + + +
    @@ -792,153 +350,208 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - ActiveRootLister - - provideActiveRootLister(RootsOracle rootsOracle) - -
    - - - - - - AsyncTaskPoolMonitor - - provideCompatAsyncTaskMonitor(ThreadPoolExecutorExtractor extractor) - -
    - - - - - - EventInjector - - provideEventInjector() - -
    - - - - - - ActivityLifecycleMonitor - - provideLifecycleMonitor() - -
    - - - - - - Looper - - provideMainLooper() - -
    - - - - - - Executor - - provideMainThreadExecutor(Looper mainLooper) - -
    - - - - - - Recycler - - provideRecycler() - -
    - - - - - - AsyncTaskPoolMonitor - - provideSdkAsyncTaskMonitor(ThreadPoolExecutorExtractor extractor) - -
    - - - - - - Context - - provideTargetContext() - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + ActiveRootLister + + + provideActiveRootLister(RootsOracle rootsOracle) + + +
    + + + + + + AsyncTaskPoolMonitor + + + provideCompatAsyncTaskMonitor(ThreadPoolExecutorExtractor extractor) + + +
    + + + + + + EventInjector + + + provideEventInjector() + + +
    + + + + + + ActivityLifecycleMonitor + + + provideLifecycleMonitor() + + +
    + + + + + + Looper + + + provideMainLooper() + + +
    + + + + + + Executor + + + provideMainThreadExecutor(Looper mainLooper) + + +
    + + + + + + Recycler + + + provideRecycler() + + +
    + + + + + + AsyncTaskPoolMonitor + + + provideSdkAsyncTaskMonitor(ThreadPoolExecutorExtractor extractor) + + +
    + + + + + + Context + + + provideTargetContext() + + +
    @@ -950,207 +563,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1159,16 +841,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1186,39 +858,28 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - BaseLayerModule - () -

    -
    -
    - - - -
    -
    - - +
    +

    BaseLayerModule

    +
    +
    + + +
    +
    +BaseLayerModule ()
    + + -

    + +

    -
    @@ -1233,295 +894,295 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - ActiveRootLister - - provideActiveRootLister - (RootsOracle rootsOracle) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    provideActiveRootLister

    +
    +
    + +
    +
    +ActiveRootLister provideActiveRootLister (RootsOracle rootsOracle)
    + + + + +

    + + + + + + +
    Parameters
    rootsOracle + RootsOracle +
    + + + + + + +
    Returns
    ActiveRootLister
    +
    -
    -

    - - public - - - - - AsyncTaskPoolMonitor - - provideCompatAsyncTaskMonitor - (ThreadPoolExecutorExtractor extractor) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    provideCompatAsyncTaskMonitor

    +
    +
    + +
    +
    +AsyncTaskPoolMonitor provideCompatAsyncTaskMonitor (ThreadPoolExecutorExtractor extractor)
    + + + + +

    + + + + + + +
    Parameters
    extractor + ThreadPoolExecutorExtractor +
    + + + + + + +
    Returns
    AsyncTaskPoolMonitor
    +
    -
    -

    - - public - - - - - EventInjector - - provideEventInjector - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    provideEventInjector

    +
    +
    + +
    +
    +EventInjector provideEventInjector ()
    + + + + +

    + + + + + + +
    Returns
    EventInjector
    +
    -
    -

    - - public - - - - - ActivityLifecycleMonitor - - provideLifecycleMonitor - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    provideLifecycleMonitor

    +
    +
    + +
    +
    +ActivityLifecycleMonitor provideLifecycleMonitor ()
    + + + + +

    + + + + + + +
    Returns
    ActivityLifecycleMonitor
    +
    -
    -

    - - public - - - - - Looper - - provideMainLooper - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    provideMainLooper

    +
    +
    + +
    +
    +Looper provideMainLooper ()
    + + + + +

    + + + + + + +
    Returns
    Looper
    +
    -
    -

    - - public - - - - - Executor - - provideMainThreadExecutor - (Looper mainLooper) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    provideMainThreadExecutor

    +
    +
    + +
    +
    +Executor provideMainThreadExecutor (Looper mainLooper)
    + + + + +

    + + + + + + +
    Parameters
    mainLooper + Looper +
    + + + + + + +
    Returns
    Executor
    +
    -
    -

    - - public - - - - - Recycler - - provideRecycler - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    provideRecycler

    +
    +
    + +
    +
    +Recycler provideRecycler ()
    + + + + +

    + + + + + + +
    Returns
    Recycler
    +
    -
    -

    - - public - - - - - AsyncTaskPoolMonitor - - provideSdkAsyncTaskMonitor - (ThreadPoolExecutorExtractor extractor) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    provideSdkAsyncTaskMonitor

    +
    +
    + +
    +
    +AsyncTaskPoolMonitor provideSdkAsyncTaskMonitor (ThreadPoolExecutorExtractor extractor)
    + + + + +

    + + + + + + +
    Parameters
    extractor + ThreadPoolExecutorExtractor +
    + + + + + + +
    Returns
    AsyncTaskPoolMonitor
    +
    -
    -

    - - public - - - - - Context - - provideTargetContext - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    provideTargetContext

    +
    +
    + +
    +
    +Context provideTargetContext ()
    + + + + +

    + + + + + + +
    Returns
    Context
    +
    @@ -1533,193 +1194,45 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/base/Default.html b/docs/html/reference/android/support/test/espresso/base/Default.html index d19184cc876d..a4a9689b6fb5 100644 --- a/docs/html/reference/android/support/test/espresso/base/Default.html +++ b/docs/html/reference/android/support/test/espresso/base/Default.html @@ -1,4 +1,3 @@ - @@ -93,498 +92,85 @@ - - - - - - -Default | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    - -
    + + +
    +
    +
    + + + +
    + + + + + + -
    - - - - -
    +
    -
    - public - - - abstract - @interface -

    Default

    - - - - - +

    Default

    +

    + + public + + + abstract + @interface + Default + +
    + + + + + implements - + Annotation + + + + +

    - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.base.Default
    android.support.test.espresso.base.Default +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Annotates a default provider. +

    Annotates a default provider.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -729,95 +285,122 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -826,16 +409,6 @@ From interface

    Inherited methods

    - -From interface - - java.lang.annotation.Annotation + + From +interface + + + java.lang.annotation.Annotation + +
    -
    - - - - - - - - - @@ -868,193 +441,45 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/base/DefaultFailureHandler.html b/docs/html/reference/android/support/test/espresso/base/DefaultFailureHandler.html index cd58415696b9..2e94150681f8 100644 --- a/docs/html/reference/android/support/test/espresso/base/DefaultFailureHandler.html +++ b/docs/html/reference/android/support/test/espresso/base/DefaultFailureHandler.html @@ -1,4 +1,3 @@ - @@ -93,505 +92,92 @@ - - - - - - -DefaultFailureHandler | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +DefaultFailureHandler - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    DefaultFailureHandler

    - - - - - extends Object
    - - - - - - +

    DefaultFailureHandler

    +

    + + public + + final + + class + DefaultFailureHandler + +
    + + + + + extends Object + + + + + + + + implements - - FailureHandler - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + FailureHandler + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.base.DefaultFailureHandler
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.base.DefaultFailureHandler +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Espresso's default FailureHandler. If this does not fit your needs, feel free to provide +

    Espresso's default FailureHandler. If this does not fit your needs, feel free to provide your own implementation via Espresso.setFailureHandler(FailureHandler).

    @@ -703,27 +280,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -748,25 +307,23 @@ Summary: - - - - - - - - - + + - - - - - - - - - - - - - - - - - - -
    Public Constructors
    + + - - - - - - + + + + + + +

    Public constructors

    - DefaultFailureHandler(Context appContext) - -
    + + DefaultFailureHandler(Context appContext) + + +
    @@ -777,33 +334,38 @@ Summary: - - - - - - - - - - - + -
    Public Methods
    - - - - - - void - - handle(Throwable error, Matcher<View> viewMatcher) - -
    - Handle the given error in a manner that makes sense to the environment in which the test is + + + + + + + + + + + + - + + +

    + + + +

    Public methods

    + + + + + + void + + + handle(Throwable error, Matcher<View> viewMatcher) + + +

    Handle the given error in a manner that makes sense to the environment in which the test is executed (e.g. - - - - - -

    @@ -815,207 +377,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1023,49 +654,57 @@ From class - @@ -1074,16 +713,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.FailureHandler + + From +interface + + + android.support.test.espresso.FailureHandler + +
    -
    - - - - - - - - - @@ -1101,39 +730,37 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - DefaultFailureHandler - (Context appContext) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    DefaultFailureHandler

    +
    +
    + +
    +
    +DefaultFailureHandler (Context appContext)
    + + + + +

    + + + + + + +
    Parameters
    appContext + Context +
    +
    @@ -1148,42 +775,47 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - void - - handle - (Throwable error, Matcher<View> viewMatcher) -

    -
    -
    +
    +

    handle

    +
    +
    + + - - -
    -
    - - - - -

    Handle the given error in a manner that makes sense to the environment in which the test is +

    +
    +void handle (Throwable error, 
    +                Matcher<View> viewMatcher)
    + + + + +

    Handle the given error in a manner that makes sense to the environment in which the test is executed (e.g. take a screenshot, output extra debug info, etc). Upon handling, most handlers will choose to propagate the error. -

    +

    + + + + + + + + + + +
    Parameters
    error + Throwable +
    viewMatcher + Matcher +
    -
    @@ -1195,193 +827,45 @@ From interface - -
    - -
    - -
    - - -
    - -
    - + + diff --git a/docs/html/reference/android/support/test/espresso/base/IdlingResourceRegistry.html b/docs/html/reference/android/support/test/espresso/base/IdlingResourceRegistry.html index f2b24b9401e7..94654b8bbbf1 100644 --- a/docs/html/reference/android/support/test/espresso/base/IdlingResourceRegistry.html +++ b/docs/html/reference/android/support/test/espresso/base/IdlingResourceRegistry.html @@ -1,4 +1,3 @@ - @@ -93,498 +92,85 @@ - - - - - - -IdlingResourceRegistry | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +IdlingResourceRegistry - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    IdlingResourceRegistry

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    IdlingResourceRegistry

    +

    + + public + + final + + class + IdlingResourceRegistry + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.base.IdlingResourceRegistry
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.base.IdlingResourceRegistry +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Keeps track of user-registered IdlingResources. +

    Keeps track of user-registered IdlingResources.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -735,25 +294,23 @@ Summary: - - - - - - - @@ -1043,16 +684,6 @@ From interface
    Public Constructors
    + + - - - - - - + + + + + + +

    Public constructors

    - IdlingResourceRegistry(Looper looper) - -
    + + IdlingResourceRegistry(Looper looper) + + +
    @@ -764,94 +321,113 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - List<IdlingResource> - - getResources() - -
    - Returns a list of all currently registered IdlingResources. - - - -
    - -
    - - - - - - void - - registerLooper(Looper looper, boolean considerWaitIdle) - -
    - - - - - - boolean - - registerResources(List<? extends IdlingResource> resourceList) - -
    - Registers the given resources. - - - -
    - -
    - - - - - - boolean - - unregisterResources(List<? extends IdlingResource> resourceList) - -
    - Unregisters the given resources. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + List<IdlingResource> + + + getResources() + + +

    Returns a list of all currently registered IdlingResources. + + +

    + +
    + + + + + + void + + + registerLooper(Looper looper, boolean considerWaitIdle) + + +
    + + + + + + boolean + + + registerResources(List<? extends IdlingResource> resourceList) + + +

    Registers the given resources. + + +

    + +
    + + + + + + boolean + + + unregisterResources(List<? extends IdlingResource> resourceList) + + +

    Unregisters the given resources. + + +

    + +
    @@ -863,207 +439,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1072,16 +717,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1099,39 +734,37 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - IdlingResourceRegistry - (Looper looper) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    IdlingResourceRegistry

    +
    +
    + +
    +
    +IdlingResourceRegistry (Looper looper)
    + + + + +

    + + + + + + +
    Parameters
    looper + Looper +
    +
    @@ -1146,153 +779,152 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - List<IdlingResource> - - getResources - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a list of all currently registered IdlingResources. - This method is safe to call from any thread.

    -
    -
    Returns
    - -
    +
    +

    getResources

    +
    +
    + +
    +
    +List<IdlingResource> getResources ()
    + + + + +

    Returns a list of all currently registered IdlingResources. + This method is safe to call from any thread.

    + + + + + + +
    Returns
    List<IdlingResource>an ImmutableList of IdlingResources. +
    +
    -
    -

    - - public - - - - - void - - registerLooper - (Looper looper, boolean considerWaitIdle) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    registerLooper

    +
    +
    + +
    +
    +void registerLooper (Looper looper, 
    +                boolean considerWaitIdle)
    + + + + +

    + + + + + + + + + + +
    Parameters
    looper + Looper +
    considerWaitIdle + boolean +
    +
    -
    -

    - - public - - - - - boolean - - registerResources - (List<? extends IdlingResource> resourceList) -

    -
    -
    - - - -
    -
    - - - - -

    Registers the given resources. If any of the given resources are already - registered, a warning is logged.

    -
    -
    Returns
    -
    • true if all resources were successfully registered -
    -
    +
    +

    registerResources

    +
    +
    + +
    +
    +boolean registerResources (List<? extends IdlingResource> resourceList)
    + + + + +

    Registers the given resources. If any of the given resources are already + registered, a warning is logged.

    + + + + + + +
    Parameters
    resourceList + List +
    + + + + + + +
    Returns
    booleantrue if all resources were successfully registered +
    +
    -
    -

    - - public - - - - - boolean - - unregisterResources - (List<? extends IdlingResource> resourceList) -

    -
    -
    - - - -
    -
    - - - - -

    Unregisters the given resources. If any of the given resources are not already - registered, a warning is logged.

    -
    -
    Returns
    -
    • true if all resources were successfully unregistered -
    -
    +
    +

    unregisterResources

    +
    +
    + +
    +
    +boolean unregisterResources (List<? extends IdlingResource> resourceList)
    + + + + +

    Unregisters the given resources. If any of the given resources are not already + registered, a warning is logged.

    + + + + + + +
    Parameters
    resourceList + List +
    + + + + + + +
    Returns
    booleantrue if all resources were successfully unregistered +
    +
    @@ -1304,193 +936,45 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/base/MainThread.html b/docs/html/reference/android/support/test/espresso/base/MainThread.html index f5eb0b1b89da..93dd94f50261 100644 --- a/docs/html/reference/android/support/test/espresso/base/MainThread.html +++ b/docs/html/reference/android/support/test/espresso/base/MainThread.html @@ -1,4 +1,3 @@ - @@ -93,498 +92,85 @@ - - - - - - -MainThread | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    - -
    + + +
    +
    +
    + + + +
    + + + + + + -
    - - - - -
    +
    -
    - public - - - abstract - @interface -

    MainThread

    - - - - - +

    MainThread

    +

    + + public + + + abstract + @interface + MainThread + +
    + + + + + implements - + Annotation + + + + +

    - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.base.MainThread
    android.support.test.espresso.base.MainThread +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Annotates an Executor that executes tasks on the main thread +

    Annotates an Executor that executes tasks on the main thread

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -729,95 +285,122 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -826,16 +409,6 @@ From interface

    Inherited methods

    - -From interface - - java.lang.annotation.Annotation + + From +interface + + + java.lang.annotation.Annotation + +
    -
    - - - - - - - - - @@ -868,193 +441,45 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/base/RootViewPicker.html b/docs/html/reference/android/support/test/espresso/base/RootViewPicker.html index 902e6abf635e..bc665272c710 100644 --- a/docs/html/reference/android/support/test/espresso/base/RootViewPicker.html +++ b/docs/html/reference/android/support/test/espresso/base/RootViewPicker.html @@ -1,4 +1,3 @@ - @@ -93,505 +92,92 @@ - - - - - - -RootViewPicker | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +RootViewPicker - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    RootViewPicker

    - - - - - extends Object
    - - - - - - +

    RootViewPicker

    +

    + + public + + final + + class + RootViewPicker + +
    + + + + + extends Object + + + + + + + + implements - - Provider<T> - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + Provider<View> + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.base.RootViewPicker
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.base.RootViewPicker +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Provides the root View of the top-most Window, with which the user can interact. View is +

    Provides the root View of the top-most Window, with which the user can interact. View is guaranteed to be in a stable state - i.e. not pending any updates from the application. This provider can only be accessed from the main thread. @@ -702,27 +279,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -751,25 +310,32 @@ Summary: - - - - - - - - - +
    Public Methods
    - - - - - - View - - get() - -
    + + + + + + + + + + + + +

    Public methods

    + + + + + + View + + + get() + + +
    @@ -781,207 +347,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -989,41 +624,51 @@ From class - @@ -1032,16 +677,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - javax.inject.Provider + + From +interface + + + javax.inject.Provider + +
    -
    - - - - - - - - - @@ -1067,39 +702,35 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - View - - get - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    get

    +
    +
    + +
    +
    +View get ()
    + + + + +

    + + + + + + +
    Returns
    View
    +
    @@ -1111,193 +742,45 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/base/UiControllerModule.html b/docs/html/reference/android/support/test/espresso/base/UiControllerModule.html index 080a1294788f..9ef640130e3e 100644 --- a/docs/html/reference/android/support/test/espresso/base/UiControllerModule.html +++ b/docs/html/reference/android/support/test/espresso/base/UiControllerModule.html @@ -1,4 +1,3 @@ - @@ -93,498 +92,85 @@ - - - - - - -UiControllerModule | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +UiControllerModule - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    UiControllerModule

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    UiControllerModule

    +

    + + public + + + + class + UiControllerModule + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.base.UiControllerModule
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.base.UiControllerModule +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Dagger module for UiController. +

    Dagger module for UiController.

    -
    - - - - - - - - - - - - - - - - -
    -

    Summary

    +

    Summary

    @@ -735,25 +294,23 @@ Summary: - +
    Public Constructors
    + - - - - - + + + + + + +

    Public constructors

    - - - - - - - - UiControllerModule() - -
    + + UiControllerModule() + + +
    @@ -764,25 +321,32 @@ Summary: - - - - - - - - - +
    Public Methods
    - - - - - - UiController - - provideUiController(UiControllerImpl uiControllerImpl) - -
    + + + + + + + + + + + + +

    Public methods

    + + + + + + UiController + + + provideUiController(UiControllerImpl uiControllerImpl) + + +
    @@ -794,207 +358,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1003,16 +636,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1030,39 +653,28 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - UiControllerModule - () -

    -
    -
    - - - -
    -
    - - +
    +

    UiControllerModule

    +
    +
    + + +
    +
    +UiControllerModule ()
    + + -

    + +

    -
    @@ -1077,39 +689,44 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - UiController - - provideUiController - (UiControllerImpl uiControllerImpl) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    provideUiController

    +
    +
    + +
    +
    +UiController provideUiController (UiControllerImpl uiControllerImpl)
    + + + + +

    + + + + + + +
    Parameters
    uiControllerImpl + UiControllerImpl +
    + + + + + + +
    Returns
    UiController
    +
    @@ -1121,193 +738,45 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/base/ViewFinderImpl.html b/docs/html/reference/android/support/test/espresso/base/ViewFinderImpl.html index 75720eb99367..0a1a546f8077 100644 --- a/docs/html/reference/android/support/test/espresso/base/ViewFinderImpl.html +++ b/docs/html/reference/android/support/test/espresso/base/ViewFinderImpl.html @@ -1,4 +1,3 @@ - @@ -93,505 +92,92 @@ - - - - - - -ViewFinderImpl | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ViewFinderImpl - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ViewFinderImpl

    - - - - - extends Object
    - - - - - - +

    ViewFinderImpl

    +

    + + public + + final + + class + ViewFinderImpl + +
    + + + + + extends Object + + + + + + + + implements - - ViewFinder - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewFinder + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.base.ViewFinderImpl
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.base.ViewFinderImpl +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Implementation of ViewFinder. +

    Implementation of ViewFinder.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -748,32 +307,37 @@ Summary: - - - - - - - - - +
    Public Methods
    - - - - - - View - - getView() - -
    - Immediately locates a single view within the provided view hierarchy. - - - -
    - -
    + + + + + + + + + + + + +

    Public methods

    + + + + + + View + + + getView() + + +

    Immediately locates a single view within the provided view hierarchy. + + +

    + +
    @@ -785,207 +349,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -993,48 +626,56 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewFinder + + From +interface + + + android.support.test.espresso.ViewFinder + +
    -
    - - - - - - - - - @@ -1078,58 +709,49 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - View - - getView - () -

    -
    -
    - - - -
    -
    - +
    +

    getView

    +
    +
    + + - - -

    Immediately locates a single view within the provided view hierarchy. - - If multiple views match, or if no views match the appropriate exception is thrown.

    -
    -
    Returns
    -
    • A singular view which matches the matcher we were constructed with.
    -
    -
    -
    Throws
    - + +
    +View getView ()
    + + + + +

    Immediately locates a single view within the provided view hierarchy. + + If multiple views match, or if no views match the appropriate exception is thrown.

    +
    + + + + + +
    Returns
    ViewA singular view which matches the matcher we were constructed with.
    + + - + + - + +
    Throws
    AmbiguousViewMatcherException - AmbiguousViewMatcherException
    NoMatchingViewException - NoMatchingViewException
    -
    + -
    @@ -1141,193 +763,45 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/base/package-summary.html b/docs/html/reference/android/support/test/espresso/base/package-summary.html index 7762c8acb7b1..06d2a3bc5598 100644 --- a/docs/html/reference/android/support/test/espresso/base/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/base/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,857 +92,257 @@ - - - - - - -android.support.test.espresso.base | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.base - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.base

    -
    - -
    - -
    - +

    android.support.test.espresso.base

    +

    Annotations

    -
    - - + + - + - + - - + + - + - - + +
    DefaultDefault Annotates a default provider.  - - + +
    MainThreadMainThread Annotates an Executor that executes tasks on the main thread   - - + +
    -
    - - + +

    Interfaces

    -
    - - + + - + - + - - + +
    ActiveRootListerActiveRootLister Provides access to all root views in an application.  - - + +
    -
    - - + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + + + + + + + + + +
    BaseLayerModuleBaseLayerModule Dagger module for creating the implementation classes within the base package.  - - + +
    BaseLayerModule.FailureHandlerHolderBaseLayerModule.FailureHandlerHolder Holder for AtomicReference which allows updating it at runtime.  - - + +
    DefaultFailureHandlerDefaultFailureHandler - Espresso's default FailureHandler.  - - + Espresso's default FailureHandler.  + +
    IdlingResourceRegistryIdlingResourceRegistry - Keeps track of user-registered IdlingResources.  - - + Keeps track of user-registered IdlingResources.  + +
    RootViewPickerRootViewPicker Provides the root View of the top-most Window, with which the user can interact.  - - + +
    UiControllerModuleUiControllerModule Dagger module for UiController.  + + - +
    ViewFinderImpl + Implementation of ViewFinder.  + +
    + -
    ViewFinderImpl - Implementation of ViewFinder.  + -
    + - - - - - - - - - - - - - - - -
    - -
    - - - - - - - + + diff --git a/docs/html/reference/android/support/test/espresso/contrib/AccessibilityChecks.html b/docs/html/reference/android/support/test/espresso/contrib/AccessibilityChecks.html index ffe9828fa96d..1be712cb2404 100644 --- a/docs/html/reference/android/support/test/espresso/contrib/AccessibilityChecks.html +++ b/docs/html/reference/android/support/test/espresso/contrib/AccessibilityChecks.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,85 @@ - - - - - - -AccessibilityChecks | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +AccessibilityChecks - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    AccessibilityChecks

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    AccessibilityChecks

    +

    + + public + + final + + class + AccessibilityChecks + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.contrib.AccessibilityChecks
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.contrib.AccessibilityChecks +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A class to enable automated accessibility checks in Espresso tests. These checks will run +

    A class to enable automated accessibility checks in Espresso tests. These checks will run as a global ViewAssertion, and cover a variety of accessibility issues - (see LATEST to see which checks are run). + (see LATEST to see which checks are run).

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -731,48 +297,59 @@ Summary: - - - - - - - @@ -1315,16 +987,6 @@ From interface
    Public Methods
    + + - static - - ViewAssertion - - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - accessibilityAssertion() - -
    - - - - static - - AccessibilityValidator - - enable() - -
    - Enables accessibility checking as a global ViewAssertion in ViewActions. - - - -
    - -
    + + + static + + + ViewAssertion + + + accessibilityAssertion() + + +
    + + + static + + + AccessibilityValidator + + + enable() + + +

    Enables accessibility checking as a global ViewAssertion in ViewActions. + + +

    + +
    @@ -784,207 +361,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -993,16 +639,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1028,82 +664,66 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - ViewAssertion - - accessibilityAssertion - () -

    -
    -
    - - - -
    -
    - - - - -

    -
    -
    Returns
    -
    • the backing ViewAssertion that can be used to explicitly check accessibility -
    -
    +
    +

    accessibilityAssertion

    +
    +
    + +
    +
    +ViewAssertion accessibilityAssertion ()
    + + + + +

    + + + + + + +
    Returns
    ViewAssertionthe backing ViewAssertion that can be used to explicitly check accessibility +
    +
    -
    -

    - - public - static - - - - AccessibilityValidator - - enable - () -

    -
    -
    +
    +

    enable

    +
    +
    + + - - -
    -
    - - - - -

    Enables accessibility checking as a global ViewAssertion in ViewActions.

    -
    -
    Returns
    -
    +
    +AccessibilityValidator enable ()
    + + + + +

    Enables accessibility checking as a global ViewAssertion in ViewActions.

    + + + + + + +
    Returns
    AccessibilityValidatorthe backing AccessibilityValidator, on which options for check execution can be set - - +
    -
    @@ -1115,193 +735,39 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    + + diff --git a/docs/html/reference/android/support/test/espresso/contrib/CountingIdlingResource.html b/docs/html/reference/android/support/test/espresso/contrib/CountingIdlingResource.html index c5fef674bb1c..0837d0a97ebd 100644 --- a/docs/html/reference/android/support/test/espresso/contrib/CountingIdlingResource.html +++ b/docs/html/reference/android/support/test/espresso/contrib/CountingIdlingResource.html @@ -1,4 +1,3 @@ - @@ -93,498 +92,92 @@ - - - - - - -CountingIdlingResource | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +CountingIdlingResource - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    CountingIdlingResource

    - - - - - extends Object
    - - - - - - +

    CountingIdlingResource

    +

    + + public + + final + + class + CountingIdlingResource + +
    + + + + + extends Object + + + + + + + + implements - - IdlingResource - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + IdlingResource + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.contrib.CountingIdlingResource
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.contrib.CountingIdlingResource +
    + + +

    +

    + This class is deprecated.
    + Use CountingIdlingResource instead. + This class has been moved to a different module to avoid a dependency on espresso-contrib in your + production code. This class will be removed in a future release. +

    - - -
    - - -

    Class Overview

    -

    An implementation of IdlingResource that determines idleness by maintaining an internal +

    An implementation of IdlingResource that determines idleness by maintaining an internal counter. When the counter is 0 - it is considered to be idle, when it is non-zero it is not - idle. This is very similar to the way a Semaphore behaves. + idle. This is very similar to the way a Semaphore behaves.

    The counter may be incremented or decremented from any thread. If it reaches an illogical state (like counter less than zero) it will throw an IllegalStateException. @@ -704,7 +295,7 @@ Summary: public interface FooServer { public Foo newFoo(); public void updateFoo(Foo foo); - + } public DecoratedFooServer implements FooServer { private final FooServer realFooServer; @@ -734,7 +325,7 @@ Summary: } } } - } + Then in your test setup: @@ -745,37 +336,17 @@ Summary: CountingIdlingResource countingResource = new CountingIdlingResource("FooServerCalls"); FooApplication.setFooServer(new DecoratedFooServer(realServer, countingResource)); Espresso.registerIdlingResource(countingResource); - - } - - -

    - - - - - -
    - - - - - - - - - - - + } + +

    -
    -

    Summary

    +

    Summary

    @@ -800,55 +371,46 @@ Summary: - - - - - - - - - - - - - - - +
    Public Constructors
    - - - - - - - - CountingIdlingResource(String resourceName) - -
    - Creates a CountingIdlingResource without debug tracing. - - - -
    - -
    - - - - - - - - CountingIdlingResource(String resourceName, boolean debugCounting) - -
    - Creates a CountingIdlingResource. - - - -
    - -
    + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + CountingIdlingResource(String resourceName) + + +

    Creates a CountingIdlingResource without debug tracing. + + +

    + +
    + + CountingIdlingResource(String resourceName, boolean debugCounting) + + +

    Creates a CountingIdlingResource. + + +

    + +
    @@ -859,147 +421,172 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - void - - decrement() - -
    - Decrements the count of in-flight transactions to the resource being monitored. - - - -
    - -
    - - - - - - void - - dumpStateToLogs() - -
    - Prints the current state of this resource to the logcat at info level. - - - -
    - -
    - - - - - - String - - getName() - -
    - Returns the name of the resources (used for logging and idempotency of registration). - - - -
    - -
    - - - - - - void - - increment() - -
    - Increments the count of in-flight transactions to the resource being monitored. - - - -
    - -
    - - - - - - boolean - - isIdleNow() - -
    - Returns true if resource is currently idle. - - - -
    - -
    - - - - - - void - - registerIdleTransitionCallback(IdlingResource.ResourceCallback resourceCallback) - -
    - Registers the given IdlingResource.ResourceCallback with the resource. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + decrement() + + +

    Decrements the count of in-flight transactions to the resource being monitored. + + +

    + +
    + + + + + + void + + + dumpStateToLogs() + + +

    Prints the current state of this resource to the logcat at info level. + + +

    + +
    + + + + + + String + + + getName() + + +

    Returns the name of the resources (used for logging and idempotency of registration). + + +

    + +
    + + + + + + void + + + increment() + + +

    Increments the count of in-flight transactions to the resource being monitored. + + +

    + +
    + + + + + + boolean + + + isIdleNow() + + +

    Returns true if resource is currently idle. + + +

    + +
    + + + + + + void + + + registerIdleTransitionCallback(IdlingResource.ResourceCallback resourceCallback) + + +

    Registers the given IdlingResource.ResourceCallback with the resource. + + +

    + +
    @@ -1011,207 +598,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1219,94 +875,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.IdlingResource + + From +interface + + + android.support.test.espresso.IdlingResource + +
    -
    - - - - - - - - - @@ -1342,95 +1004,76 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - CountingIdlingResource - (String resourceName) -

    -
    -
    +
    +

    CountingIdlingResource

    +
    +
    + + - - -
    -
    - - - - -

    Creates a CountingIdlingResource without debug tracing.

    -
    -
    Parameters
    - - - +
    resourceName - the resource name this resource should report to Espresso. + +
    +CountingIdlingResource (String resourceName)
    + + + + +

    Creates a CountingIdlingResource without debug tracing.

    + + + + + - -
    Parameters
    resourceName + String: + the resource name this resource should report to Espresso.
    - +
    -
    -
    -

    - - public - - - - +
    +

    CountingIdlingResource

    +
    +
    + + - - CountingIdlingResource - (String resourceName, boolean debugCounting) -

    -
    -
    - - - -
    -
    - - - - -

    Creates a CountingIdlingResource.

    -
    -
    Parameters
    - - - - - - +
    resourceName - the resource name this resource should report to Espresso.
    debugCounting - if true increment & decrement calls will print trace information to logs. + +
    +CountingIdlingResource (String resourceName, 
    +                boolean debugCounting)
    + + + + +

    Creates a CountingIdlingResource.

    + + + + + + + + + - -
    Parameters
    resourceName + String: + the resource name this resource should report to Espresso.
    debugCounting + boolean: + if true increment & decrement calls will print trace information to logs.
    - +
    -
    @@ -1445,218 +1088,166 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - void - - decrement - () -

    -
    -
    - - - -
    -
    - - +
    +

    decrement

    +
    +
    + + +
    +
    +void decrement ()
    + + -

    Decrements the count of in-flight transactions to the resource being monitored. + +

    Decrements the count of in-flight transactions to the resource being monitored. - If this operation results in the counter falling below 0 - an exception is raised.

    -
    -
    Throws
    - + If this operation results in the counter falling below 0 - an exception is raised.

    +
    + - +
    Throws
    IllegalStateException - if the counter is below 0. + IllegalStateExceptionif the counter is below 0.
    -
    + -
    -
    -

    - - public - - - - - void - - dumpStateToLogs - () -

    -
    -
    - - - -
    -
    - - +
    +

    dumpStateToLogs

    +
    +
    + + +
    +
    +void dumpStateToLogs ()
    + + -

    Prints the current state of this resource to the logcat at info level. -

    + +

    Prints the current state of this resource to the logcat at info level. +

    -
    -
    -

    - - public - - - - - String - - getName - () -

    -
    -
    - - - -
    -
    - - +
    +

    getName

    +
    +
    + + +
    +
    +String getName ()
    + + -

    Returns the name of the resources (used for logging and idempotency of registration). -

    + +

    Returns the name of the resources (used for logging and idempotency of registration). +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - void - - increment - () -

    -
    -
    - - - -
    -
    - - +
    +

    increment

    +
    +
    + + +
    +
    +void increment ()
    + + -

    Increments the count of in-flight transactions to the resource being monitored. + +

    Increments the count of in-flight transactions to the resource being monitored. This method can be called from any thread. -

    +

    -
    -
    -

    - - public - - - - - boolean - - isIdleNow - () -

    -
    -
    - - - -
    -
    - - +
    +

    isIdleNow

    +
    +
    + + +
    +
    +boolean isIdleNow ()
    + + -

    Returns true if resource is currently idle. Espresso will always call this + +

    Returns true if resource is currently idle. Espresso will always call this method from the main thread, therefore it should be non-blocking and return immediately. -

    +

    + + + + + + +
    Returns
    boolean
    -
    -
    -

    - - public - - - - - void - - registerIdleTransitionCallback - (IdlingResource.ResourceCallback resourceCallback) -

    -
    -
    - - - -
    -
    - - +
    +

    registerIdleTransitionCallback

    +
    +
    + + +
    +
    +void registerIdleTransitionCallback (IdlingResource.ResourceCallback resourceCallback)
    + + -

    Registers the given IdlingResource.ResourceCallback with the resource. Espresso will call this method: + +

    Registers the given IdlingResource.ResourceCallback with the resource. Espresso will call this method:

      -
    • with its implementation of IdlingResource.ResourceCallback so it can be notified asynchronously +
    • with its implementation of IdlingResource.ResourceCallback so it can be notified asynchronously that your resource is idle
    • from the main thread, but you are free to execute the callback's onTransitionToIdle from any thread @@ -1665,9 +1256,17 @@ From interface
      You only need to call this upon transition from busy to idle - if the resource is already idle when the method is called invoking the call back is optional and has no significant impact. -

    +

    + + + + + + +
    Parameters
    resourceCallback + IdlingResource.ResourceCallback +
    -
    @@ -1679,193 +1278,39 @@ From interface - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/contrib/DrawerActions.html b/docs/html/reference/android/support/test/espresso/contrib/DrawerActions.html index 0f5adc1fdc3b..e15beebe20dc 100644 --- a/docs/html/reference/android/support/test/espresso/contrib/DrawerActions.html +++ b/docs/html/reference/android/support/test/espresso/contrib/DrawerActions.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,85 @@ - - - - - - -DrawerActions | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +DrawerActions - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    DrawerActions

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    DrawerActions

    +

    + + public + + final + + class + DrawerActions + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.contrib.DrawerActions
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.contrib.DrawerActions +
    + + +

    +

    Espresso actions for using a DrawerLayout.

    -
    - - -

    Class Overview

    -

    Espresso actions for using a DrawerLayout.

    - - - -
    -
    See Also
    + -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -734,209 +300,242 @@ Summary: - - - - - - - - - + +
    +

    isInternal

    +
    +
    + + +
    +
    +Matcher<Intent> isInternal ()
    + + -
    - - + +
    +Matcher<Intent> toPackage (String packageName)
    + + + + +

    Matches an intent based on the package of activity which can handle the intent.

    +
    Public Methods
    - - + + - static - ViewAction - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + + + + + - + + +

    + + + +

    Public methods

    - close(int gravity) -
    - Creates an action which closes the DrawerLayout with the gravity. - - - -
    - -
    - - - - static - - ViewAction - - close() - -
    - Creates an action which closes the DrawerLayout with gravity START. - - - -
    - -
    - - - - static - - void - - closeDrawer(int drawerLayoutId) - -
    - + +
    + + + static + + + ViewAction + + + close(int gravity) + + +

    Creates an action which closes the DrawerLayout with the gravity. + + +

    + +
    + + + static + + + ViewAction + + + close() + + +

    Creates an action which closes the DrawerLayout with gravity START. + + +

    + +
    + + + static + + + void + + + closeDrawer(int drawerLayoutId, int gravity) + + +

    This method is deprecated. - Use close() with perform after matching a view. This method will + Use open(int) with perform after matching a view. This method will be removed in the next release. - - - - - -

    - - - - static - - void - - closeDrawer(int drawerLayoutId, int gravity) - -
    - + + +

    + +
    + + + static + + + void + + + closeDrawer(int drawerLayoutId) + + +

    This method is deprecated. - Use open(int) with perform after matching a view. This method will + Use close() with perform after matching a view. This method will be removed in the next release. - - - - - -

    - - - - static - - ViewAction - - open(int gravity) - -
    - Creates an action which opens the DrawerLayout drawer with the gravity. - - - -
    - -
    - - - - static - - ViewAction - - open() - -
    - Creates an action which opens the DrawerLayout drawer with gravity START. - - - -
    - -
    - - - - static - - void - - openDrawer(int drawerLayoutId, int gravity) - -
    - + + +

    + +
    + + + static + + + ViewAction + + + open(int gravity) + + +

    Creates an action which opens the DrawerLayout drawer with the gravity. + + +

    + +
    + + + static + + + ViewAction + + + open() + + +

    Creates an action which opens the DrawerLayout drawer with gravity START. + + +

    + +
    + + + static + + + void + + + openDrawer(int drawerLayoutId) + + +

    This method is deprecated. - Use open(int) with perform after matching a view. This method will + Use open() with perform after matching a view. This method will be removed in the next release. - - - - - -

    - - - - static - - void - - openDrawer(int drawerLayoutId) - -
    - + + +

    + +
    + + + static + + + void + + + openDrawer(int drawerLayoutId, int gravity) + + +

    This method is deprecated. - Use open() with perform after matching a view. This method will + Use open(int) with perform after matching a view. This method will be removed in the next release. - - - - - -

    @@ -948,207 +547,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1157,16 +825,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1192,295 +850,303 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - ViewAction - - close - (int gravity) -

    -
    -
    - - - -
    -
    - - +
    +

    close

    +
    +
    + + +
    +
    +ViewAction close (int gravity)
    + + -

    Creates an action which closes the DrawerLayout with the gravity. This method + +

    Creates an action which closes the DrawerLayout with the gravity. This method blocks until the drawer is fully closed. No operation if the drawer is already closed. -

    +

    + + + + + + +
    Parameters
    gravity + int +
    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - close - () -

    -
    -
    - - - -
    -
    - - +
    +

    close

    +
    +
    + + +
    +
    +ViewAction close ()
    + + -

    Creates an action which closes the DrawerLayout with gravity START. This method + +

    Creates an action which closes the DrawerLayout with gravity START. This method blocks until the drawer is fully closed. No operation if the drawer is already closed. -

    +

    + + + + + + +
    Returns
    ViewAction
    -
    - - -
    -

    - - public - static - - - - void - - closeDrawer - (int drawerLayoutId) -

    -
    -
    - - - -
    -
    + +
    +

    closeDrawer

    +
    +
    + + +
    +
    +void closeDrawer (int drawerLayoutId, 
    +                int gravity)
    + + -

    +

    This method is deprecated.
    - Use close() with perform after matching a view. This method will + Use open(int) with perform after matching a view. This method will be removed in the next release.

    -

    +

    + + + + + + + + + + +
    Parameters
    drawerLayoutId + int +
    gravity + int +
    -
    - - -
    -

    - - public - static - - - - void - - closeDrawer - (int drawerLayoutId, int gravity) -

    -
    -
    - - - -
    -
    + +
    +

    closeDrawer

    +
    +
    + + +
    +
    +void closeDrawer (int drawerLayoutId)
    + + -

    +

    This method is deprecated.
    - Use open(int) with perform after matching a view. This method will + Use close() with perform after matching a view. This method will be removed in the next release.

    -

    +

    + + + + + + +
    Parameters
    drawerLayoutId + int +
    -
    -
    -

    - - public - static - - - - ViewAction - - open - (int gravity) -

    -
    -
    - - - -
    -
    - - +
    +

    open

    +
    +
    + + +
    +
    +ViewAction open (int gravity)
    + + -

    Creates an action which opens the DrawerLayout drawer with the gravity. This method + +

    Creates an action which opens the DrawerLayout drawer with the gravity. This method blocks until the drawer is fully open. No operation if the drawer is already open. -

    +

    + + + + + + +
    Parameters
    gravity + int +
    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - ViewAction - - open - () -

    -
    -
    - - - -
    -
    - - +
    +

    open

    +
    +
    + + +
    +
    +ViewAction open ()
    + + -

    Creates an action which opens the DrawerLayout drawer with gravity START. This method + +

    Creates an action which opens the DrawerLayout drawer with gravity START. This method blocks until the drawer is fully open. No operation if the drawer is already open. -

    +

    + + + + + + +
    Returns
    ViewAction
    -
    - - -
    -

    - - public - static - - - - void - - openDrawer - (int drawerLayoutId, int gravity) -

    -
    -
    - - - -
    -
    + +
    +

    openDrawer

    +
    +
    + + +
    +
    +void openDrawer (int drawerLayoutId)
    + + -

    +

    This method is deprecated.
    - Use open(int) with perform after matching a view. This method will + Use open() with perform after matching a view. This method will be removed in the next release.

    -

    +

    + + + + + + +
    Parameters
    drawerLayoutId + int +
    -
    - - -
    -

    - - public - static - - - - void - - openDrawer - (int drawerLayoutId) -

    -
    -
    - - - -
    -
    + +
    +

    openDrawer

    +
    +
    + + +
    +
    +void openDrawer (int drawerLayoutId, 
    +                int gravity)
    + + -

    +

    This method is deprecated.
    - Use open() with perform after matching a view. This method will + Use open(int) with perform after matching a view. This method will be removed in the next release.

    -

    +

    + + + + + + + + + + +
    Parameters
    drawerLayoutId + int +
    gravity + int +
    -
    @@ -1492,193 +1158,39 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/contrib/DrawerMatchers.html b/docs/html/reference/android/support/test/espresso/contrib/DrawerMatchers.html index 54822bd637e0..91bf6cee127e 100644 --- a/docs/html/reference/android/support/test/espresso/contrib/DrawerMatchers.html +++ b/docs/html/reference/android/support/test/espresso/contrib/DrawerMatchers.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,85 @@ - - - - - - -DrawerMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +DrawerMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    DrawerMatchers

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    DrawerMatchers

    +

    + + public + + final + + class + DrawerMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.contrib.DrawerMatchers
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.contrib.DrawerMatchers +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Hamcrest matchers for a DrawerLayout. +

    Hamcrest matchers for a DrawerLayout.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -729,101 +295,118 @@ Summary: - - - - - - - - - - - - - - - +
    Public Methods
    - - - - static - - Matcher<View> - - isClosed() - -
    - Returns a matcher that verifies that the drawer (with gravity START) is closed. - - - -
    - -
    - - - - static - - Matcher<View> - - isClosed(int gravity) - -
    - Returns a matcher that verifies that the drawer with the specified gravity is closed. - - - -
    - -
    + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - - - - static - - Matcher<View> - - isOpen(int gravity) - -
    - Returns a matcher that verifies that the drawer with the specified gravity is open. - - - -
    - -
    - - - - static - - Matcher<View> - - isOpen() - -
    - Returns a matcher that verifies that the drawer (with gravity START) is open. - - - -
    - -
    + + + static + + + Matcher<View> + + + isClosed() + + +

    Returns a matcher that verifies that the drawer (with gravity START) is closed. + + +

    + +
    + + + static + + + Matcher<View> + + + isClosed(int gravity) + + +

    Returns a matcher that verifies that the drawer with the specified gravity is closed. + + +

    + +
    + + + static + + + Matcher<View> + + + isOpen(int gravity) + + +

    Returns a matcher that verifies that the drawer with the specified gravity is open. + + +

    + +
    + + + static + + + Matcher<View> + + + isOpen() + + +

    Returns a matcher that verifies that the drawer (with gravity START) is open. + + +

    + +
    @@ -835,207 +418,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1044,16 +696,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1079,145 +721,147 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Matcher<View> - - isClosed - () -

    -
    -
    - - - -
    -
    +
    +

    isClosed

    +
    +
    + + - - - -

    Returns a matcher that verifies that the drawer (with gravity START) is closed. Matches only - when the drawer is fully closed. Use isOpen() instead of not(isClosed())) +

    +
    +Matcher<View> isClosed ()
    + + + + +

    Returns a matcher that verifies that the drawer (with gravity START) is closed. Matches only + when the drawer is fully closed. Use isOpen() instead of not(isClosed())) when you wish to check that the drawer is fully open. -

    +

    + + + + + + +
    Returns
    Matcher<View>
    -
    -
    -

    - - public - static - - - - Matcher<View> - - isClosed - (int gravity) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that verifies that the drawer with the specified gravity is closed. Matches - only when the drawer is fully closed. Use isOpen(int) instead of not(isClosed())) when you wish to check that the drawer is fully open. -

    +
    +

    isClosed

    +
    +
    + +
    +
    +Matcher<View> isClosed (int gravity)
    + + + + +

    Returns a matcher that verifies that the drawer with the specified gravity is closed. Matches + only when the drawer is fully closed. Use isOpen(int) instead of not(isClosed())) when you wish to check that the drawer is fully open. +

    + + + + + + +
    Parameters
    gravity + int +
    + + + + + + +
    Returns
    Matcher<View>
    +
    -
    -

    - - public - static - - - - Matcher<View> - - isOpen - (int gravity) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that verifies that the drawer with the specified gravity is open. Matches - only when the drawer is fully open. Use isClosed(int) instead of not(isOpen()) when you wish to check that the drawer is fully closed. -

    +
    +

    isOpen

    +
    +
    + +
    +
    +Matcher<View> isOpen (int gravity)
    + + + + +

    Returns a matcher that verifies that the drawer with the specified gravity is open. Matches + only when the drawer is fully open. Use isClosed(int) instead of not(isOpen()) when you wish to check that the drawer is fully closed. +

    + + + + + + +
    Parameters
    gravity + int +
    + + + + + + +
    Returns
    Matcher<View>
    +
    -
    -

    - - public - static - - - - Matcher<View> - - isOpen - () -

    -
    -
    - - - -
    -
    - +
    +

    isOpen

    +
    +
    + + - - -

    Returns a matcher that verifies that the drawer (with gravity START) is open. Matches only - when the drawer is fully open. Use isClosed() instead of not(isOpen()) when +

    +
    +Matcher<View> isOpen ()
    + + + + +

    Returns a matcher that verifies that the drawer (with gravity START) is open. Matches only + when the drawer is fully open. Use isClosed() instead of not(isOpen()) when you wish to check that the drawer is fully closed. -

    +

    + + + + + + +
    Returns
    Matcher<View>
    -
    @@ -1229,193 +873,39 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/contrib/NavigationViewActions.html b/docs/html/reference/android/support/test/espresso/contrib/NavigationViewActions.html new file mode 100644 index 000000000000..59a4e1e5f47f --- /dev/null +++ b/docs/html/reference/android/support/test/espresso/contrib/NavigationViewActions.html @@ -0,0 +1,736 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +NavigationViewActions + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + +
    + +
    + + + +

    NavigationViewActions

    +

    + + public + + final + + class + NavigationViewActions + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.contrib.NavigationViewActions +
    + + + + +

    + + +

    View actions for interacting with NavigationView +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + static + + + ViewAction + + + navigateTo(int menuItemId) + + +

    Returns a ViewAction that navigates to a menu item in NavigationView using a + menu item resource id. + + +

    + +
    + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    navigateTo

    +
    +
    + + + +
    +
    +ViewAction navigateTo (int menuItemId)
    + + + + +

    Returns a ViewAction that navigates to a menu item in NavigationView using a + menu item resource id. + +

    View constraints:

    • View must be a child of a DrawerLayout
    • View must be + of type NavigationView
    • View must be visible on screen
    • View must be displayed on + screen

        + + + + + + +
        Parameters
        menuItemId + int: + the resource id of the menu item
        + + + + + + +
        Returns
        ViewActiona ViewAction that navigates on a menu item +
        + +
    + + + + + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/espresso/contrib/PickerActions.html b/docs/html/reference/android/support/test/espresso/contrib/PickerActions.html index f090b22cf342..cf3ac8262ccf 100644 --- a/docs/html/reference/android/support/test/espresso/contrib/PickerActions.html +++ b/docs/html/reference/android/support/test/espresso/contrib/PickerActions.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,85 @@ - - - - - - -PickerActions | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +PickerActions - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    PickerActions

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    PickerActions

    +

    + + public + + final + + class + PickerActions + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.contrib.PickerActions
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.contrib.PickerActions +
    + + +

    +

    Espresso action for interacting with DatePicker and + TimePicker.

    -
    - - -

    Class Overview

    -

    Espresso action for interacting with DatePicker and - TimePicker.

    - - - -
    -
    See Also
    +
    +

    See also:

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -735,55 +301,64 @@ Summary: - - - - +
    Public Methods
    + - - - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - - static - - ViewAction - - setDate(int year, int monthOfYear, int dayOfMonth) - -
    - Returns a ViewAction that sets a date on a DatePicker. - - - -
    - -
    - - - - static - - ViewAction - - setTime(int hours, int minutes) - -
    - Returns a ViewAction that sets a time on a TimePicker. - - - -
    - -
    + + + static + + + ViewAction + + + setDate(int year, int monthOfYear, int dayOfMonth) + + +

    Returns a ViewAction that sets a date on a DatePicker. + + +

    + +
    + + + static + + + ViewAction + + + setTime(int hours, int minutes) + + +

    Returns a ViewAction that sets a time on a TimePicker. + + +

    + +
    @@ -795,207 +370,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1004,16 +648,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1039,73 +673,104 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - ViewAction - - setDate - (int year, int monthOfYear, int dayOfMonth) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a ViewAction that sets a date on a DatePicker. -

    +
    +

    setDate

    +
    +
    + +
    +
    +ViewAction setDate (int year, 
    +                int monthOfYear, 
    +                int dayOfMonth)
    + + + + +

    Returns a ViewAction that sets a date on a DatePicker. +

    + + + + + + + + + + + + + + +
    Parameters
    year + int +
    monthOfYear + int +
    dayOfMonth + int +
    + + + + + + +
    Returns
    ViewAction
    +
    -
    -

    - - public - static - - - - ViewAction - - setTime - (int hours, int minutes) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a ViewAction that sets a time on a TimePicker. -

    +
    +

    setTime

    +
    +
    + +
    +
    +ViewAction setTime (int hours, 
    +                int minutes)
    + + + + +

    Returns a ViewAction that sets a time on a TimePicker. +

    + + + + + + + + + + +
    Parameters
    hours + int +
    minutes + int +
    + + + + + + +
    Returns
    ViewAction
    +
    @@ -1117,193 +782,39 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/contrib/RecyclerViewActions.PositionableRecyclerViewAction.html b/docs/html/reference/android/support/test/espresso/contrib/RecyclerViewActions.PositionableRecyclerViewAction.html index acebfec61da4..5da4edb9c364 100644 --- a/docs/html/reference/android/support/test/espresso/contrib/RecyclerViewActions.PositionableRecyclerViewAction.html +++ b/docs/html/reference/android/support/test/espresso/contrib/RecyclerViewActions.PositionableRecyclerViewAction.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,85 @@ - - - - - - -RecyclerViewActions.PositionableRecyclerViewAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +RecyclerViewActions.PositionableRecyclerViewAction - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - interface -

    RecyclerViewActions.PositionableRecyclerViewAction

    - - - - - +

    RecyclerViewActions.PositionableRecyclerViewAction

    +

    + + public + static + + + interface + RecyclerViewActions.PositionableRecyclerViewAction + +
    + + + + + implements + + ViewAction + + + + - ViewAction - - - - - +

    - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.contrib.RecyclerViewActions.PositionableRecyclerViewAction
    android.support.test.espresso.contrib.RecyclerViewActions.PositionableRecyclerViewAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Most RecyclerViewActions are given a matcher to select a particular view / viewholder within +

    Most RecyclerViewActions are given a matcher to select a particular view / viewholder within the RecyclerView. In this case the default behaviour is to expect that the matcher matches 1 and only one item within the RecyclerView. @@ -677,27 +258,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -726,33 +289,38 @@ Summary: - - - - - - - @@ -866,16 +449,6 @@ From interface
    Public Methods
    - abstract - - + + - RecyclerViewActions.PositionableRecyclerViewAction - - + + + + + - + + +

    + + + +

    Public methods

    - atPosition(int position) -
    - Returns a new ViewAction which will cause the ViewAction to operate upon the position-th + +
    + abstract + + + + + RecyclerViewActions.PositionableRecyclerViewAction + + + atPosition(int position) + + +

    Returns a new ViewAction which will cause the ViewAction to operate upon the position-th element which the matcher has selected. - - - - - -

    @@ -764,100 +332,115 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + -

    Inherited methods

    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -901,63 +474,54 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - RecyclerViewActions.PositionableRecyclerViewAction - - atPosition - (int position) -

    -
    -
    - - - -
    -
    - - - +
    +

    atPosition

    +
    +
    + + -

    Returns a new ViewAction which will cause the ViewAction to operate upon the position-th - element which the matcher has selected.

    -
    -
    Parameters
    - - - - -
    position - a 0-based index into the list of matching elements within the RecyclerView.
    -
    -
    -
    Returns
    -
    • PositionableRecyclerViewAction a new ViewAction focused on a particular position.
    -
    -
    -
    Throws
    - + +
    +RecyclerViewActions.PositionableRecyclerViewAction atPosition (int position)
    + + + + +

    Returns a new ViewAction which will cause the ViewAction to operate upon the position-th + element which the matcher has selected.

    +
    + + + + + +
    Parameters
    position + int: + a 0-based index into the list of matching elements within the RecyclerView.
    + + + + + + +
    Returns
    RecyclerViewActions.PositionableRecyclerViewActionPositionableRecyclerViewAction a new ViewAction focused on a particular position.
    + + - +
    Throws
    IllegalArgumentException - if position < 0. + IllegalArgumentExceptionif position < 0.
    -
    + -
    @@ -969,193 +533,39 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/contrib/RecyclerViewActions.html b/docs/html/reference/android/support/test/espresso/contrib/RecyclerViewActions.html index 534336475f87..9da9d377fbad 100644 --- a/docs/html/reference/android/support/test/espresso/contrib/RecyclerViewActions.html +++ b/docs/html/reference/android/support/test/espresso/contrib/RecyclerViewActions.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,85 @@ - - - - - - -RecyclerViewActions | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +RecyclerViewActions - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    RecyclerViewActions

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    RecyclerViewActions

    +

    + + public + + final + + class + RecyclerViewActions + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.contrib.RecyclerViewActions
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.contrib.RecyclerViewActions +
    + + +

    - - - -
    - - -

    Class Overview

    -

    ViewActions to interact RecyclerView. RecyclerView works differently than - AdapterView. In fact, RecyclerView is not an AdapterView anymore, hence it can't be used - in combination with onData(Matcher). +

    ViewActions to interact RecyclerView. RecyclerView works differently than + AdapterView. In fact, RecyclerView is not an AdapterView anymore, hence it can't be used + in combination with onData(Matcher).

    - To use ViewActions in this class use onView(Matcher) with a + To use ViewActions in this class use onView(Matcher) with a - Matcher that matches your RecyclerView, then perform a - ViewAction from this class. + Matcher that matches your RecyclerView, then perform a + ViewAction from this class.

    @@ -692,53 +276,36 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - interfaceRecyclerViewActions.PositionableRecyclerViewAction
    + + + + + + - - + + @@ -767,149 +334,174 @@ Summary: -

    Nested classes

    + + + + + interface - Most RecyclerViewActions are given a matcher to select a particular view / viewholder within + RecyclerViewActions.PositionableRecyclerViewAction +

    Most RecyclerViewActions are given a matcher to select a particular view / viewholder within the RecyclerView.  - - - + + +

    - - - - - - - - - - - - - - + +
    +

    hasPackage

    +
    +
    + + -
    - - + +
    +Matcher<Intent> hasType (Matcher<String> typeMatcher)
    + + + + +

    +
    Public Methods
    - - - - static - <VH extends RecyclerView.ViewHolder> - RecyclerViewActions.PositionableRecyclerViewAction - - actionOnHolderItem(Matcher<VH> viewHolderMatcher, ViewAction viewAction) - -
    - Performs a ViewAction on a view matched by viewHolderMatcher. - - - -
    - -
    - - + + - static - <VH extends RecyclerView.ViewHolder> - RecyclerViewActions.PositionableRecyclerViewAction - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + + + + + - - - - - - - + + +

    + + + + + + + + + + + + + +

    Public methods

    - actionOnItem(Matcher<View> itemViewMatcher, ViewAction viewAction) -
    - Performs a ViewAction on a view matched by viewHolderMatcher. - - -
    - -
    - - - - static - <VH extends RecyclerView.ViewHolder> - ViewAction - - actionOnItemAtPosition(int position, ViewAction viewAction) - -
    - Performs a ViewAction on a view at position. - - - -
    - -
    - - - - static - <VH extends RecyclerView.ViewHolder> - RecyclerViewActions.PositionableRecyclerViewAction - - scrollTo(Matcher<View> itemViewMatcher) - -
    - Returns a ViewAction which scrolls RecyclerView to the view matched by + +
    + + + static + + <VH extends RecyclerView.ViewHolder> + RecyclerViewActions.PositionableRecyclerViewAction + + + actionOnHolderItem(Matcher<VH> viewHolderMatcher, ViewAction viewAction) + + +

    Performs a ViewAction on a view matched by viewHolderMatcher. + + +

    + +
    + + + static + + <VH extends RecyclerView.ViewHolder> + RecyclerViewActions.PositionableRecyclerViewAction + + + actionOnItem(Matcher<View> itemViewMatcher, ViewAction viewAction) + + +

    Performs a ViewAction on a view matched by viewHolderMatcher. + + +

    + +
    + + + static + + <VH extends RecyclerView.ViewHolder> + ViewAction + + + actionOnItemAtPosition(int position, ViewAction viewAction) + + +

    Performs a ViewAction on a view at position. + + +

    + +
    + + + static + + <VH extends RecyclerView.ViewHolder> + RecyclerViewActions.PositionableRecyclerViewAction + + + scrollTo(Matcher<View> itemViewMatcher) + + +

    Returns a ViewAction which scrolls RecyclerView to the view matched by itemViewMatcher. - - - - - -

    - - - - static - <VH extends RecyclerView.ViewHolder> - RecyclerViewActions.PositionableRecyclerViewAction - - scrollToHolder(Matcher<VH> viewHolderMatcher) - -
    - Returns a ViewAction which scrolls RecyclerView to the view matched by + + +

    + +
    + + + static + + <VH extends RecyclerView.ViewHolder> + RecyclerViewActions.PositionableRecyclerViewAction + + + scrollToHolder(Matcher<VH> viewHolderMatcher) + + +

    Returns a ViewAction which scrolls RecyclerView to the view matched by viewHolderMatcher. - - - - - -

    - - - - static - <VH extends RecyclerView.ViewHolder> - ViewAction - - scrollToPosition(int position) - -
    - Returns a ViewAction which scrolls RecyclerView to a position. - - - -
    - -
    + + + static + + <VH extends RecyclerView.ViewHolder> + ViewAction + + + scrollToPosition(int position) + + +

    Returns a ViewAction which scrolls RecyclerView to a position. + + +

    + +
    @@ -921,207 +513,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1130,16 +791,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1165,349 +816,330 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - RecyclerViewActions.PositionableRecyclerViewAction - - actionOnHolderItem - (Matcher<VH> viewHolderMatcher, ViewAction viewAction) -

    -
    -
    - - - -
    -
    - - +
    +

    actionOnHolderItem

    +
    +
    + + +
    +
    +RecyclerViewActions.PositionableRecyclerViewAction actionOnHolderItem (Matcher<VH> viewHolderMatcher, 
    +                ViewAction viewAction)
    + + -

    Performs a ViewAction on a view matched by viewHolderMatcher. + +

    Performs a ViewAction on a view matched by viewHolderMatcher.

    1. Scroll Recycler View to the view matched by itemViewMatcher
    2. Perform an action on the matched view
    Note: actionOnItem method is not overloaded, method overloading with - generic parameters is not possible.

    -
    -
    Parameters
    - - - - - + + - - - +
    +

    hasFlags

    +
    +
    + + +
    +
    +Matcher<Intent> hasFlags (int... flags)
    + + + + +

    +
    viewHolderMatcher - a + generic parameters is not possible.

    + + + + + - + Matcher that matchesan item view holder in RecyclerView + + + + + +
    Parameters
    viewHolderMatcher + Matcher: + a - Matcher that matchesan item view holder in RecyclerView
    viewAction + ViewAction: + the action that is performed on the view matched by viewHolderMatcher
    + + + + + + +
    Returns
    RecyclerViewActions.PositionableRecyclerViewAction
    + + - - -
    Throws
    viewAction - the action that is performed on the view matched by viewHolderMatcher
    - -
    -
    Throws
    - - - +
    PerformException - if there are more than one items matching given viewHolderMatcher. + PerformExceptionif there are more than one items matching given viewHolderMatcher.
    -
    + - -
    -

    - - public - static - - - - RecyclerViewActions.PositionableRecyclerViewAction - - actionOnItem - (Matcher<View> itemViewMatcher, ViewAction viewAction) -

    -
    -
    - - - -
    -
    - - +
    +

    actionOnItem

    +
    +
    + + +
    +
    +RecyclerViewActions.PositionableRecyclerViewAction actionOnItem (Matcher<View> itemViewMatcher, 
    +                ViewAction viewAction)
    + + -

    Performs a ViewAction on a view matched by viewHolderMatcher. + +

    Performs a ViewAction on a view matched by viewHolderMatcher.

    1. Scroll Recycler View to the view matched by itemViewMatcher
    2. Perform an action on the matched view
    3. -

    -
    -
    Parameters
    - - - - - + +
    +

    hasExtras

    +
    +
    + + +
    +
    +Matcher<Intent> hasExtras (Matcher<Bundle> bundleMatcher)
    + + + + +

    +
    itemViewMatcher - a +

    + + + + + - + Matcher that matches an item view in RecyclerView + + + + + +
    Parameters
    itemViewMatcher + Matcher: + a - Matcher that matches an item view in RecyclerView
    viewAction + ViewAction: + the action that is performed on the view matched by itemViewMatcher
    + + + + + + +
    Returns
    RecyclerViewActions.PositionableRecyclerViewAction
    + + - - -
    Throws
    viewAction - the action that is performed on the view matched by itemViewMatcher
    - -
    -
    Throws
    - - - +
    PerformException - if there are more than one items matching given viewHolderMatcher. + PerformExceptionif there are more than one items matching given viewHolderMatcher.
    -
    + - -
    -

    - - public - static - - - - ViewAction - - actionOnItemAtPosition - (int position, ViewAction viewAction) -

    -
    -
    - - - -
    -
    - - +
    +

    actionOnItemAtPosition

    +
    +
    + + +
    +
    +ViewAction actionOnItemAtPosition (int position, 
    +                ViewAction viewAction)
    + + -

    Performs a ViewAction on a view at position. + +

    Performs a ViewAction on a view at position.

    1. Scroll Recycler View to position
    2. Perform an action on the view at position
    3. -

    -
    -
    Parameters
    - - - - - - +
    position - position of a view in RecyclerView
    viewAction - the action that is performed on the view matched by itemViewMatcher +

    + + + + + + + + + - -
    Parameters
    position + int: + position of a view in RecyclerView
    viewAction + ViewAction: + the action that is performed on the view matched by itemViewMatcher
    - +
    + + + + + + +
    Returns
    ViewAction
    -
    -
    -

    - - public - static - - - - RecyclerViewActions.PositionableRecyclerViewAction - - scrollTo - (Matcher<View> itemViewMatcher) -

    -
    -
    - - - -
    -
    - - +
    +

    scrollTo

    +
    +
    + + +
    +
    +RecyclerViewActions.PositionableRecyclerViewAction scrollTo (Matcher<View> itemViewMatcher)
    + + -

    Returns a ViewAction which scrolls RecyclerView to the view matched by + +

    Returns a ViewAction which scrolls RecyclerView to the view matched by itemViewMatcher.

    - This approach uses RecyclerView.ViewHolders to find the target view. It will create one ViewHolder + This approach uses RecyclerView.ViewHolders to find the target view. It will create one ViewHolder per item type and bind adapter data to the ViewHolder. If the itemViewMatcher matches a ViewHolder the current position of the View is used to perform a - scrollToPosition(int). -

    -
    -
    Parameters
    - - - - - + +
    +

    hasExtra

    +
    +
    + + -
    - - + +
    +Matcher<Intent> hasExtraWithKey (Matcher<String> keyMatcher)
    + + + + +

    +
    itemViewMatcher - a + scrollToPosition(int). +

    + + + + + - -
    Parameters
    itemViewMatcher + Matcher: + a - Matcher that matches an item view in RecyclerView
    - -
    -
    Throws
    - + Matcher that matches an item view in RecyclerView + +
    + + + + + + +
    Returns
    RecyclerViewActions.PositionableRecyclerViewAction
    + + - +
    Throws
    PerformException - if there are more than one items matching given viewHolderMatcher. + PerformExceptionif there are more than one items matching given viewHolderMatcher.
    -
    + - -
    -

    - - public - static - - - - RecyclerViewActions.PositionableRecyclerViewAction - - scrollToHolder - (Matcher<VH> viewHolderMatcher) -

    -
    -
    - - - -
    -
    - - +
    +

    scrollToHolder

    +
    +
    + + +
    +
    +RecyclerViewActions.PositionableRecyclerViewAction scrollToHolder (Matcher<VH> viewHolderMatcher)
    + + -

    Returns a ViewAction which scrolls RecyclerView to the view matched by + +

    Returns a ViewAction which scrolls RecyclerView to the view matched by viewHolderMatcher.

    - This approach uses RecyclerView.ViewHolders to find the target view. It will create one ViewHolder + This approach uses RecyclerView.ViewHolders to find the target view. It will create one ViewHolder per item type and bind adapter data to the ViewHolder. If the itemViewMatcher matches a ViewHolder the current position of the View is used to perform a - scrollToPosition(int). Note: scrollTo method is not overloaded, method + scrollToPosition(int). Note: scrollTo method is not overloaded, method overloading with generic parameters is not possible. -

    -
    -
    Parameters
    - - - - - - + -
    viewHolderMatcher - a +

    + + + + + - -
    Parameters
    viewHolderMatcher + Matcher: + a - Matcher that matches an item view holder in RecyclerView
    - -
    -
    Throws
    - + Matcher that matches an item view holder in RecyclerView + +
    + + + + + + +
    Returns
    RecyclerViewActions.PositionableRecyclerViewAction
    + + - +
    Throws
    PerformException - if there are more than one items matching given viewHolderMatcher. + PerformExceptionif there are more than one items matching given viewHolderMatcher.
    -
    + - -
    -

    - - public - static - - - - ViewAction - - scrollToPosition - (int position) -

    -
    -
    - - +
    +

    scrollToPosition

    +
    +
    + + -
    -
    - - - - -

    Returns a ViewAction which scrolls RecyclerView to a position.

    -
    -
    Parameters
    - - - +
    position - the position of the view to scroll to + +
    +ViewAction scrollToPosition (int position)
    + + + + +

    Returns a ViewAction which scrolls RecyclerView to a position.

    + + + + + - -
    Parameters
    position + int: + the position of the view to scroll to
    - +
    + + + + + + +
    Returns
    ViewAction
    -
    @@ -1519,193 +1151,39 @@ From class - -
    - -
    - -
    - - - -
    - -
    - + + diff --git a/docs/html/reference/android/support/test/espresso/contrib/package-summary.html b/docs/html/reference/android/support/test/espresso/contrib/package-summary.html index e61f30272f07..b2fe5cdf7170 100644 --- a/docs/html/reference/android/support/test/espresso/contrib/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/contrib/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,809 +92,228 @@ - - - - - - -android.support.test.espresso.contrib | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.contrib - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.contrib

    -
    - -
    - -
    - - +

    android.support.test.espresso.contrib

    + +

    Interfaces

    -
    - - + + - + - + - - + +
    RecyclerViewActions.PositionableRecyclerViewActionRecyclerViewActions.PositionableRecyclerViewAction Most RecyclerViewActions are given a matcher to select a particular view / viewholder within the RecyclerView.  - - + +
    -
    - - + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + + + + + + + + + + + + + + + +
    AccessibilityChecksAccessibilityChecks A class to enable automated accessibility checks in Espresso tests.  - - + +
    CountingIdlingResourceCountingIdlingResource - An implementation of IdlingResource that determines idleness by maintaining an internal - counter.  - - + + This class is deprecated. + Use CountingIdlingResource instead. + This class has been moved to a different module to avoid a dependency on espresso-contrib in your + production code. This class will be removed in a future release. +  + +
    DrawerActionsDrawerActions - Espresso actions for using a DrawerLayout.  - - + Espresso actions for using a DrawerLayout.  + +
    DrawerMatchersDrawerMatchers - Hamcrest matchers for a DrawerLayout.  - - + Hamcrest matchers for a DrawerLayout.  + +
    PickerActionsNavigationViewActions - Espresso action for interacting with DatePicker and - TimePicker.  + View actions for interacting with NavigationView +  + + +
    PickerActions + Espresso action for interacting with DatePicker and + TimePicker.  + + +
    RecyclerViewActions + ViewActions to interact RecyclerView.  + +
    + -
    RecyclerViewActions - ViewActions to interact RecyclerView.  + -
    + -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    - + + diff --git a/docs/html/reference/android/support/test/espresso/idling/CountingIdlingResource.html b/docs/html/reference/android/support/test/espresso/idling/CountingIdlingResource.html new file mode 100644 index 000000000000..5ac3158f487b --- /dev/null +++ b/docs/html/reference/android/support/test/espresso/idling/CountingIdlingResource.html @@ -0,0 +1,1302 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +CountingIdlingResource + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +

    CountingIdlingResource

    +

    + + public + + final + + class + CountingIdlingResource + +
    + + + + + extends Object + + + + + + + + + implements + + IdlingResource + + + + + +

    + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.idling.CountingIdlingResource +
    + + + + +

    + + +

    An implementation of IdlingResource that determines idleness by maintaining an internal + counter. When the counter is 0 - it is considered to be idle, when it is non-zero it is not + idle. This is very similar to the way a Semaphore behaves. +

    + The counter may be incremented or decremented from any thread. If it reaches an illogical state + (like counter less than zero) it will throw an IllegalStateException. +

    +

    + This class can then be used to wrap up operations that while in progress should block tests from + accessing the UI. +

    + +
    + public interface FooServer {
    +     public Foo newFoo();
    +     public void updateFoo(Foo foo);
    +   }
    +
    +   public DecoratedFooServer implements FooServer {
    +     private final FooServer realFooServer;
    +     private final CountingIdlingResource fooServerIdlingResource;
    +
    +     public DecoratedFooServer(FooServer realFooServer,
    +         CountingIdlingResource fooServerIdlingResource) {
    +       this.realFooServer = checkNotNull(realFooServer);
    +       this.fooServerIdlingResource = checkNotNull(fooServerIdlingResource);
    +     }
    +
    +     public Foo newFoo() {
    +       fooServerIdlingResource.increment();
    +       try {
    +         return realFooServer.newFoo();
    +       } finally {
    +         fooServerIdlingResource.decrement();
    +       }
    +     }
    +
    +     public void updateFoo(Foo foo) {
    +       fooServerIdlingResource.increment();
    +       try {
    +         realFooServer.updateFoo(foo);
    +       } finally {
    +         fooServerIdlingResource.decrement();
    +       }
    +     }
    +   }
    +   
    +   
    + + Then in your test setup: +
    +   public void setUp() throws Exception {
    +       super.setUp();
    +       FooServer realServer = FooApplication.getFooServer();
    +       CountingIdlingResource countingResource = new CountingIdlingResource("FooServerCalls");
    +       FooApplication.setFooServer(new DecoratedFooServer(realServer, countingResource));
    +       Espresso.registerIdlingResource(countingResource);
    +     }
    +   
    +   
    + +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + CountingIdlingResource(String resourceName) + + +

    Creates a CountingIdlingResource without debug tracing. + + +

    + +
    + + CountingIdlingResource(String resourceName, boolean debugCounting) + + +

    Creates a CountingIdlingResource. + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + decrement() + + +

    Decrements the count of in-flight transactions to the resource being monitored. + + +

    + +
    + + + + + + void + + + dumpStateToLogs() + + +

    Prints the current state of this resource to the logcat at info level. + + +

    + +
    + + + + + + String + + + getName() + + +

    Returns the name of the resources (used for logging and idempotency of registration). + + +

    + +
    + + + + + + void + + + increment() + + +

    Increments the count of in-flight transactions to the resource being monitored. + + +

    + +
    + + + + + + boolean + + + isIdleNow() + + +

    Returns true if resource is currently idle. + + +

    + +
    + + + + + + void + + + registerIdleTransitionCallback(IdlingResource.ResourceCallback resourceCallback) + + +

    Registers the given IdlingResource.ResourceCallback with the resource. + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + From +interface + + + android.support.test.espresso.IdlingResource + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + + + + +
    +

    CountingIdlingResource

    +
    +
    + + + +
    +
    +CountingIdlingResource (String resourceName)
    + + + + +

    Creates a CountingIdlingResource without debug tracing.

    + + + + + + +
    Parameters
    resourceName + String: + the resource name this resource should report to Espresso. +
    + +
    + + + + +
    +

    CountingIdlingResource

    +
    +
    + + + +
    +
    +CountingIdlingResource (String resourceName, 
    +                boolean debugCounting)
    + + + + +

    Creates a CountingIdlingResource.

    + + + + + + + + + + +
    Parameters
    resourceName + String: + the resource name this resource should report to Espresso.
    debugCounting + boolean: + if true increment & decrement calls will print trace information to logs. +
    + +
    + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    decrement

    +
    +
    + + + +
    +
    +void decrement ()
    + + + + +

    Decrements the count of in-flight transactions to the resource being monitored. + + If this operation results in the counter falling below 0 - an exception is raised.

    + + + + + + +
    Throws
    IllegalStateExceptionif the counter is below 0. +
    + + +
    + + + + +
    +

    dumpStateToLogs

    +
    +
    + + + +
    +
    +void dumpStateToLogs ()
    + + + + +

    Prints the current state of this resource to the logcat at info level. +

    + +
    + + + + +
    +

    getName

    +
    +
    + + + +
    +
    +String getName ()
    + + + + +

    Returns the name of the resources (used for logging and idempotency of registration). +

    + + + + + + +
    Returns
    String
    + +
    + + + + +
    +

    increment

    +
    +
    + + + +
    +
    +void increment ()
    + + + + +

    Increments the count of in-flight transactions to the resource being monitored. + + This method can be called from any thread. +

    + +
    + + + + +
    +

    isIdleNow

    +
    +
    + + + +
    +
    +boolean isIdleNow ()
    + + + + +

    Returns true if resource is currently idle. Espresso will always call this + method from the main thread, therefore it should be non-blocking and return immediately. +

    + + + + + + +
    Returns
    boolean
    + +
    + + + + +
    +

    registerIdleTransitionCallback

    +
    +
    + + + +
    +
    +void registerIdleTransitionCallback (IdlingResource.ResourceCallback resourceCallback)
    + + + + +

    Registers the given IdlingResource.ResourceCallback with the resource. Espresso will call this method: +

      +
    • with its implementation of IdlingResource.ResourceCallback so it can be notified asynchronously + that your resource is idle +
    • from the main thread, but you are free to execute the callback's onTransitionToIdle from + any thread +
    • once (when it is initially given a reference to your IdlingResource) +
    +
    + You only need to call this upon transition from busy to idle - if the resource is already idle + when the method is called invoking the call back is optional and has no significant impact. +

    + + + + + + +
    Parameters
    resourceCallback + IdlingResource.ResourceCallback +
    + +
    + + + + + + + + + + + +
    + + + +
    + + + +
    + + + + + diff --git a/docs/html/reference/android/support/test/espresso/idling/package-summary.html b/docs/html/reference/android/support/test/espresso/idling/package-summary.html new file mode 100644 index 000000000000..1433b7964331 --- /dev/null +++ b/docs/html/reference/android/support/test/espresso/idling/package-summary.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +android.support.test.espresso.idling + + + + + + + + + + +
    + +
    +
    + + + + +
    +
    +
    + +

    android.support.test.espresso.idling

    + + + + + + + + + + + + + +

    Classes

    + + + + + + + + + + +
    CountingIdlingResource + An implementation of IdlingResource that determines idleness by maintaining an internal + counter.  + + + +
    + + + + + + + + + + + + + +
    + + +
    + + + +
    + + + + + diff --git a/docs/html/reference/android/support/test/espresso/intent/Checks.html b/docs/html/reference/android/support/test/espresso/intent/Checks.html index ecbb22432005..b683f595c874 100644 --- a/docs/html/reference/android/support/test/espresso/intent/Checks.html +++ b/docs/html/reference/android/support/test/espresso/intent/Checks.html @@ -1,4 +1,3 @@ - @@ -93,493 +92,85 @@ - - - - - - -Checks | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Checks - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    Checks

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    Checks

    +

    + + public + + final + + class + Checks + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.intent.Checks
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.intent.Checks +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Substitute for Guava Preconditions to avoid guava as a dep. +

    Substitute for Guava Preconditions to avoid guava as a dep.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -731,121 +295,164 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - static - - void - - checkArgument(boolean expression) - -
    - - - - static - - void - - checkArgument(boolean expression, Object errorMessage) - -
    - - - - static - - void - - checkArgument(boolean expression, String errorMessageTemplate, Object... errorMessageArgs) - -
    - - - - static - <T> - T - - checkNotNull(T reference, Object errorMessage) - -
    - - - - static - <T> - T - - checkNotNull(T reference) - -
    + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - - static - <T> - T - - checkNotNull(T reference, String errorMessageTemplate, Object... errorMessageArgs) - -
    - - - - static - - void - - checkState(boolean expression, String errorMessageTemplate, Object... errorMessageArgs) - -
    + + + static + + + void + + + checkArgument(boolean expression, Object errorMessage) + + +
    + + + static + + + void + + + checkArgument(boolean expression) + + +
    + + + static + + + void + + + checkArgument(boolean expression, String errorMessageTemplate, Object... errorMessageArgs) + + +
    + + + static + + <T> + T + + + checkNotNull(T reference, Object errorMessage) + + +
    + + + static + + <T> + T + + + checkNotNull(T reference) + + +
    + + + static + + <T> + T + + + checkNotNull(T reference, String errorMessageTemplate, Object... errorMessageArgs) + + +
    + + + static + + + void + + + checkState(boolean expression, String errorMessageTemplate, Object... errorMessageArgs) + + +
    @@ -857,207 +464,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1066,16 +742,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1101,231 +767,294 @@ From class -

    Public Methods

    - - - - - -
    -

    - - public - static - - - - void - - checkArgument - (boolean expression) -

    -
    -
    - - - -
    -
    +

    Public methods

    - -

    - -
    -
    - - -
    -

    - - public - static - - - - void - - checkArgument - (boolean expression, Object errorMessage) -

    -
    -
    - - +
    +

    checkArgument

    +
    +
    + + -
    -
    +
    +
    +void checkArgument (boolean expression, 
    +                Object errorMessage)
    + + + + +

    + + + + + + + + + + +
    Parameters
    expression + boolean +
    errorMessage + Object +
    +
    + -

    +
    +

    checkArgument

    +
    +
    + +
    +
    +void checkArgument (boolean expression)
    + + + + +

    + + + + + + +
    Parameters
    expression + boolean +
    +
    -
    -

    - - public - static - - - - void - - checkArgument - (boolean expression, String errorMessageTemplate, Object... errorMessageArgs) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    checkArgument

    +
    +
    + +
    +
    +void checkArgument (boolean expression, 
    +                String errorMessageTemplate, 
    +                Object... errorMessageArgs)
    + + + + +

    + + + + + + + + + + + + + + +
    Parameters
    expression + boolean +
    errorMessageTemplate + String +
    errorMessageArgs + Object +
    +
    -
    -

    - - public - static - - - - T - - checkNotNull - (T reference, Object errorMessage) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    checkNotNull

    +
    +
    + +
    +
    +T checkNotNull (T reference, 
    +                Object errorMessage)
    + + + + +

    + + + + + + + + + + +
    Parameters
    reference + T +
    errorMessage + Object +
    + + + + + + +
    Returns
    T
    +
    -
    -

    - - public - static - - - - T - - checkNotNull - (T reference) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    checkNotNull

    +
    +
    + +
    +
    +T checkNotNull (T reference)
    + + + + +

    + + + + + + +
    Parameters
    reference + T +
    + + + + + + +
    Returns
    T
    +
    -
    -

    - - public - static - - - - T - - checkNotNull - (T reference, String errorMessageTemplate, Object... errorMessageArgs) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    checkNotNull

    +
    +
    + +
    +
    +T checkNotNull (T reference, 
    +                String errorMessageTemplate, 
    +                Object... errorMessageArgs)
    + + + + +

    + + + + + + + + + + + + + + +
    Parameters
    reference + T +
    errorMessageTemplate + String +
    errorMessageArgs + Object +
    + + + + + + +
    Returns
    T
    +
    -
    -

    - - public - static - - - - void - - checkState - (boolean expression, String errorMessageTemplate, Object... errorMessageArgs) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    checkState

    +
    +
    + +
    +
    +void checkState (boolean expression, 
    +                String errorMessageTemplate, 
    +                Object... errorMessageArgs)
    + + + + +

    + + + + + + + + + + + + + + +
    Parameters
    expression + boolean +
    errorMessageTemplate + String +
    errorMessageArgs + Object +
    +
    @@ -1337,193 +1066,40 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/intent/Intents.html b/docs/html/reference/android/support/test/espresso/intent/Intents.html index c51777587fbf..5f864998a103 100644 --- a/docs/html/reference/android/support/test/espresso/intent/Intents.html +++ b/docs/html/reference/android/support/test/espresso/intent/Intents.html @@ -1,4 +1,3 @@ - @@ -93,493 +92,85 @@ - - - - - - -Intents | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Intents - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    Intents

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    Intents

    +

    + + public + + final + + class + Intents + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.intent.Intents
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.intent.Intents +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Intents enables validation and stubbing of intents sent out by the application under test. +

    Intents enables validation and stubbing of intents sent out by the application under test.

    An example test that simply validates an outgoing intent:

    @@ -719,27 +301,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -768,172 +332,201 @@ Summary: - - - - - - - - +
    Public Methods
    - - - - static - - void - - assertNoUnverifiedIntents() - -
    - Asserts that Intents does not have any unverified intents. - - - -
    - -
    + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - - - - static - - void - - init() - -
    - Initializes Intents and begins recording intents. - - - -
    - -
    - - - - static - - void - - intended(Matcher<Intent> matcher) - -
    - Asserts that the given matcher matches one and only one intent sent by the application under - test. - - - -
    - -
    - - - - static - - void - - intended(Matcher<Intent> matcher, VerificationMode verificationMode) - -
    - Asserts that the given matcher matches a specified number of intents sent by the application + +
    + + + static + + + void + + + assertNoUnverifiedIntents() + + +

    Asserts that Intents does not have any unverified intents. + + +

    + +
    + + + static + + + void + + + init() + + +

    Initializes Intents and begins recording intents. + + +

    + +
    + + + static + + + void + + + intended(Matcher<Intent> matcher, VerificationMode verificationMode) + + +

    Asserts that the given matcher matches a specified number of intents sent by the application under test. - - - - - -

    - - - - static - - OngoingStubbing - - intending(Matcher<Intent> matcher) - -
    - Enables stubbing intent responses. - - - -
    - -
    - - - - static - - void - - release() - -
    - Clears Intents state. - - - -
    - -
    - - - - static - - VerificationMode - - times(int times) - -
    - Allows verifying a specific number of intents sent by the application under test. - - - -
    - -
    + + + static + + + void + + + intended(Matcher<Intent> matcher) + + +

    Asserts that the given matcher matches one and only one intent sent by the application under + test. + + +

    + +
    + + + static + + + OngoingStubbing + + + intending(Matcher<Intent> matcher) + + +

    Enables stubbing intent responses. + + +

    + +
    + + + static + + + void + + + release() + + +

    Clears Intents state. + + +

    + +
    + + + static + + + VerificationMode + + + times(int times) + + +

    Allows verifying a specific number of intents sent by the application under test. + + +

    + +
    @@ -945,207 +538,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1154,16 +816,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1189,314 +841,252 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - void - - assertNoUnverifiedIntents - () -

    -
    -
    - - - -
    -
    - - +
    +

    assertNoUnverifiedIntents

    +
    +
    + + +
    +
    +void assertNoUnverifiedIntents ()
    + + -

    Asserts that Intents does not have any unverified intents. You can use this method after you + +

    Asserts that Intents does not have any unverified intents. You can use this method after you have verified your intents to make sure that nothing unexpected was sent out. This is an equivalent of verifyNoMoreInteractions() in Mockito. -

    +

    -
    -
    -

    - - public - static - - - - void - - init - () -

    -
    -
    - - - -
    -
    - - +
    +

    init

    +
    +
    + + +
    +
    +void init ()
    + + -

    Initializes Intents and begins recording intents. Must be called prior to triggering any + +

    Initializes Intents and begins recording intents. Must be called prior to triggering any actions that send out intents which need to be verified or stubbed. This is similar to MockitoAnnotations.initMocks. -

    +

    -
    - - -
    -

    - - public - static - - - - void - - intended - (Matcher<Intent> matcher) -

    -
    -
    - - - -
    -
    - - + +
    +

    intended

    +
    +
    + + -

    Asserts that the given matcher matches one and only one intent sent by the application under - test. This is an equivalent of verify(mock, times(1)) in Mockito. Verification does not have to - occur in the same order as the intents were sent. Intents are recorded from the time that - Intents.init is called.

    -
    -
    Parameters
    - - - - -
    matcher - the Matcher to be applied to captured intents
    -
    -
    -
    Throws
    - + +
    +void intended (Matcher<Intent> matcher, 
    +                VerificationMode verificationMode)
    + + + + +

    Asserts that the given matcher matches a specified number of intents sent by the application + under test. This is an equivalent of verify(mock, times(num)) in Mockito. Verification does + not have to occur in the same order as the intents were sent. Intents are recorded from the + time that Intents.init is called.

    +
    + + + + + + + + + +
    Parameters
    matcher + Matcher: + the Matcher to be applied to captured intents
    verificationMode + VerificationMode +
    + + - +
    Throws
    - if the given Matcher did not match any or matched more - than one of the recorded intents + if the given Matcher did not match the expected number of + recorded intents
    -
    + -
    - - -
    -

    - - public - static - - - - void - - intended - (Matcher<Intent> matcher, VerificationMode verificationMode) -

    -
    -
    - - - -
    -
    - + +
    +

    intended

    +
    +
    + + +
    +
    +void intended (Matcher<Intent> matcher)
    + + -

    Asserts that the given matcher matches a specified number of intents sent by the application - under test. This is an equivalent of verify(mock, times(num)) in Mockito. Verification does - not have to occur in the same order as the intents were sent. Intents are recorded from the - time that Intents.init is called.

    -
    -
    Parameters
    - - - - -
    matcher - the Matcher to be applied to captured intents
    -
    -
    -
    Throws
    - + +

    Asserts that the given matcher matches one and only one intent sent by the application under + test. This is an equivalent of verify(mock, times(1)) in Mockito. Verification does not have to + occur in the same order as the intents were sent. Intents are recorded from the time that + Intents.init is called.

    +
    + + + + + +
    Parameters
    matcher + Matcher: + the Matcher to be applied to captured intents
    + + - +
    Throws
    - if the given Matcher did not match the expected number of - recorded intents + if the given Matcher did not match any or matched more + than one of the recorded intents
    -
    + -
    -
    -

    - - public - static - - - - OngoingStubbing - - intending - (Matcher<Intent> matcher) -

    -
    -
    - - - -
    -
    - - +
    +

    intending

    +
    +
    + + +
    +
    +OngoingStubbing intending (Matcher<Intent> matcher)
    + + -

    Enables stubbing intent responses. This method is similar to Mockito.when and is particularly + +

    Enables stubbing intent responses. This method is similar to Mockito.when and is particularly useful when the activity launching the intent expects data to be returned (and especially in the case when the destination activity is external). In this case, the test author can call intending(matcher).thenRespond(myResponse) and validate that the launching activity handles the - result correctly. Note: the destination activity will not be launched.

    -
    -
    Parameters
    - - - +
    matcher - the Matcher that matches intents for which stubbed response should be + result correctly. Note: the destination activity will not be launched.

    + + + + + - -
    Parameters
    matcher + Matcher: + the Matcher that matches intents for which stubbed response should be provided
    - -
    -
    Returns
    - -
    +
    + + + + + + +
    Returns
    OngoingStubbingOngoingStubbing object to set stubbed response +
    -
    -
    -

    - - public - static - - - - void - - release - () -

    -
    -
    - - - -
    -
    - - +
    +

    release

    +
    +
    + + +
    +
    +void release ()
    + + -

    Clears Intents state. Must be called after each test case. -

    + +

    Clears Intents state. Must be called after each test case. +

    -
    -
    -

    - - public - static - - - - VerificationMode - - times - (int times) -

    -
    -
    +
    +

    times

    +
    +
    + + - - -
    -
    - - - - -

    Allows verifying a specific number of intents sent by the application under test. This is an - equivalent of times(num) in Mockito.

    -
    -
    Parameters
    - - - +
    times - the number of times that the intent should be matched. + +
    +VerificationMode times (int times)
    + + + + +

    Allows verifying a specific number of intents sent by the application under test. This is an + equivalent of times(num) in Mockito.

    + + + + + - -
    Parameters
    times + int: + the number of times that the intent should be matched.
    - +
    + + + + + + +
    Returns
    VerificationMode
    -
    @@ -1508,193 +1098,40 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/intent/OngoingStubbing.html b/docs/html/reference/android/support/test/espresso/intent/OngoingStubbing.html index b2d6f11ca676..d7960860596e 100644 --- a/docs/html/reference/android/support/test/espresso/intent/OngoingStubbing.html +++ b/docs/html/reference/android/support/test/espresso/intent/OngoingStubbing.html @@ -1,4 +1,3 @@ - @@ -93,493 +92,85 @@ - - - - - - -OngoingStubbing | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +OngoingStubbing - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    OngoingStubbing

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    OngoingStubbing

    +

    + + public + + final + + class + OngoingStubbing + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.intent.OngoingStubbing
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.intent.OngoingStubbing +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Supports method chaining after @Intents#intending method call. +

    Supports method chaining after @Intents#intending method call.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -731,32 +295,37 @@ Summary: - - - - - - - - - +
    Public Methods
    - - - - - - void - - respondWith(Instrumentation.ActivityResult result) - -
    - Sets a response for the intent being stubbed. - - - -
    - -
    + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + respondWith(Instrumentation.ActivityResult result) + + +

    Sets a response for the intent being stubbed. + + +

    + +
    @@ -768,207 +337,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -977,16 +615,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1012,40 +640,38 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - void - - respondWith - (Instrumentation.ActivityResult result) -

    -
    -
    - - - -
    -
    - - +
    +

    respondWith

    +
    +
    + + +
    +
    +void respondWith (Instrumentation.ActivityResult result)
    + + -

    Sets a response for the intent being stubbed. -

    + +

    Sets a response for the intent being stubbed. +

    + + + + + + +
    Parameters
    result + Instrumentation.ActivityResult +
    -
    @@ -1057,193 +683,40 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/intent/ResettingStubber.html b/docs/html/reference/android/support/test/espresso/intent/ResettingStubber.html index e61b13b7f202..561622bc7a9d 100644 --- a/docs/html/reference/android/support/test/espresso/intent/ResettingStubber.html +++ b/docs/html/reference/android/support/test/espresso/intent/ResettingStubber.html @@ -1,4 +1,3 @@ - @@ -93,493 +92,85 @@ - - - - - - -ResettingStubber | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ResettingStubber - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - interface -

    ResettingStubber

    - - - - - +

    ResettingStubber

    +

    + + public + + + + interface + ResettingStubber + +
    + + + + + implements + + IntentStubber + + + + - IntentStubber - - - - - +

    - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.intent.ResettingStubber
    android.support.test.espresso.intent.ResettingStubber +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    A sneaky singleton object used to respond to intents with fake responses. - This interface is not meant for public consumption. Test authors should use Intents +

    A sneaky singleton object used to respond to intents with fake responses. + This interface is not meant for public consumption. Test authors should use Intents instead.

    @@ -717,27 +295,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -766,95 +326,114 @@ Summary: - - - - - - - - - - - - - - +
    Public Methods
    - abstract - - - - - void - - initialize() - -
    - Marks this spy as initialized. - - - -
    - -
    - abstract - - - - - boolean - - isInitialized() - -
    + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + +

    + + + +

    Public methods

    - abstract - - - - - void - - reset() - -
    - Clears state (initialization, expected responses). - - - -
    - -
    - abstract - - - - - void - - setActivityResultForIntent(Matcher<Intent> matcher, Instrumentation.ActivityResult result) - -
    - Sets the result that will be returned to the intent sender (if the sender expects the + +
    + abstract + + + + + void + + + initialize() + + +

    Marks this spy as initialized. + + +

    + +
    + abstract + + + + + boolean + + + isInitialized() + + +
    + abstract + + + + + void + + + reset() + + +

    Clears state (initialization, expected responses). + + +

    + +
    + abstract + + + + + void + + + setActivityResultForIntent(Matcher<Intent> matcher, Instrumentation.ActivityResult result) + + +

    Sets the result that will be returned to the intent sender (if the sender expects the result), next time an intent matched by the given matcher is launched. - - - - - -

    @@ -866,55 +445,62 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -923,16 +509,6 @@ From interface

    Inherited methods

    - -From interface - - android.support.test.runner.intent.IntentStubber + + From +interface + + + android.support.test.runner.intent.IntentStubber + +
    -
    - - - - - - - - - @@ -958,147 +534,122 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - initialize - () -

    -
    -
    - - - -
    -
    - - +
    +

    initialize

    +
    +
    + + +
    +
    +void initialize ()
    + + -

    Marks this spy as initialized. Once initialized, ResettingStubber begins recording intents + +

    Marks this spy as initialized. Once initialized, ResettingStubber begins recording intents and provides intent stubbing. -

    +

    -
    -
    -

    - - public - - - abstract - - boolean - - isInitialized - () -

    -
    -
    - - - -
    -
    - - - - -

    -
    -
    Returns
    -
    • true if this spy is initialized -
    -
    +
    +

    isInitialized

    +
    +
    + +
    +
    +boolean isInitialized ()
    + + + + +

    + + + + + + +
    Returns
    booleantrue if this spy is initialized +
    +
    -
    -

    - - public - - - abstract - - void - - reset - () -

    -
    -
    - - - -
    -
    - - +
    +

    reset

    +
    +
    + + +
    +
    +void reset ()
    + + -

    Clears state (initialization, expected responses). + +

    Clears state (initialization, expected responses).

    Must be called on main thread. -

    +

    -
    -
    -

    - - public - +
    +

    setActivityResultForIntent

    +
    +
    + + - abstract - - void - - setActivityResultForIntent - (Matcher<Intent> matcher, Instrumentation.ActivityResult result) -

    -
    -
    - - - -
    -
    - - - - -

    Sets the result that will be returned to the intent sender (if the sender expects the +

    +
    +void setActivityResultForIntent (Matcher<Intent> matcher, 
    +                Instrumentation.ActivityResult result)
    + + + + +

    Sets the result that will be returned to the intent sender (if the sender expects the result), next time an intent matched by the given matcher is launched. -

    +

    + + + + + + + + + + +
    Parameters
    matcher + Matcher +
    result + Instrumentation.ActivityResult +
    -
    @@ -1110,193 +661,40 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/intent/ResettingStubberImpl.html b/docs/html/reference/android/support/test/espresso/intent/ResettingStubberImpl.html index 3e5d98f205b9..e399cd3caa1e 100644 --- a/docs/html/reference/android/support/test/espresso/intent/ResettingStubberImpl.html +++ b/docs/html/reference/android/support/test/espresso/intent/ResettingStubberImpl.html @@ -1,4 +1,3 @@ - @@ -93,507 +92,99 @@ - - - - - - -ResettingStubberImpl | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ResettingStubberImpl - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ResettingStubberImpl

    - - - - - extends Object
    - - - - - - +

    ResettingStubberImpl

    +

    + + public + + final + + class + ResettingStubberImpl + +
    + + + + + extends Object + + + + + + + + implements - - ResettingStubber - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ResettingStubber + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.intent.ResettingStubberImpl
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.intent.ResettingStubberImpl +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Implementation of ResettingStubber +

    Implementation of ResettingStubber

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -749,25 +313,23 @@ Summary: - - +
    Public Constructors
    + - - - - + + + + + + +

    Public constructors

    - - - - - - - - ResettingStubberImpl() - -
    + + ResettingStubberImpl() + + +
    @@ -778,119 +340,142 @@ Summary: - - - - - - - - - - + +
    +

    hasData

    +
    +
    + + -
    - - + +
    +Matcher<Intent> hasData (Uri uri)
    + + + + +

    +
    Public Methods
    - - - - - - Instrumentation.ActivityResult - - getActivityResultForIntent(Intent intent) - -
    - Returns the first matching stubbed result for the given activity if stubbed result was set + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + +

    + + + +

    Public methods

    + + + + + + Instrumentation.ActivityResult + + + getActivityResultForIntent(Intent intent) + + +

    Returns the first matching stubbed result for the given activity if stubbed result was set by test author. - - - - - -

    - - - - - - void - - initialize() - -
    - Marks this spy as initialized. - - - -
    - -
    - - - - - - boolean - - isInitialized() - -
    - - - - - - void - - reset() - -
    - Clears state (initialization, expected responses). - - - -
    - -
    - - - - - - void - - setActivityResultForIntent(Matcher<Intent> matcher, Instrumentation.ActivityResult result) - -
    - Sets the result that will be returned to the intent sender (if the sender expects the + + +

    + +
    + + + + + + void + + + initialize() + + +

    Marks this spy as initialized. + + +

    + +
    + + + + + + boolean + + + isInitialized() + + +
    + + + + + + void + + + reset() + + +

    Clears state (initialization, expected responses). + + +

    + +
    + + + + + + void + + + setActivityResultForIntent(Matcher<Intent> matcher, Instrumentation.ActivityResult result) + + +

    Sets the result that will be returned to the intent sender (if the sender expects the result), next time an intent matched by the given matcher is launched. - - - - - -

    @@ -902,207 +487,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1110,111 +764,133 @@ From class - @@ -1222,49 +898,57 @@ From interface - @@ -1273,16 +957,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.intent.ResettingStubber + + From +interface + + + android.support.test.espresso.intent.ResettingStubber + +
    - -From interface - - android.support.test.runner.intent.IntentStubber + + From +interface + + + android.support.test.runner.intent.IntentStubber + +
    -
    - - - - - - - - - @@ -1300,39 +974,28 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - ResettingStubberImpl - () -

    -
    -
    - - - -
    -
    - - +
    +

    ResettingStubberImpl

    +
    +
    + + +
    +
    +ResettingStubberImpl ()
    + + -

    + +

    -
    @@ -1347,180 +1010,164 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Instrumentation.ActivityResult - - getActivityResultForIntent - (Intent intent) -

    -
    -
    - - - -
    -
    - - +
    +

    getActivityResultForIntent

    +
    +
    + + +
    +
    +Instrumentation.ActivityResult getActivityResultForIntent (Intent intent)
    + + -

    Returns the first matching stubbed result for the given activity if stubbed result was set + +

    Returns the first matching stubbed result for the given activity if stubbed result was set by test author. The method searches the list of existing matcher/response pairs in reverse order of which they were entered; i.e. the last stubbing has the highest priority. If no stubbed result matching the given intent is found, null is returned.

    Must be called on main thread. -

    +

    + + + + + + +
    Parameters
    intent + Intent +
    + + + + + + +
    Returns
    Instrumentation.ActivityResult
    -
    -
    -

    - - public - - - - - void - - initialize - () -

    -
    -
    - - - -
    -
    - - +
    +

    initialize

    +
    +
    + + +
    +
    +void initialize ()
    + + -

    Marks this spy as initialized. Once initialized, ResettingStubber begins recording intents + +

    Marks this spy as initialized. Once initialized, ResettingStubber begins recording intents and provides intent stubbing. -

    +

    -
    -
    -

    - - public - - - - - boolean - - isInitialized - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    isInitialized

    +
    +
    + +
    +
    +boolean isInitialized ()
    + + + + +

    + + + + + + +
    Returns
    boolean
    +
    -
    -

    - - public - - - - - void - - reset - () -

    -
    -
    - - - -
    -
    - - +
    +

    reset

    +
    +
    + + +
    +
    +void reset ()
    + + -

    Clears state (initialization, expected responses). + +

    Clears state (initialization, expected responses).

    Must be called on main thread. -

    +

    -
    -
    -

    - - public +
    +

    setActivityResultForIntent

    +
    +
    + + - - - - void - - setActivityResultForIntent - (Matcher<Intent> matcher, Instrumentation.ActivityResult result) -

    -
    -
    - - - -
    -
    - - - - -

    Sets the result that will be returned to the intent sender (if the sender expects the +

    +
    +void setActivityResultForIntent (Matcher<Intent> matcher, 
    +                Instrumentation.ActivityResult result)
    + + + + +

    Sets the result that will be returned to the intent sender (if the sender expects the result), next time an intent matched by the given matcher is launched. -

    +

    + + + + + + + + + + +
    Parameters
    matcher + Matcher +
    result + Instrumentation.ActivityResult +
    -
    @@ -1532,193 +1179,40 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/intent/ResolvedIntent.html b/docs/html/reference/android/support/test/espresso/intent/ResolvedIntent.html index 0bf2ffa69d17..8b93ab557c6f 100644 --- a/docs/html/reference/android/support/test/espresso/intent/ResolvedIntent.html +++ b/docs/html/reference/android/support/test/espresso/intent/ResolvedIntent.html @@ -1,5 +1,3 @@ - - @@ -93,484 +91,77 @@ - - - - - - -ResolvedIntent | Android Developers - - - - - - - - - - - - - - - - - - - -
    - + - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + + +
    @@ -590,137 +181,106 @@ Summary: Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public - - - - interface -

    ResolvedIntent

    - - - - - - +

    ResolvedIntent

    +

    + + public + + + + interface + ResolvedIntent + +
    + + + + + +

    - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.intent.ResolvedIntent
    android.support.test.espresso.intent.ResolvedIntent +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    An Intent that has been processed to determine the set of packages to which it resolves. +

    An Intent that has been processed to determine the set of packages to which it resolves.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -749,56 +309,65 @@ Summary: - - - - - - - - - + +
    +

    hasComponent

    +
    +
    + + -
    - - + +
    +Matcher<Intent> hasComponent (ComponentName componentName)
    + + + +

    Returns a matcher that will only match intents targeted to the componentName's class, + . For example: + Intent intent = new Intent() + .setComponentName(new ComponentName("com.google.provider", "com.google.provider.Notepad")); + will match all intents targeted to Notepad.java.

    +
    Public Methods
    - abstract + + - - boolean - - + + + + + - - - - - - - + + +

    + + + + + + + + + + + + + +

    Public methods

    - canBeHandledBy(String appPackage) - -
    - Returns true if this recorded intent can be handled by an activity in the given + +
    + abstract + + + + + boolean + + + canBeHandledBy(String appPackage) + + +

    Returns true if this recorded intent can be handled by an activity in the given package. - - - - - -

    - abstract - - - - - Intent - - getIntent() - -
    - Returns the underlying Intent. - - - -
    - -
    + abstract + + + + + Intent + + + getIntent() + + +

    Returns the underlying Intent. + + +

    + +
    @@ -809,16 +378,6 @@ Summary: - - - - - - - - - - @@ -844,74 +403,75 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - boolean - - canBeHandledBy - (String appPackage) -

    -
    -
    - - - -
    -
    - - +
    +

    canBeHandledBy

    +
    +
    + + +
    +
    +boolean canBeHandledBy (String appPackage)
    + + -

    Returns true if this recorded intent can be handled by an activity in the given + +

    Returns true if this recorded intent can be handled by an activity in the given package. -

    +

    + + + + + + +
    Parameters
    appPackage + String +
    + + + + + + +
    Returns
    boolean
    -
    -
    -

    - - public - - - abstract - - Intent - - getIntent - () -

    -
    -
    - - - -
    -
    - - +
    +

    getIntent

    +
    +
    + + +
    +
    +Intent getIntent ()
    + + -

    Returns the underlying Intent. -

    + +

    Returns the underlying Intent. +

    + + + + + + +
    Returns
    Intent
    -
    @@ -923,193 +483,40 @@ Summary: - -
    - -
    - -
    - - - -
    - - - + + diff --git a/docs/html/reference/android/support/test/espresso/intent/VerifiableIntent.html b/docs/html/reference/android/support/test/espresso/intent/VerifiableIntent.html index 113655bf6faa..257a163ffae6 100644 --- a/docs/html/reference/android/support/test/espresso/intent/VerifiableIntent.html +++ b/docs/html/reference/android/support/test/espresso/intent/VerifiableIntent.html @@ -1,4 +1,3 @@ - @@ -93,493 +92,85 @@ - - - - - - -VerifiableIntent | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +VerifiableIntent - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - interface -

    VerifiableIntent

    - - - - - +

    VerifiableIntent

    +

    + + public + + + + interface + VerifiableIntent + +
    + + + + + implements + + ResolvedIntent + + + + - ResolvedIntent - - - - - - +

    - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.intent.VerifiableIntent
    android.support.test.espresso.intent.VerifiableIntent +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A ResolvedIntent that can be marked as verified. +

    A ResolvedIntent that can be marked as verified.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -722,55 +283,64 @@ Summary: - - - - - - - - @@ -862,16 +443,6 @@ From interface
    Public Methods
    - abstract - - - - - boolean - - hasBeenVerified() + + -
    - Returns true if this recorded intent has been verified. - -
    - - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - abstract - - - - - void - - markAsVerified() - -
    - Marks this recorded intent as verified. - - - -
    - -
    + abstract + + + + + boolean + + + hasBeenVerified() + + +

    Returns true if this recorded intent has been verified. + + +

    + +
    + abstract + + + + + void + + + markAsVerified() + + +

    Marks this recorded intent as verified. + + +

    + +
    @@ -782,78 +352,89 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + -

    Inherited methods

    - -From interface - - android.support.test.espresso.intent.ResolvedIntent + + From +interface + + + android.support.test.espresso.intent.ResolvedIntent + +
    -
    - - - - - - - - - @@ -897,73 +468,58 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - boolean - - hasBeenVerified - () -

    -
    -
    - - - -
    -
    - - +
    +

    hasBeenVerified

    +
    +
    + + +
    +
    +boolean hasBeenVerified ()
    + + -

    Returns true if this recorded intent has been verified. -

    + +

    Returns true if this recorded intent has been verified. +

    + + + + + + +
    Returns
    boolean
    -
    -
    -

    - - public - - - abstract - - void - - markAsVerified - () -

    -
    -
    - - - -
    -
    - - +
    +

    markAsVerified

    +
    +
    + + +
    +
    +void markAsVerified ()
    + + -

    Marks this recorded intent as verified. -

    + +

    Marks this recorded intent as verified. +

    -
    @@ -975,193 +531,40 @@ From interface - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/intent/VerificationMode.html b/docs/html/reference/android/support/test/espresso/intent/VerificationMode.html index 0d16d3886357..3e3809356ba9 100644 --- a/docs/html/reference/android/support/test/espresso/intent/VerificationMode.html +++ b/docs/html/reference/android/support/test/espresso/intent/VerificationMode.html @@ -1,7 +1,3 @@ - - - - @@ -92,575 +88,140 @@ - - - - - - - -VerificationMode | Android Developers - - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    - - - - - - - -
    -
    + + + + + + + + + + + - -
    + + + + -
    -
    +VerificationMode - -
    - public + + + - interface -

    VerificationMode

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    VerificationMode

    +

    + + public + + + + interface + VerificationMode + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.espresso.intent.VerificationMode
    android.support.test.espresso.intent.VerificationMode +
    + + +

    - - - -
    - - -

    Class Overview

    -

    An interface for different modes of verifying intents. +

    An interface for different modes of verifying intents.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -689,32 +250,37 @@ type="text/css"> - - - - +
    Public Methods
    + - - - - + + + + + + + + +

    Public methods

    - abstract - - - void - - verify(Matcher<Intent> matcher, List<VerifiableIntent> recordedIntents) - -
    - Verifies the recorded intents that match the provided Matcher. - - - -
    - -
    + abstract + + + + + void + + + verify(Matcher<Intent> matcher, List<VerifiableIntent> recordedIntents) + + +

    Verifies the recorded intents that match the provided Matcher. + + +

    + +
    @@ -725,16 +291,6 @@ type="text/css"> -
    - - - - - - - - - @@ -760,41 +316,46 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - verify - (Matcher<Intent> matcher, List<VerifiableIntent> recordedIntents) -

    -
    -
    - +
    +

    verify

    +
    +
    + + - -
    -
    - - - - -

    Verifies the recorded intents that match the provided Matcher. No intents should be +

    +
    +void verify (Matcher<Intent> matcher, 
    +                List<VerifiableIntent> recordedIntents)
    + + + + +

    Verifies the recorded intents that match the provided Matcher. No intents should be marked as verified unless the verification passes. -

    +

    + + + + + + + + + + +
    Parameters
    matcher + Matcher +
    recordedIntents + List +
    -
    @@ -806,193 +367,40 @@ type="text/css"> - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/intent/VerificationModes.html b/docs/html/reference/android/support/test/espresso/intent/VerificationModes.html index 5488c26ad27e..429151d97220 100644 --- a/docs/html/reference/android/support/test/espresso/intent/VerificationModes.html +++ b/docs/html/reference/android/support/test/espresso/intent/VerificationModes.html @@ -1,4 +1,3 @@ - @@ -93,493 +92,85 @@ - - - - - - -VerificationModes | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +VerificationModes - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    VerificationModes

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    VerificationModes

    +

    + + public + + final + + class + VerificationModes + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.intent.VerificationModes
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.intent.VerificationModes +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Implementations of VerificationMode. +

    Implementations of VerificationMode.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -731,56 +295,65 @@ Summary: - - - - - - - - - + - - - +

    Public methods

    - - - + +
    +

    hasAction

    +
    +
    + + -
    - - +
    +

    hasCategories

    +
    +
    + + +
    +
    +Matcher<Intent> hasCategories (Matcher<? extends Iterable<? super String>> categoriesMatcher)
    + + + + +

    +
    Public Methods
    - + + - static - VerificationMode - - + + + + + - - - - - - - + + +

    + + + + + + + + + + + + + +

    Public methods

    - noUnverifiedIntents() - -
    - Creates a VerificationMode in which all matching intents must have been previously + +
    + + + static + + + VerificationMode + + + noUnverifiedIntents() + + +

    Creates a VerificationMode in which all matching intents must have been previously verified. - - - - - -

    - - - - static - - VerificationMode - - times(int times) - -
    - Creates a VerificationMode in which a specified number of intents must match. - - - -
    - -
    + + + static + + + VerificationMode + + + times(int times) + + +

    Creates a VerificationMode in which a specified number of intents must match. + + +

    + +
    @@ -792,207 +365,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1001,16 +643,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1036,74 +668,75 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - VerificationMode - - noUnverifiedIntents - () -

    -
    -
    - - - -
    -
    - - +
    +

    noUnverifiedIntents

    +
    +
    + + +
    +
    +VerificationMode noUnverifiedIntents ()
    + + -

    Creates a VerificationMode in which all matching intents must have been previously + +

    Creates a VerificationMode in which all matching intents must have been previously verified. -

    +

    + + + + + + +
    Returns
    VerificationMode
    -
    -
    -

    - - public - static - - - - VerificationMode - - times - (int times) -

    -
    -
    - - - -
    -
    - - +
    +

    times

    +
    +
    + + +
    +
    +VerificationMode times (int times)
    + + -

    Creates a VerificationMode in which a specified number of intents must match. -

    + +

    Creates a VerificationMode in which a specified number of intents must match. +

    + + + + + + +
    Parameters
    times + int +
    + + + + + + +
    Returns
    VerificationMode
    -
    @@ -1115,193 +748,40 @@ From class - -
    - -
    - -
    - - -
    - - - + + diff --git a/docs/html/reference/android/support/test/espresso/intent/matcher/BundleMatchers.html b/docs/html/reference/android/support/test/espresso/intent/matcher/BundleMatchers.html index a2481fcc4f2d..90f56af5b73f 100644 --- a/docs/html/reference/android/support/test/espresso/intent/matcher/BundleMatchers.html +++ b/docs/html/reference/android/support/test/espresso/intent/matcher/BundleMatchers.html @@ -1,4 +1,3 @@ - @@ -93,484 +92,85 @@ - - - - - - -BundleMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +BundleMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    BundleMatchers

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    BundleMatchers

    +

    + + public + + final + + class + BundleMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.intent.matcher.BundleMatchers
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.intent.matcher.BundleMatchers +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of hamcrest matchers to match Bundle objects. +

    A collection of hamcrest matchers to match Bundle objects.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -722,121 +295,164 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - static - - Matcher<Bundle> - - hasEntry(String key, Matcher<?> valueMatcher) - -
    - - - - static - <T> - Matcher<Bundle> - - hasEntry(String key, T value) - -
    - - - - static - - Matcher<Bundle> - - hasEntry(Matcher<String> keyMatcher, Matcher<?> valueMatcher) - -
    - - - - static - - Matcher<Bundle> - - hasKey(String key) - -
    - - - - static - - Matcher<Bundle> - - hasKey(Matcher<String> keyMatcher) - -
    + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - - static - - Matcher<Bundle> - - hasValue(Matcher<?> valueMatcher) - -
    - - - - static - <T> - Matcher<Bundle> - - hasValue(T value) - -
    + + + static + + + Matcher<Bundle> + + + hasEntry(String key, Matcher<?> valueMatcher) + + +
    + + + static + + <T> + Matcher<Bundle> + + + hasEntry(String key, T value) + + +
    + + + static + + + Matcher<Bundle> + + + hasEntry(Matcher<String> keyMatcher, Matcher<?> valueMatcher) + + +
    + + + static + + + Matcher<Bundle> + + + hasKey(String key) + + +
    + + + static + + + Matcher<Bundle> + + + hasKey(Matcher<String> keyMatcher) + + +
    + + + static + + <T> + Matcher<Bundle> + + + hasValue(T value) + + +
    + + + static + + + Matcher<Bundle> + + + hasValue(Matcher<?> valueMatcher) + + +
    @@ -848,207 +464,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1057,16 +742,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1092,231 +767,287 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Matcher<Bundle> - - hasEntry - (String key, Matcher<?> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasEntry

    +
    +
    + +
    +
    +Matcher<Bundle> hasEntry (String key, 
    +                Matcher<?> valueMatcher)
    + + + + +

    + + + + + + + + + + +
    Parameters
    key + String +
    valueMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Bundle>
    +
    -
    -

    - - public - static - - - - Matcher<Bundle> - - hasEntry - (String key, T value) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasEntry

    +
    +
    + +
    +
    +Matcher<Bundle> hasEntry (String key, 
    +                T value)
    + + + + +

    + + + + + + + + + + +
    Parameters
    key + String +
    value + T +
    + + + + + + +
    Returns
    Matcher<Bundle>
    +
    -
    -

    - - public - static - - - - Matcher<Bundle> - - hasEntry - (Matcher<String> keyMatcher, Matcher<?> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasEntry

    +
    +
    + +
    +
    +Matcher<Bundle> hasEntry (Matcher<String> keyMatcher, 
    +                Matcher<?> valueMatcher)
    + + + + +

    + + + + + + + + + + +
    Parameters
    keyMatcher + Matcher +
    valueMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Bundle>
    +
    -
    -

    - - public - static - - - - Matcher<Bundle> - - hasKey - (String key) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasKey

    +
    +
    + +
    +
    +Matcher<Bundle> hasKey (String key)
    + + + + +

    + + + + + + +
    Parameters
    key + String +
    + + + + + + +
    Returns
    Matcher<Bundle>
    +
    -
    -

    - - public - static - - - - Matcher<Bundle> - - hasKey - (Matcher<String> keyMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasKey

    +
    +
    + +
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Bundle> - - hasValue - (Matcher<?> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +Matcher<Bundle> hasKey (Matcher<String> keyMatcher)
    + + + + +

    + + + + + + +
    Parameters
    keyMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Bundle>
    -
    -
    -

    - - public - static - - - - Matcher<Bundle> - - hasValue - (T value) -

    -
    -
    - +
    +

    hasValue

    +
    +
    + + +
    +
    +Matcher<Bundle> hasValue (T value)
    + + + + +

    + + + + + + +
    Parameters
    value + T +
    + + + + + + +
    Returns
    Matcher<Bundle>
    -
    -
    - +
    + -

    +
    +

    hasValue

    +
    +
    + +
    +
    +Matcher<Bundle> hasValue (Matcher<?> valueMatcher)
    + + + + +

    + + + + + + +
    Parameters
    valueMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Bundle>
    +
    @@ -1328,193 +1059,31 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/intent/matcher/ComponentNameMatchers.html b/docs/html/reference/android/support/test/espresso/intent/matcher/ComponentNameMatchers.html index 1d6d21d727c5..045385a447c3 100644 --- a/docs/html/reference/android/support/test/espresso/intent/matcher/ComponentNameMatchers.html +++ b/docs/html/reference/android/support/test/espresso/intent/matcher/ComponentNameMatchers.html @@ -1,4 +1,3 @@ - @@ -93,484 +92,85 @@ - - - - - - -ComponentNameMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ComponentNameMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ComponentNameMatchers

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    ComponentNameMatchers

    +

    + + public + + final + + class + ComponentNameMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.intent.matcher.ComponentNameMatchers
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.intent.matcher.ComponentNameMatchers +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of hamcrest matchers to match ComponentName objects. +

    A collection of hamcrest matchers to match ComponentName objects.

    -
    - - - - - - - - - - - - - - - -
    - -

    Summary

    +

    Summary

    @@ -722,129 +295,170 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - static - - Matcher<ComponentName> - - hasClassName(Matcher<String> classNameMatcher) - -
    - - - - static - - Matcher<ComponentName> - - hasClassName(String className) - -
    - - + + - static - Matcher<ComponentName> - - + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - hasMyPackageName() -
    - Matches a component based on the target package name found through the Instrumentation + +
    + + + static + + + Matcher<ComponentName> + + + hasClassName(Matcher<String> classNameMatcher) + + +
    + + + static + + + Matcher<ComponentName> + + + hasClassName(String className) + + +
    + + + static + + + Matcher<ComponentName> + + + hasMyPackageName() + + +

    Matches a component based on the target package name found through the Instrumentation Registry for the test. - - - - - -

    - - - - static - - Matcher<ComponentName> - - hasPackageName(Matcher<String> packageNameMatcher) - -
    - - - - static - - Matcher<ComponentName> - - hasPackageName(String packageName) - -
    - - - - static - - Matcher<ComponentName> - - hasShortClassName(Matcher<String> shortClassNameMatcher) - -
    - - - - static - - Matcher<ComponentName> - - hasShortClassName(String shortClassName) - -
    + + + static + + + Matcher<ComponentName> + + + hasPackageName(String packageName) + + +
    + + + static + + + Matcher<ComponentName> + + + hasPackageName(Matcher<String> packageNameMatcher) + + +
    + + + static + + + Matcher<ComponentName> + + + hasShortClassName(Matcher<String> shortClassNameMatcher) + + +
    + + + static + + + Matcher<ComponentName> + + + hasShortClassName(String shortClassName) + + +
    @@ -856,207 +470,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1065,16 +748,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1100,233 +773,259 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Matcher<ComponentName> - - hasClassName - (Matcher<String> classNameMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasClassName

    +
    +
    + +
    +
    +Matcher<ComponentName> hasClassName (Matcher<String> classNameMatcher)
    + + + + +

    + + + + + + +
    Parameters
    classNameMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<ComponentName>
    +
    -
    -

    - - public - static - - - - Matcher<ComponentName> - - hasClassName - (String className) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasClassName

    +
    +
    + +
    +
    +Matcher<ComponentName> hasClassName (String className)
    + + + + +

    + + + + + + +
    Parameters
    className + String +
    + + + + + + +
    Returns
    Matcher<ComponentName>
    +
    -
    -

    - - public - static - - - - Matcher<ComponentName> - - hasMyPackageName - () -

    -
    -
    - - - -
    -
    - - - - -

    Matches a component based on the target package name found through the Instrumentation - Registry for the test. -

    +
    +

    hasMyPackageName

    +
    +
    + +
    -
    - - - - -
    -

    - - public - static - +
    +Matcher<ComponentName> hasMyPackageName ()
    + + + +

    Matches a component based on the target package name found through the Instrumentation + Registry for the test. +

    + + + + + + +
    Returns
    Matcher<ComponentName>
    - Matcher<ComponentName> -
    - hasPackageName - (Matcher<String> packageNameMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    -

    - - public - static - - - - Matcher<ComponentName> - - hasPackageName - (String packageName) -

    -
    -
    - - +
    +

    hasPackageName

    +
    +
    + + -
    -
    +
    +
    +Matcher<ComponentName> hasPackageName (String packageName)
    + + + + +

    + + + + + + +
    Parameters
    packageName + String +
    + + + + + + +
    Returns
    Matcher<ComponentName>
    +
    + -

    +
    +

    hasPackageName

    +
    +
    + +
    +
    +Matcher<ComponentName> hasPackageName (Matcher<String> packageNameMatcher)
    + + + + +

    + + + + + + +
    Parameters
    packageNameMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<ComponentName>
    +
    -
    -

    - - public - static - - - - Matcher<ComponentName> - - hasShortClassName - (Matcher<String> shortClassNameMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasShortClassName

    +
    +
    + +
    +
    +Matcher<ComponentName> hasShortClassName (Matcher<String> shortClassNameMatcher)
    + + + + +

    + + + + + + +
    Parameters
    shortClassNameMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<ComponentName>
    +
    -
    -

    - - public - static - - - - Matcher<ComponentName> - - hasShortClassName - (String shortClassName) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasShortClassName

    +
    +
    + +
    +
    +Matcher<ComponentName> hasShortClassName (String shortClassName)
    + + + + +

    + + + + + + +
    Parameters
    shortClassName + String +
    + + + + + + +
    Returns
    Matcher<ComponentName>
    +
    @@ -1338,193 +1037,31 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/intent/matcher/IntentMatchers.html b/docs/html/reference/android/support/test/espresso/intent/matcher/IntentMatchers.html index ce183812206b..ac26ce91db6a 100644 --- a/docs/html/reference/android/support/test/espresso/intent/matcher/IntentMatchers.html +++ b/docs/html/reference/android/support/test/espresso/intent/matcher/IntentMatchers.html @@ -1,4 +1,3 @@ - @@ -93,484 +92,85 @@ - - - - - - -IntentMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +IntentMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    IntentMatchers

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    IntentMatchers

    +

    + + public + + final + + class + IntentMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.intent.matcher.IntentMatchers
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.intent.matcher.IntentMatchers +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of hamcrest matchers for matching Intent objects. +

    A collection of hamcrest matchers for matching Intent objects.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -722,1758 +295,1881 @@ Summary: - - - +
    Public Methods
    + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - static +

    Public methods

    - - - - static - - Matcher<Intent> - - anyIntent() - -
    - - - - static - - Matcher<Intent> - - hasAction(String action) - -
    + +
    + + + static + + + Matcher<Intent> + + + anyIntent() + + +
    + + + static + + + Matcher<Intent> + + + hasAction(String action) + + +
    + + + static + + + Matcher<Intent> + + + hasAction(Matcher<String> actionMatcher) + + +
    + + + static + + + Matcher<Intent> + + + hasCategories(Set<String> categories) + + +
    + + + static + + + Matcher<Intent> + + + hasCategories(Matcher<? extends Iterable<? super String>> categoriesMatcher) + + +
    + + + static + + + Matcher<Intent> + + + hasComponent(String className) + + +

    Returns a matcher that will only match intents targeted to a single class by using + hasClassName(String). + + +

    + +
    + + + static + + + Matcher<Intent> + + + hasComponent(Matcher<ComponentName> componentMatcher) + + +

    Can match an intent by class name, package name or short class name. + + +

    + +
    + + + static + + + Matcher<Intent> + + + hasComponent(ComponentName componentName) + + +

    Returns a matcher that will only match intents targeted to the componentName's class, + . + + +

    + +
    + + + static + + + Matcher<Intent> + + + hasData(Matcher<Uri> uriMatcher) + + +
    + + + static + + + Matcher<Intent> + + + hasData(String uri) + + +
    + + + static + + + Matcher<Intent> + + + hasData(Uri uri) + + +
    + + + static + + + Matcher<Intent> + + + hasExtra(Matcher<String> keyMatcher, Matcher<?> valueMatcher) + + +
    + + + static + + <T> + Matcher<Intent> + + + hasExtra(String key, T value) + + +
    + + + static + + + Matcher<Intent> + + + hasExtraWithKey(Matcher<String> keyMatcher) + + +
    + + + static + + + Matcher<Intent> + + + hasExtraWithKey(String key) + + +
    + + + static + + + Matcher<Intent> + + + hasExtras(Matcher<Bundle> bundleMatcher) + + +
    + + + static + + + Matcher<Intent> + + + hasFlag(int flag) + + +
    + + + static + + + Matcher<Intent> + + + hasFlags(int flags) + + +
    + + + static + + + Matcher<Intent> + + + hasFlags(int... flags) + + +
    + + + static + + + Matcher<Intent> + + + hasPackage(Matcher<String> packageMatcher) + + +
    + + + static + + + Matcher<Intent> + + + hasPackage(String packageName) + + +
    + + + static + + + Matcher<Intent> + + + hasType(Matcher<String> typeMatcher) + + +
    + + + static + + + Matcher<Intent> + + + hasType(String type) + + +
    + + + static + + + Matcher<Intent> + + + isInternal() + + +

    Matches an intent if its package is the same as the target package for the instrumentation + test. + + +

    + +
    + + + static + + + Matcher<Intent> + + + toPackage(String packageName) + + +

    Matches an intent based on the package of activity which can handle the intent. + + +

    + +
    - Matcher<Intent> -
    - hasAction(Matcher<String> actionMatcher) -
    + + + - static - Matcher<Intent> - - + + From +class + + + java.lang.Object + + +
    + +

    Inherited methods

    - hasCategories(Set<String> categories) +
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + Object + + + clone() + + +
    + + + + + + boolean + + + equals(Object arg0) + + +
    + + + + + + void + + + finalize() + + +
    + + + + final + + Class<?> + + + getClass() + + +
    + + + + + + int + + + hashCode() + + +
    + + + + final + + void + + + notify() + + +
    + + + + final + + void + + + notifyAll() + + +
    + + + + + + String + + + toString() + + +
    + + + + final + + void + + + wait(long arg0, int arg1) + + +
    + + + + final + + void + + + wait(long arg0) + + +
    + + + + final + + void + + + wait() + + +
    + + +
    -
    + - static - Matcher<Intent> - - hasCategories(Matcher<? extends Iterable<? super String>> categoriesMatcher) + -
    + + - static - Matcher<Intent> - - hasComponent(ComponentName componentName) -
    - Returns a matcher that will only match intents targeted to the componentName's class, - . + + -
    + + -
    + +
    +

    anyIntent

    +
    +
    + + +
    +
    +Matcher<Intent> anyIntent ()
    + + + + +

    + + + + + + +
    Returns
    Matcher<Intent>
    - static +
    - Matcher<Intent>
    -
    - hasComponent(Matcher<ComponentName> componentMatcher) -
    - Can match an intent by class name, package name or short class name. + +
    +

    hasAction

    +
    +
    + + +
    +
    +Matcher<Intent> hasAction (String action)
    + + + + +

    + + + + + + +
    Parameters
    action + String +
    + + + + + + +
    Returns
    Matcher<Intent>
    -
    +
    -
    + +
    +Matcher<Intent> hasAction (Matcher<String> actionMatcher)
    + + + + +

    + + + + + + +
    Parameters
    actionMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Intent>
    + - static + - Matcher<Intent>
    -
    - hasComponent(String className) +
    +

    hasCategories

    +
    +
    + + -
    - Returns a matcher that will only match intents targeted to a single class by using - hasClassName(String). +
    +
    +Matcher<Intent> hasCategories (Set<String> categories)
    + + + + +

    + + + + + + +
    Parameters
    categories + Set +
    + + + + + + +
    Returns
    Matcher<Intent>
    +
    -
    + -
    + + + + + +
    Parameters
    categoriesMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Intent>
    +
    -
    + +
    +

    hasComponent

    +
    +
    + + - static +
    +
    +Matcher<Intent> hasComponent (String className)
    + + + + +

    Returns a matcher that will only match intents targeted to a single class by using + hasClassName(String). The input string must contain the package name + + short class name. For example hasComponent("com.google.provider.NotePad").

    + + + + + + +
    Parameters
    className + String: + complete class path +
    + + + + + + +
    Returns
    Matcher<Intent>
    - Matcher<Intent>
    -
    - hasData(Matcher<Uri> uriMatcher) + -
    + +
    +Matcher<Intent> hasComponent (Matcher<ComponentName> componentMatcher)
    + + + + +

    Can match an intent by class name, package name or short class name.

    + + + + + + +
    Parameters
    componentMatcher + Matcher: + can be the value of hasClassName(String), + hasPackageName(String) or + hasShortClassName(String) +
    + + + + + + +
    Returns
    Matcher<Intent>
    + - static + - Matcher<Intent>
    -
    - hasData(String uri) +
    +

    hasComponent

    +
    +
    + + -
    + + + + + +
    Parameters
    componentName + ComponentName: + a componentName that has the target class specified +
    + + + + + + +
    Returns
    Matcher<Intent>
    +
    +

    See also:

    + +
    +
    -
    + +
    +

    hasData

    +
    +
    + + - static +
    +
    +Matcher<Intent> hasData (Matcher<Uri> uriMatcher)
    + + + + +

    + + + + + + +
    Parameters
    uriMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Intent>
    - Matcher<Intent>
    -
    - hasData(Uri uri) + -
    + +
    +Matcher<Intent> hasData (String uri)
    + + + + +

    + + + + + + +
    Parameters
    uri + String +
    + + + + + + +
    Returns
    Matcher<Intent>
    + - static + - Matcher<Intent>
    -
    - hasExtra(Matcher<String> keyMatcher, Matcher<?> valueMatcher) +
    +

    hasData

    +
    +
    + + -
    + + + + + +
    Parameters
    uri + Uri +
    + + + + + + +
    Returns
    Matcher<Intent>
    +
    -
    + +
    +

    hasExtra

    +
    +
    + + +
    +
    +Matcher<Intent> hasExtra (Matcher<String> keyMatcher, 
    +                Matcher<?> valueMatcher)
    + + + + +

    + + + + + + + + + + +
    Parameters
    keyMatcher + Matcher +
    valueMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Intent>
    - static - <T> - Matcher<Intent>
    -
    - hasExtra(String key, T value) + -
    + +
    +Matcher<Intent> hasExtra (String key, 
    +                T value)
    + + + + +

    + + + + + + + + + + +
    Parameters
    key + String +
    value + T +
    + + + + + + +
    Returns
    Matcher<Intent>
    + - static + - Matcher<Intent>
    -
    - hasExtraWithKey(String key) +
    +

    hasExtraWithKey

    +
    +
    + + -
    + + + + + +
    Parameters
    keyMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Intent>
    +
    -
    + +
    +

    hasExtraWithKey

    +
    +
    + + +
    +
    +Matcher<Intent> hasExtraWithKey (String key)
    + + + + +

    + + + + + + +
    Parameters
    key + String +
    + + + + + + +
    Returns
    Matcher<Intent>
    - static +
    - Matcher<Intent>
    -
    - hasExtraWithKey(Matcher<String> keyMatcher) -
    + + + + + +
    Parameters
    bundleMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Intent>
    -
    + + - static +
    +

    hasFlag

    +
    +
    + + - Matcher<Intent>
    -
    - hasExtras(Matcher<Bundle> bundleMatcher) + +
    +Matcher<Intent> hasFlag (int flag)
    + + + + +

    + + + + + + +
    Parameters
    flag + int +
    + + + + + + +
    Returns
    Matcher<Intent>
    -
    +
    +

    hasFlags

    +
    +
    + + +
    +
    +Matcher<Intent> hasFlags (int flags)
    + + + + +

    + + + + + + +
    Parameters
    flags + int +
    + + + + + + +
    Returns
    Matcher<Intent>
    +
    - static - Matcher<Intent>
    -
    - hasFlag(int flag) + -
    + + + + + +
    Parameters
    flags + int +
    + + + + + + +
    Returns
    Matcher<Intent>
    +
    -
    + +
    +

    hasPackage

    +
    +
    + + - static +
    +
    +Matcher<Intent> hasPackage (Matcher<String> packageMatcher)
    + + + + +

    + + + + + + +
    Parameters
    packageMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Intent>
    - Matcher<Intent>
    -
    - hasFlags(int... flags) + -
    + +
    +Matcher<Intent> hasPackage (String packageName)
    + + + + +

    + + + + + + +
    Parameters
    packageName + String +
    + + + + + + +
    Returns
    Matcher<Intent>
    + - static + - Matcher<Intent>
    -
    - hasFlags(int flags) +
    +

    hasType

    +
    +
    + + -
    + + + + + +
    Parameters
    typeMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Intent>
    +
    -
    + +
    +

    hasType

    +
    +
    + + +
    +
    +Matcher<Intent> hasType (String type)
    + + + + +

    + + + + + + +
    Parameters
    type + String +
    + + + + + + +
    Returns
    Matcher<Intent>
    - static +
    - Matcher<Intent>
    -
    - hasPackage(String packageName) -
    + +

    Matches an intent if its package is the same as the target package for the instrumentation + test. +

    + + + + + + +
    Returns
    Matcher<Intent>
    + - static + - Matcher<Intent>
    -
    - hasPackage(Matcher<String> packageMatcher) +
    +

    toPackage

    +
    +
    + + -
    + + + + + +
    Parameters
    packageName + String: + packages of activity that can handle the intent +
    + + + + + + +
    Returns
    Matcher<Intent>
    +
    -
    - static + - Matcher<Intent> - - hasType(Matcher<String> typeMatcher) -
    - - static - - Matcher<Intent> - - hasType(String type) - -
    - - - - static - - Matcher<Intent> - - isInternal() - -
    - Matches an intent if its package is the same as the target package for the instrumentation - test. - - - -
    - -
    - - - - static - - Matcher<Intent> - - toPackage(String packageName) - -
    - Matches an intent based on the package of activity which can handle the intent. - - - -
    - -
    - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - anyIntent - () -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasAction - (String action) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasAction - (Matcher<String> actionMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasCategories - (Set<String> categories) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasCategories - (Matcher<? extends Iterable<? super String>> categoriesMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasComponent - (ComponentName componentName) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that will only match intents targeted to the componentName's class, - . For example: - Intent intent = new Intent() - .setComponentName(new ComponentName("com.google.provider", "com.google.provider.Notepad")); - will match all intents targeted to Notepad.java.

    -
    -
    Parameters
    - - - - -
    componentName - a componentName that has the target class specified -
    -
    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasComponent - (Matcher<ComponentName> componentMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Can match an intent by class name, package name or short class name.

    -
    -
    Parameters
    - - - - -
    componentMatcher - can be the value of hasClassName(String), - hasPackageName(String) or - hasShortClassName(String) -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasComponent - (String className) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that will only match intents targeted to a single class by using - hasClassName(String). The input string must contain the package name + - short class name. For example hasComponent("com.google.provider.NotePad").

    -
    -
    Parameters
    - - - - -
    className - complete class path -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasData - (Matcher<Uri> uriMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasData - (String uri) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasData - (Uri uri) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasExtra - (Matcher<String> keyMatcher, Matcher<?> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasExtra - (String key, T value) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasExtraWithKey - (String key) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasExtraWithKey - (Matcher<String> keyMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasExtras - (Matcher<Bundle> bundleMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasFlag - (int flag) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasFlags - (int... flags) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasFlags - (int flags) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasPackage - (String packageName) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasPackage - (Matcher<String> packageMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasType - (Matcher<String> typeMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - hasType - (String type) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - isInternal - () -

    -
    -
    - - - -
    -
    - - - - -

    Matches an intent if its package is the same as the target package for the instrumentation - test. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Intent> - - toPackage - (String packageName) -

    -
    -
    - - - -
    -
    - - - - -

    Matches an intent based on the package of activity which can handle the intent.

    -
    -
    Parameters
    - - - - -
    packageName - packages of activity that can handle the intent -
    -
    - -
    +
    + + +
    - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    - - - - - - diff --git a/docs/html/reference/android/support/test/espresso/intent/matcher/UriMatchers.html b/docs/html/reference/android/support/test/espresso/intent/matcher/UriMatchers.html index aacd7c76dcc9..597156e12fd2 100644 --- a/docs/html/reference/android/support/test/espresso/intent/matcher/UriMatchers.html +++ b/docs/html/reference/android/support/test/espresso/intent/matcher/UriMatchers.html @@ -1,4 +1,3 @@ - @@ -93,484 +92,85 @@ - - - - - - -UriMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +UriMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    UriMatchers

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    UriMatchers

    +

    + + public + + final + + class + UriMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.intent.matcher.UriMatchers
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.intent.matcher.UriMatchers +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of matchers for Uris, which can match Uris on their properties (host, path, +

    A collection of matchers for Uris, which can match Uris on their properties (host, path, ...).

    @@ -674,27 +265,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -723,201 +296,274 @@ Summary: - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - static - - Matcher<Uri> - - hasHost(Matcher<String> hostMatcher) - -
    - - - - static - - Matcher<Uri> - - hasHost(String host) - -
    - - - - static - - Matcher<Uri> - - hasParamWithName(String paramName) - -
    + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - - - - static - - Matcher<Uri> - - hasParamWithName(Matcher<String> paramName) - -
    - - - - static - - Matcher<Uri> - - hasParamWithValue(String paramName, String paramVal) - -
    - - - - static - - Matcher<Uri> - - hasParamWithValue(Matcher<String> paramName, Matcher<String> paramVal) - -
    - - - - static - - Matcher<Uri> - - hasPath(Matcher<String> pathName) - -
    - - - - static - - Matcher<Uri> - - hasPath(String pathName) - -
    - - - - static - - Matcher<Uri> - - hasScheme(Matcher<String> schemeMatcher) - -
    - - - - static - - Matcher<Uri> - - hasScheme(String scheme) - -
    - - - - static - - Matcher<Uri> - - hasSchemeSpecificPart(String scheme, String schemeSpecificPart) - -
    - - - - static - - Matcher<Uri> - - hasSchemeSpecificPart(Matcher<String> schemeMatcher, Matcher<String> schemeSpecificPartMatcher) - -
    + + + static + + + Matcher<Uri> + + + hasHost(Matcher<String> hostMatcher) + + +
    + + + static + + + Matcher<Uri> + + + hasHost(String host) + + +
    + + + static + + + Matcher<Uri> + + + hasParamWithName(Matcher<String> paramName) + + +
    + + + static + + + Matcher<Uri> + + + hasParamWithName(String paramName) + + +
    + + + static + + + Matcher<Uri> + + + hasParamWithValue(String paramName, String paramVal) + + +
    + + + static + + + Matcher<Uri> + + + hasParamWithValue(Matcher<String> paramName, Matcher<String> paramVal) + + +
    + + + static + + + Matcher<Uri> + + + hasPath(String pathName) + + +
    + + + static + + + Matcher<Uri> + + + hasPath(Matcher<String> pathName) + + +
    + + + static + + + Matcher<Uri> + + + hasScheme(String scheme) + + +
    + + + static + + + Matcher<Uri> + + + hasScheme(Matcher<String> schemeMatcher) + + +
    + + + static + + + Matcher<Uri> + + + hasSchemeSpecificPart(Matcher<String> schemeMatcher, Matcher<String> schemeSpecificPartMatcher) + + +
    + + + static + + + Matcher<Uri> + + + hasSchemeSpecificPart(String scheme, String schemeSpecificPart) + + +
    @@ -929,207 +575,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1138,16 +853,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1173,391 +878,479 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Matcher<Uri> - - hasHost - (Matcher<String> hostMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasHost

    +
    +
    + +
    +
    +Matcher<Uri> hasHost (Matcher<String> hostMatcher)
    + + + + +

    + + + + + + +
    Parameters
    hostMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Uri>
    +
    -
    -

    - - public - static - - - - Matcher<Uri> - - hasHost - (String host) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasHost

    +
    +
    + +
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Uri> - - hasParamWithName - (String paramName) -

    -
    -
    +
    +Matcher<Uri> hasHost (String host)
    + + + + +

    + + + + + + +
    Parameters
    host + String +
    + + + + + + +
    Returns
    Matcher<Uri>
    - - -
    -
    - - - - -

    - -
    -
    -

    - - public - static - - - - Matcher<Uri> - - hasParamWithName - (Matcher<String> paramName) -

    -
    -
    - - +
    +

    hasParamWithName

    +
    +
    + + -
    -
    +
    +
    +Matcher<Uri> hasParamWithName (Matcher<String> paramName)
    + + + + +

    + + + + + + +
    Parameters
    paramName + Matcher +
    + + + + + + +
    Returns
    Matcher<Uri>
    +
    + -

    +
    +

    hasParamWithName

    +
    +
    + +
    +
    +Matcher<Uri> hasParamWithName (String paramName)
    + + + + +

    + + + + + + +
    Parameters
    paramName + String +
    + + + + + + +
    Returns
    Matcher<Uri>
    +
    -
    -

    - - public - static - - - - Matcher<Uri> - - hasParamWithValue - (String paramName, String paramVal) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasParamWithValue

    +
    +
    + +
    +
    +Matcher<Uri> hasParamWithValue (String paramName, 
    +                String paramVal)
    + + + + +

    + + + + + + + + + + +
    Parameters
    paramName + String +
    paramVal + String +
    + + + + + + +
    Returns
    Matcher<Uri>
    +
    -
    -

    - - public - static - - - - Matcher<Uri> - - hasParamWithValue - (Matcher<String> paramName, Matcher<String> paramVal) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasParamWithValue

    +
    +
    + +
    -
    - +
    +Matcher<Uri> hasParamWithValue (Matcher<String> paramName, 
    +                Matcher<String> paramVal)
    + + + + +

    + + + + + + + + + + +
    Parameters
    paramName + Matcher +
    paramVal + Matcher +
    + + + + + + +
    Returns
    Matcher<Uri>
    - - -
    -

    - - public - static - - - - Matcher<Uri> - - hasPath - (Matcher<String> pathName) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    -

    - - public - static - - - - Matcher<Uri> - - hasPath - (String pathName) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasPath

    +
    +
    + +
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Uri> - - hasScheme - (Matcher<String> schemeMatcher) -

    -
    -
    - - - -
    -
    +
    +Matcher<Uri> hasPath (String pathName)
    + + + + +

    + + + + + + +
    Parameters
    pathName + String +
    + + + + + + +
    Returns
    Matcher<Uri>
    +
    + -

    +
    +

    hasPath

    +
    +
    + +
    +
    +Matcher<Uri> hasPath (Matcher<String> pathName)
    + + + + +

    + + + + + + +
    Parameters
    pathName + Matcher +
    + + + + + + +
    Returns
    Matcher<Uri>
    +
    -
    -

    - - public - static - - - - Matcher<Uri> - - hasScheme - (String scheme) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasScheme

    +
    +
    + +
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Uri> - - hasSchemeSpecificPart - (String scheme, String schemeSpecificPart) -

    -
    -
    - - - -
    -
    +
    +Matcher<Uri> hasScheme (String scheme)
    + + + + +

    + + + + + + +
    Parameters
    scheme + String +
    + + + + + + +
    Returns
    Matcher<Uri>
    +
    + -

    +
    +

    hasScheme

    +
    +
    + +
    +
    +Matcher<Uri> hasScheme (Matcher<String> schemeMatcher)
    + + + + +

    + + + + + + +
    Parameters
    schemeMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Uri>
    +
    -
    -

    - - public - static - - - - Matcher<Uri> - - hasSchemeSpecificPart - (Matcher<String> schemeMatcher, Matcher<String> schemeSpecificPartMatcher) -

    -
    -
    +
    +

    hasSchemeSpecificPart

    +
    +
    + + +
    +
    +Matcher<Uri> hasSchemeSpecificPart (Matcher<String> schemeMatcher, 
    +                Matcher<String> schemeSpecificPartMatcher)
    + + + + +

    + + + + + + + + + + +
    Parameters
    schemeMatcher + Matcher +
    schemeSpecificPartMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Uri>
    - -
    -
    - +
    + -

    +
    +

    hasSchemeSpecificPart

    +
    +
    + +
    +
    +Matcher<Uri> hasSchemeSpecificPart (String scheme, 
    +                String schemeSpecificPart)
    + + + + +

    + + + + + + + + + + +
    Parameters
    scheme + String +
    schemeSpecificPart + String +
    + + + + + + +
    Returns
    Matcher<Uri>
    +
    @@ -1569,193 +1362,31 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/intent/matcher/package-summary.html b/docs/html/reference/android/support/test/espresso/intent/matcher/package-summary.html index 686bc63a1f84..bd1b2ac0aa61 100644 --- a/docs/html/reference/android/support/test/espresso/intent/matcher/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/intent/matcher/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,758 +92,162 @@ - - - - - - -android.support.test.espresso.intent.matcher | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.intent.matcher - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.intent.matcher

    -
    - -
    - -
    - - - +

    android.support.test.espresso.intent.matcher

    + + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + + + +
    BundleMatchersBundleMatchers - A collection of hamcrest matchers to match Bundle objects.  - - + A collection of hamcrest matchers to match Bundle objects.  + +
    ComponentNameMatchersComponentNameMatchers - A collection of hamcrest matchers to match ComponentName objects.  - - + A collection of hamcrest matchers to match ComponentName objects.  + +
    IntentMatchersIntentMatchers - A collection of hamcrest matchers for matching Intent objects.  - - + A collection of hamcrest matchers for matching Intent objects.  + +
    UriMatchersUriMatchers - A collection of matchers for Uris, which can match Uris on their properties (host, path, + A collection of matchers for Uris, which can match Uris on their properties (host, path, ...).  - - + +
    + + + + + + + -
    -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + +
    +
    + + + +
    + diff --git a/docs/html/reference/android/support/test/espresso/intent/package-summary.html b/docs/html/reference/android/support/test/espresso/intent/package-summary.html index 8f2ac3608e24..5d9f4d5bc6ef 100644 --- a/docs/html/reference/android/support/test/espresso/intent/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/intent/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,831 +92,233 @@ - - - - - - -android.support.test.espresso.intent | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.intent - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.intent

    -
    - -
    - -
    - - +

    android.support.test.espresso.intent

    + +

    Interfaces

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + +
    ResettingStubberResettingStubber A sneaky singleton object used to respond to intents with fake responses.  - - + +
    ResolvedIntentResolvedIntent - An Intent that has been processed to determine the set of packages to which it resolves.  - - + An Intent that has been processed to determine the set of packages to which it resolves.  + +
    VerifiableIntentVerifiableIntent - A ResolvedIntent that can be marked as verified.  - - + A ResolvedIntent that can be marked as verified.  + +
    VerificationModeVerificationMode An interface for different modes of verifying intents.  - - + +
    -
    - - + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + + + + + + + + + +
    ChecksChecks Substitute for Guava Preconditions to avoid guava as a dep.  - - + +
    IntentsIntents Intents enables validation and stubbing of intents sent out by the application under test.  - - + +
    OngoingStubbingOngoingStubbing Supports method chaining after @Intents#intending method call.  - - + +
    ResettingStubberImplResettingStubberImpl - Implementation of ResettingStubber + Implementation of ResettingStubber   + + - +
    VerificationModes + Implementations of VerificationMode.  + +
    + -
    VerificationModes - Implementations of VerificationMode.  + -
    + -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/intent/rule/IntentsTestRule.html b/docs/html/reference/android/support/test/espresso/intent/rule/IntentsTestRule.html index c51c711f82b7..bfd6e75929b1 100644 --- a/docs/html/reference/android/support/test/espresso/intent/rule/IntentsTestRule.html +++ b/docs/html/reference/android/support/test/espresso/intent/rule/IntentsTestRule.html @@ -1,4 +1,3 @@ - @@ -93,502 +92,106 @@ - - - - - - -IntentsTestRule | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +IntentsTestRule - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    IntentsTestRule

    - - - - - - - - - - - - - extends ActivityTestRule<T extends Activity>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

    IntentsTestRule

    +

    + + public + + + + class + IntentsTestRule + +
    + + + + + + + + + + + + + + + + + extends ActivityTestRule<T extends Activity> + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.rule.UiThreadTestRule
        ↳android.support.test.rule.ActivityTestRule<T extends android.app.Activity>
         ↳android.support.test.espresso.intent.rule.IntentsTestRule<T extends android.app.Activity>
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.rule.UiThreadTestRule +
        ↳android.support.test.rule.ActivityTestRule<T extends android.app.Activity> +
         ↳android.support.test.espresso.intent.rule.IntentsTestRule<T extends android.app.Activity> +
    + + +

    - - - -
    - - -

    Class Overview

    -

    This rule makes it easy to use Espresso-Intents APIs in functional UI tests. This class is an - extension of ActivityTestRule, which initializes Espresso-Intents before each test +

    This rule makes it easy to use Espresso-Intents APIs in functional UI tests. This class is an + extension of ActivityTestRule, which initializes Espresso-Intents before each test annotated with Test and releases Espresso-Intents after each test run. The Activity will be terminated after each test and this - rule can be used in the same way as ActivityTestRule. + rule can be used in the same way as ActivityTestRule.

    Espresso-Intents APIs can be used in two ways:

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -780,57 +362,49 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Constructors
    - - - - - - - - IntentsTestRule(Class<T> activityClass) - -
    - - - - - - - - IntentsTestRule(Class<T> activityClass, boolean initialTouchMode) - -
    - - - - - - - - IntentsTestRule(Class<T> activityClass, boolean initialTouchMode, boolean launchActivity) - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + IntentsTestRule(Class<T> activityClass) + + +
    + + IntentsTestRule(Class<T> activityClass, boolean initialTouchMode) + + +
    + + IntentsTestRule(Class<T> activityClass, boolean initialTouchMode, boolean launchActivity) + + +
    @@ -843,58 +417,67 @@ Summary: - - - - - - - -
    Protected Methods
    - - - - - - void - - afterActivityFinished() - -
    - Override this method to execute any code that should run after your Activity is + + + + + + + + + + + + - - - - - - + + + + + + + + + + - + + +

    + + + +

    Protected methods

    + + + + + + void + + + afterActivityFinished() + + +

    Override this method to execute any code that should run after your Activity is finished. - - - - - -

    - - - - - - void - - afterActivityLaunched() - -
    - Override this method to execute any code that should run after your Activity is + + +

    + +
    + + + + + + void + + + afterActivityLaunched() + + +

    Override this method to execute any code that should run after your Activity is launched, but before any test code is run including any method annotated with Before. - - - - - -

    @@ -904,183 +487,218 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1088,80 +706,100 @@ From class - @@ -1169,201 +807,271 @@ From class - @@ -1371,41 +1079,51 @@ From class - @@ -1414,16 +1132,6 @@ From interface

    Inherited methods

    - -From class - - android.support.test.rule.ActivityTestRule + + From +class + + + android.support.test.rule.ActivityTestRule + +
    - -From class - - android.support.test.rule.UiThreadTestRule + + From +class + + + android.support.test.rule.UiThreadTestRule + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - org.junit.rules.TestRule + + From +interface + + + org.junit.rules.TestRule + +
    -
    - - - - - - - - - @@ -1441,103 +1149,118 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - IntentsTestRule - (Class<T> activityClass) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    IntentsTestRule

    +
    +
    + +
    +
    +IntentsTestRule (Class<T> activityClass)
    + + + + +

    + + + + + + +
    Parameters
    activityClass + Class +
    +
    -
    -

    - - public - - - - - - - IntentsTestRule - (Class<T> activityClass, boolean initialTouchMode) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    IntentsTestRule

    +
    +
    + +
    +
    +IntentsTestRule (Class<T> activityClass, 
    +                boolean initialTouchMode)
    + + + + +

    + + + + + + + + + + +
    Parameters
    activityClass + Class +
    initialTouchMode + boolean +
    +
    -
    -

    - - public - - - - - - - IntentsTestRule - (Class<T> activityClass, boolean initialTouchMode, boolean launchActivity) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    IntentsTestRule

    +
    +
    + +
    +
    +IntentsTestRule (Class<T> activityClass, 
    +                boolean initialTouchMode, 
    +                boolean launchActivity)
    + + + + +

    + + + + + + + + + + + + + + +
    Parameters
    activityClass + Class +
    initialTouchMode + boolean +
    launchActivity + boolean +
    +
    @@ -1556,73 +1279,52 @@ From interface -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - - - void - - afterActivityFinished - () -

    -
    -
    - - - -
    -
    - - +
    +

    afterActivityFinished

    +
    +
    + + +
    +
    +void afterActivityFinished ()
    + + -

    Override this method to execute any code that should run after your Activity is + +

    Override this method to execute any code that should run after your Activity is finished. This method is called after each test method, including any method annotated with After. -

    +

    -
    -
    -

    - - protected - - - - - void - - afterActivityLaunched - () -

    -
    -
    - - - -
    -
    - - +
    +

    afterActivityLaunched

    +
    +
    + + +
    +
    +void afterActivityLaunched ()
    + + -

    Override this method to execute any code that should run after your Activity is + +

    Override this method to execute any code that should run after your Activity is launched, but before any test code is run including any method annotated with Before.

    @@ -1631,9 +1333,8 @@ From interface over this method. This method should usually not be overwritten directly in tests and only be used by subclasses of ActivityTestRule to get notified when the activity is created and visible but test runs. -

    +

    -
    @@ -1641,193 +1342,28 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/intent/rule/package-summary.html b/docs/html/reference/android/support/test/espresso/intent/rule/package-summary.html index 543f44236e35..d6bcefaf3e0d 100644 --- a/docs/html/reference/android/support/test/espresso/intent/rule/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/intent/rule/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,721 +92,125 @@ - - - - - - -android.support.test.espresso.intent.rule | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.intent.rule - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.intent.rule

    -
    - -
    - -
    - - - +

    android.support.test.espresso.intent.rule

    + + +

    Classes

    -
    - - + + - + - + + + +
    IntentsTestRule<T extends Activity>IntentsTestRule<T extends Activity> This rule makes it easy to use Espresso-Intents APIs in functional UI tests.  - - + +
    + -
    -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + + + + + +
    + + +
    + + + +
    + diff --git a/docs/html/reference/android/support/test/espresso/matcher/BoundedMatcher.html b/docs/html/reference/android/support/test/espresso/matcher/BoundedMatcher.html index 796063dfc8bf..e019a3908867 100644 --- a/docs/html/reference/android/support/test/espresso/matcher/BoundedMatcher.html +++ b/docs/html/reference/android/support/test/espresso/matcher/BoundedMatcher.html @@ -1,5 +1,3 @@ - - @@ -92,514 +90,108 @@ - - - - - - - -BoundedMatcher | Android Developers - - - - - - - - - - - - - - - - - - - -
    - + - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - abstract - class -

    BoundedMatcher

    - - - - - - - - - extends BaseMatcher<T>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - +

    BoundedMatcher

    +

    + + public + + + abstract + class + BoundedMatcher + +
    + + + + + + + + + + + extends BaseMatcher<T> + + + + + + + + + + + +

    java.lang.Object
       ↳org.hamcrest.BaseMatcher<T>
        ↳android.support.test.espresso.matcher.BoundedMatcher<T, S extends T>
    + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳org.hamcrest.BaseMatcher<T> +
        ↳android.support.test.espresso.matcher.BoundedMatcher<T, S extends T> +
    - - - - - +
    - + +
    + Known Direct Subclasses - +
    -
    - - +
    + + + -
    +

    -

    Class Overview

    -

    Some matcher sugar that lets you create a matcher for a given type +

    Some matcher sugar that lets you create a matcher for a given type but only process items of a specific subtype of that matcher.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -808,41 +378,36 @@ Summary: - - - - - - - - - - - - - - - +
    Public Constructors
    - - - - - - - - BoundedMatcher(Class<? extends S> expectedType) - -
    - - - - - - - - BoundedMatcher(Class<?> expectedType, Class<?> interfaceType1, Class...<?> otherInterfaces) - -
    + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + BoundedMatcher(Class<? extends S> expectedType) + + +
    + + BoundedMatcher(Class<?> expectedType, Class<?> interfaceType1, Class...<?> otherInterfaces) + + +
    @@ -853,25 +418,32 @@ Summary: - - - +
    Public Methods
    + - - - + + + + + + + + +

    Public methods

    - - - final - - - boolean - - matches(Object item) - -
    + + + + final + + boolean + + + matches(Object item) + + +
    @@ -880,25 +452,32 @@ Summary: - +
    Protected Methods
    + - - - - - + + + + + + + + +

    Protected methods

    - abstract - - - - - boolean - - matchesSafely(S item) - -
    + abstract + + + + + boolean + + + matchesSafely(S item) + + +
    @@ -908,79 +487,100 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -988,201 +588,271 @@ From class - @@ -1190,73 +860,95 @@ From class - @@ -1264,41 +956,51 @@ From interface - + + + + + + + + + +

    Inherited methods

    - -From class - - org.hamcrest.BaseMatcher + + From +class + + + org.hamcrest.BaseMatcher + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - org.hamcrest.Matcher + + From +interface + + + org.hamcrest.Matcher + +
    - -From interface - - org.hamcrest.SelfDescribing + + From +interface + + + org.hamcrest.SelfDescribing + +
    + abstract + + + + + void + + + describeTo(Description arg0) + + +
    -
    - - - - - - - - - @@ -1334,71 +1026,81 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - BoundedMatcher - (Class<? extends S> expectedType) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    BoundedMatcher

    +
    +
    + +
    +
    +BoundedMatcher (Class<? extends S> expectedType)
    + + + + +

    + + + + + + +
    Parameters
    expectedType + Class +
    +
    -
    -

    - - public - - - - - - - BoundedMatcher - (Class<?> expectedType, Class<?> interfaceType1, Class...<?> otherInterfaces) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    BoundedMatcher

    +
    +
    + +
    +
    +BoundedMatcher (Class<?> expectedType, 
    +                Class<?> interfaceType1, 
    +                Class...<?> otherInterfaces)
    + + + + +

    + + + + + + + + + + + + + + +
    Parameters
    expectedType + Class +
    interfaceType1 + Class +
    otherInterfaces + Class +
    +
    @@ -1413,39 +1115,44 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - final - - - boolean - - matches - (Object item) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    matches

    +
    +
    + +
    +
    +boolean matches (Object item)
    + + + + +

    + + + + + + +
    Parameters
    item + Object +
    + + + + + + +
    Returns
    boolean
    +
    @@ -1454,39 +1161,44 @@ From interface -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - abstract - - boolean - - matchesSafely - (S item) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    matchesSafely

    +
    +
    + +
    +
    +boolean matchesSafely (S item)
    + + + + +

    + + + + + + +
    Parameters
    item + S +
    + + + + + + +
    Returns
    boolean
    +
    @@ -1494,193 +1206,39 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/matcher/CursorMatchers.CursorMatcher.html b/docs/html/reference/android/support/test/espresso/matcher/CursorMatchers.CursorMatcher.html index 2972f622c26c..1b6d35bf99a3 100644 --- a/docs/html/reference/android/support/test/espresso/matcher/CursorMatchers.CursorMatcher.html +++ b/docs/html/reference/android/support/test/espresso/matcher/CursorMatchers.CursorMatcher.html @@ -1,4 +1,3 @@ - @@ -93,520 +92,113 @@ - - - - - - -CursorMatchers.CursorMatcher | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +CursorMatchers.CursorMatcher - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - class -

    CursorMatchers.CursorMatcher

    - - - - - - - - - - - - - extends BoundedMatcher<T, S extends T>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

    CursorMatchers.CursorMatcher

    +

    + + public + static + + + class + CursorMatchers.CursorMatcher + +
    + + + + + + + + + + + + + + + + + extends BoundedMatcher<Object, Cursor> + + + + + + + + + + + +

    java.lang.Object
       ↳org.hamcrest.BaseMatcher<T>
        ↳android.support.test.espresso.matcher.BoundedMatcher<T, S extends T>
         ↳android.support.test.espresso.matcher.CursorMatchers.CursorMatcher
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳org.hamcrest.BaseMatcher<java.lang.Object> +
        ↳android.support.test.espresso.matcher.BoundedMatcher<java.lang.Object, android.database.Cursor> +
         ↳android.support.test.espresso.matcher.CursorMatchers.CursorMatcher +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A Matcher that matches Cursors based on values in their columns. +

    A Matcher that matches Cursors based on values in their columns.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -788,65 +359,82 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - void - - describeTo(Description description) - -
    - - - - - - boolean - - matchesSafely(Cursor cursor) - -
    - - - - - - CursorMatchers.CursorMatcher - - withStrictColumnChecks(boolean checkColumns) - -
    - Allows test authors to override whether the the matcher should throw an - IllegalArgumentException if the column name/count is not valid. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + describeTo(Description description) + + +
    + + + + + + boolean + + + matchesSafely(Cursor cursor) + + +
    + + + + + + CursorMatchers.CursorMatcher + + + withStrictColumnChecks(boolean checkColumns) + + +

    Allows test authors to override whether the the matcher should throw an + IllegalArgumentException if the column name/count is not valid. + + +

    + +
    @@ -858,63 +446,78 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -922,73 +525,95 @@ From class - @@ -996,201 +621,271 @@ From class - @@ -1198,73 +893,95 @@ From class - @@ -1272,41 +989,51 @@ From interface - @@ -1315,16 +1042,6 @@ From interface

    Inherited methods

    - -From class - - android.support.test.espresso.matcher.BoundedMatcher + + From +class + + + android.support.test.espresso.matcher.BoundedMatcher + +
    - -From class - - org.hamcrest.BaseMatcher + + From +class + + + org.hamcrest.BaseMatcher + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - org.hamcrest.Matcher + + From +interface + + + org.hamcrest.Matcher + +
    - -From interface - - org.hamcrest.SelfDescribing + + From +interface + + + org.hamcrest.SelfDescribing + +
    -
    - - - - - - - - - @@ -1350,107 +1067,115 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - void - - describeTo - (Description description) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    describeTo

    +
    +
    + +
    +
    +void describeTo (Description description)
    + + + + +

    + + + + + + +
    Parameters
    description + Description +
    +
    -
    -

    - - public - - - - - boolean - - matchesSafely - (Cursor cursor) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    matchesSafely

    +
    +
    + +
    +
    +boolean matchesSafely (Cursor cursor)
    + + + + +

    + + + + + + +
    Parameters
    cursor + Cursor +
    + + + + + + +
    Returns
    boolean
    +
    -
    -

    - - public - +
    +

    withStrictColumnChecks

    +
    +
    + + - - - CursorMatchers.CursorMatcher - - withStrictColumnChecks - (boolean checkColumns) -

    -
    -
    - - - -
    -
    - - - - -

    Allows test authors to override whether the the matcher should throw an - IllegalArgumentException if the column name/count is not valid. This is useful in the +

    +
    +CursorMatchers.CursorMatcher withStrictColumnChecks (boolean checkColumns)
    + + + + +

    Allows test authors to override whether the the matcher should throw an + IllegalArgumentException if the column name/count is not valid. This is useful in the case where a cursor may iterates over a data set with variable columns. By default, the checks are on. -

    +

    + + + + + + +
    Parameters
    checkColumns + boolean +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    @@ -1462,193 +1187,39 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/matcher/CursorMatchers.html b/docs/html/reference/android/support/test/espresso/matcher/CursorMatchers.html index fad8f56c8382..ccd7b9d8c583 100644 --- a/docs/html/reference/android/support/test/espresso/matcher/CursorMatchers.html +++ b/docs/html/reference/android/support/test/espresso/matcher/CursorMatchers.html @@ -1,4 +1,3 @@ - @@ -93,492 +92,85 @@ - - - - - - -CursorMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +CursorMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public +

    CursorMatchers

    +

    + + public + + final + + class + CursorMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + - final +
    java.lang.Object +
       ↳android.support.test.espresso.matcher.CursorMatchers +
    + - class -

    CursorMatchers

    + +

    +

    A collection of Hamcrest matchers that matches a data row in a Cursor. +
    +

    + AdapterViews that are backed by a Cursor are very common. This class contains + + Matchers that can be used together with + onData(Matcher) to match a + data row in a Cursor. + The + Matchers can only operate on a single data row of the cursor and Espresso + internally moves the Cursor to the correct adapter position. +

    +

    - extends Object
    +

    Summary

    + + + + + + + + + + + + - -
    -
    -

    Nested classes

    + + + + + class + CursorMatchers.CursorMatcher +

    A Matcher that matches Cursors based on values in their columns.  + + +

    +
    - - - - - - - -
    java.lang.Object
       ↳android.support.test.espresso.matcher.CursorMatchers
    @@ -673,33 +328,1000 @@ Summary: -
    -

    Class Overview

    -

    A collection of Hamcrest matchers that matches a data row in a Cursor. -
    -

    - AdapterViews that are backed by a Cursor are very common. This class contains - - Matchers that can be used together with - onData(Matcher) to match a - data row in a Cursor. - The - Matchers can only operate on a single data row of the cursor and Espresso - internally moves the Cursor to the correct adapter position. -

    -

    + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + static + + + CursorMatchers.CursorMatcher + + + withRowBlob(int columnIndex, Matcher<byte[]> valueMatcher) + + +

    Returns a matcher that matches a byte[] at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowBlob(Matcher<String> columnPicker, Matcher<byte[]> valueMatcher) + + +

    Returns a matcher that matches a byte[] at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowBlob(String columnName, Matcher<byte[]> valueMatcher) + + +

    Returns a matcher that matches a byte[] at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowBlob(String columnName, byte[] value) + + +

    Returns a matcher that matches a byte[] at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowBlob(int columnIndex, byte[] value) + + +

    Returns a matcher that matches a byte[] at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowDouble(int columnIndex, Matcher<Double> valueMatcher) + + +

    Returns a matcher that matches a Double value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowDouble(String columnName, double value) + + +

    Returns a matcher that matches a Double value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowDouble(Matcher<String> columnNameMatcher, Matcher<Double> valueMatcher) + + +

    Returns a matcher that matches a Double value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowDouble(int columnIndex, double value) + + +

    Returns a matcher that matches a Double value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowDouble(String columnName, Matcher<Double> valueMatcher) + + +

    Returns a matcher that matches a Double value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowFloat(String columnName, Matcher<Float> valueMatcher) + + +

    Returns a matcher that matches a Float value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowFloat(Matcher<String> columnNameMatcher, Matcher<Float> valueMatcher) + + +

    Returns a matcher that matches a Float value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowFloat(String columnName, float value) + + +

    Returns a matcher that matches a Float value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowFloat(int columnIndex, Matcher<Float> valueMatcher) + + +

    Returns a matcher that matches a Float value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowFloat(int columnIndex, float value) + + +

    Returns a matcher that matches a Float value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowInt(String columnName, Matcher<Integer> valueMatcher) + + +

    Returns a matcher that matches a Integer value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowInt(String columnName, int value) + + +

    Returns a matcher that matches a Integer value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowInt(Matcher<String> columnNameMatcher, Matcher<Integer> valueMatcher) + + +

    Returns a matcher that matches a Integer value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowInt(int columnIndex, int value) + + +

    Returns a matcher that matches a Integer value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowInt(int columnIndex, Matcher<Integer> valueMatcher) + + +

    Returns a matcher that matches a Integer value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowLong(String columnName, long value) + + +

    Returns a matcher that matches a Long value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowLong(int columnIndex, long value) + + +

    Returns a matcher that matches a Long value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowLong(Matcher<String> columnNameMatcher, Matcher<Long> valueMatcher) + + +

    Returns a matcher that matches a Long value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowLong(String columnName, Matcher<Long> valueMatcher) + + +

    Returns a matcher that matches a Long value at a given column index in a + Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowLong(int columnIndex, Matcher<Long> valueMatcher) + + +

    Returns a matcher that matches a Long value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowShort(int columnIndex, Matcher<Short> valueMatcher) + + +

    Returns a matcher that matches a Short value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowShort(String columnName, short value) + + +

    Returns a matcher that matches a Short value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowShort(Matcher<String> columnNameMatcher, Matcher<Short> valueMatcher) + + +

    Returns a matcher that matches a Short value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowShort(String columnName, Matcher<Short> valueMatcher) + + +

    Returns a matcher that matches a Short value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowShort(int columnIndex, short value) + + +

    Returns a matcher that matches a Short value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowString(int columnIndex, Matcher<String> valueMatcher) + + +

    Returns a matcher that matches a String value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowString(String columnName, Matcher<String> valueMatcher) + + +

    Returns a matcher that matches a String value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowString(String columnName, String value) + + +

    Returns a matcher that matches a String value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowString(int columnIndex, String value) + + +

    Returns a matcher that matches a String value at a given column index + in a Cursors data row. + + +

    + +
    + + + static + + + CursorMatchers.CursorMatcher + + + withRowString(Matcher<String> columnPicker, Matcher<String> valueMatcher) + + +

    Returns a matcher that matches a String value at a given column index + in a Cursors data row. + + +

    + +
    @@ -707,2903 +1329,2012 @@ Summary: + + + + + -
    +

    Inherited methods

    + From +class + + + java.lang.Object + + +
    + + +
    +
    -

    Summary

    + - - + + - - - - - + + +

    Public methods

    + +
    +

    withRowBlob

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowBlob (int columnIndex, 
    +                Matcher<byte[]> valueMatcher)
    + + + + +

    Returns a matcher that matches a byte[] at a given column index + in a Cursors data row. +

    +
    Nested Classes
    + + - classCursorMatchers.CursorMatcher - A Matcher that matches Cursors based on values in their columns.  + + -
    + + + + + + + + + +
    Parameters
    columnIndex + int: + int column index
    valueMatcher + Matcher: + a + + Matcher that matches a byte[] +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    +
    + +
    +

    withRowBlob

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowBlob (Matcher<String> columnPicker, 
    +                Matcher<byte[]> valueMatcher)
    + + + + +

    Returns a matcher that matches a byte[] at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnPicker + Matcher: + as a + + Matcher of String
    valueMatcher + Matcher: + a + + Matcher that matches a byte[] +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    +
    + +
    +

    withRowBlob

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowBlob (String columnName, 
    +                Matcher<byte[]> valueMatcher)
    + + + + +

    Returns a matcher that matches a byte[] at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnName + String: + as a String
    valueMatcher + Matcher: + a + + Matcher that matches a byte[] +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    +
    + +
    +

    withRowBlob

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowBlob (String columnName, 
    +                byte[] value)
    + + + + +

    Returns a matcher that matches a byte[] at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnName + String: + as a String
    value + byte: + byte[] to match +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    +
    + +
    +

    withRowBlob

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowBlob (int columnIndex, 
    +                byte[] value)
    + + + + +

    Returns a matcher that matches a byte[] at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnIndex + int: + int column index
    value + byte: + byte[] to match +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    - - + + +
    +

    withRowDouble

    +
    +
    + + -
    - - +
    +

    withRowDouble

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowDouble (Matcher<String> columnNameMatcher, 
    +                Matcher<Double> valueMatcher)
    + + + + +

    Returns a matcher that matches a Double value at a given column index + in a Cursors data row. +

    +
    Public Methods
    + +
    +CursorMatchers.CursorMatcher withRowDouble (int columnIndex, 
    +                Matcher<Double> valueMatcher)
    + + + + +

    Returns a matcher that matches a Double value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnIndex + int: + int column index
    valueMatcher + Matcher: + a + + Matcher that matches a Double value +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    + - static + - CursorMatchers.CursorMatcher
    -
    - withRowBlob(String columnName, byte[] value) +
    +

    withRowDouble

    +
    +
    + + -
    - Returns a matcher that matches a byte[] at a given column index - in a Cursors data row. +
    +
    +CursorMatchers.CursorMatcher withRowDouble (String columnName, 
    +                double value)
    + + + + +

    Returns a matcher that matches a Double value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnName + String: + as a String
    value + double: + a double value to match +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    +
    -
    + -
    + + + + + + + + + +
    Parameters
    columnNameMatcher + Matcher: + as a + + Matcher of String
    valueMatcher + Matcher: + a + + Matcher that matches a Double value +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    +
    -
    + +
    +

    withRowDouble

    +
    +
    + + - static +
    +
    +CursorMatchers.CursorMatcher withRowDouble (int columnIndex, 
    +                double value)
    + + + + +

    Returns a matcher that matches a Double value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnIndex + int: + int column index
    value + double: + a double value to match +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    - CursorMatchers.CursorMatcher
    -
    - withRowBlob(int columnIndex, Matcher<byte[]> valueMatcher) + -
    - Returns a matcher that matches a byte[] at a given column index - in a Cursors data row. + +
    +

    withRowDouble

    +
    +
    + + -
    +
    +
    +CursorMatchers.CursorMatcher withRowDouble (String columnName, 
    +                Matcher<Double> valueMatcher)
    + + + + +

    Returns a matcher that matches a Double value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnName + String: + as a String
    valueMatcher + Matcher: + a + + Matcher that matches a Double value +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    +
    +

    withRowFloat

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowFloat (String columnName, 
    +                Matcher<Float> valueMatcher)
    + + + + +

    Returns a matcher that matches a Float value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnName + String: + as a String
    valueMatcher + Matcher: + a + + Matcher that matches a Float value +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    +
    - static - CursorMatchers.CursorMatcher
    -
    - withRowBlob(int columnIndex, byte[] value) + -
    - Returns a matcher that matches a byte[] at a given column index - in a Cursors data row. +
    +

    withRowFloat

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowFloat (Matcher<String> columnNameMatcher, 
    +                Matcher<Float> valueMatcher)
    + + + + +

    Returns a matcher that matches a Float value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnNameMatcher + Matcher: + as a + + Matcher of String
    valueMatcher + Matcher: + a + + Matcher that matches a Float value +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    +
    -
    -
    + + + + + + + + + +
    Parameters
    columnName + String: + as a String
    value + float: + a float value to match +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    + + - static +
    +

    withRowFloat

    +
    - withRowBlob(String columnName, Matcher<byte[]> valueMatcher) + +
    +CursorMatchers.CursorMatcher withRowFloat (int columnIndex, 
    +                Matcher<Float> valueMatcher)
    + + + + +

    Returns a matcher that matches a Float value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnIndex + int: + int column index
    valueMatcher + Matcher: + a + + Matcher that matches a Float value +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - Returns a matcher that matches a byte[] at a given column index - in a Cursors data row. +
    + - +
    +

    withRowFloat

    +
    +
    + + -
    + + + + + + + + + +
    Parameters
    columnIndex + int: + int column index
    value + float: + a float value to match +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    +
    -
    + +
    +

    withRowInt

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowInt (String columnName, 
    +                Matcher<Integer> valueMatcher)
    + + + + +

    Returns a matcher that matches a Integer value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnName + String: + as a String
    valueMatcher + Matcher: + a + + Matcher that matches a Integer value +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    - static +
    - CursorMatchers.CursorMatcher
    -
    - withRowBlob(Matcher<String> columnPicker, Matcher<byte[]> valueMatcher) -
    - Returns a matcher that matches a byte[] at a given column index - in a Cursors data row. + +
    +

    withRowInt

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowInt (String columnName, 
    +                int value)
    + + + + +

    Returns a matcher that matches a Integer value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnName + String: + as a String
    value + int: + a int value to match +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowDouble(String columnName, double value) - -
    - Returns a matcher that matches a Double value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowDouble(String columnName, Matcher<Double> valueMatcher) - -
    - Returns a matcher that matches a Double value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowDouble(int columnIndex, double value) - -
    - Returns a matcher that matches a Double value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowDouble(Matcher<String> columnNameMatcher, Matcher<Double> valueMatcher) - -
    - Returns a matcher that matches a Double value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowDouble(int columnIndex, Matcher<Double> valueMatcher) - -
    - Returns a matcher that matches a Double value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowFloat(String columnName, Matcher<Float> valueMatcher) - -
    - Returns a matcher that matches a Float value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowFloat(int columnIndex, float value) - -
    - Returns a matcher that matches a Float value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowFloat(String columnName, float value) - -
    - Returns a matcher that matches a Float value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowFloat(Matcher<String> columnNameMatcher, Matcher<Float> valueMatcher) - -
    - Returns a matcher that matches a Float value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowFloat(int columnIndex, Matcher<Float> valueMatcher) - -
    - Returns a matcher that matches a Float value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowInt(String columnName, Matcher<Integer> valueMatcher) - -
    - Returns a matcher that matches a Integer value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowInt(int columnIndex, int value) - -
    - Returns a matcher that matches a Integer value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowInt(String columnName, int value) - -
    - Returns a matcher that matches a Integer value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowInt(int columnIndex, Matcher<Integer> valueMatcher) - -
    - Returns a matcher that matches a Integer value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowInt(Matcher<String> columnNameMatcher, Matcher<Integer> valueMatcher) - -
    - Returns a matcher that matches a Integer value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowLong(int columnIndex, Matcher<Long> valueMatcher) - -
    - Returns a matcher that matches a Long value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowLong(int columnIndex, long value) - -
    - Returns a matcher that matches a Long value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowLong(String columnName, long value) - -
    - Returns a matcher that matches a Long value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowLong(String columnName, Matcher<Long> valueMatcher) - -
    - Returns a matcher that matches a Long value at a given column index in a - Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowLong(Matcher<String> columnNameMatcher, Matcher<Long> valueMatcher) - -
    - Returns a matcher that matches a Long value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowShort(int columnIndex, Matcher<Short> valueMatcher) - -
    - Returns a matcher that matches a Short value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowShort(String columnName, Matcher<Short> valueMatcher) - -
    - Returns a matcher that matches a Short value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowShort(String columnName, short value) - -
    - Returns a matcher that matches a Short value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowShort(Matcher<String> columnNameMatcher, Matcher<Short> valueMatcher) - -
    - Returns a matcher that matches a Short value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowShort(int columnIndex, short value) - -
    - Returns a matcher that matches a Short value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowString(String columnName, String value) - -
    - Returns a matcher that matches a String value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowString(int columnIndex, Matcher<String> valueMatcher) - -
    - Returns a matcher that matches a String value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowString(int columnIndex, String value) - -
    - Returns a matcher that matches a String value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowString(String columnName, Matcher<String> valueMatcher) - -
    - Returns a matcher that matches a String value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - static - - CursorMatchers.CursorMatcher - - withRowString(Matcher<String> columnPicker, Matcher<String> valueMatcher) - -
    - Returns a matcher that matches a String value at a given column index - in a Cursors data row. - - - -
    - -
    - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowBlob - (String columnName, byte[] value) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a byte[] at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnName - as a String
    value - byte[] to match -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowBlob - (int columnIndex, Matcher<byte[]> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a byte[] at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnIndex - int column index
    valueMatcher - a - - Matcher that matches a byte[] -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowBlob - (int columnIndex, byte[] value) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a byte[] at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnIndex - int column index
    value - byte[] to match -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowBlob - (String columnName, Matcher<byte[]> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a byte[] at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnName - as a String
    valueMatcher - a - - Matcher that matches a byte[] -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowBlob - (Matcher<String> columnPicker, Matcher<byte[]> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a byte[] at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnPicker - as a - - Matcher of String
    valueMatcher - a - - Matcher that matches a byte[] -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowDouble - (String columnName, double value) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Double value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnName - as a String
    value - a double value to match -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowDouble - (String columnName, Matcher<Double> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Double value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnName - as a String
    valueMatcher - a - - Matcher that matches a Double value -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowDouble - (int columnIndex, double value) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Double value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnIndex - int column index
    value - a double value to match -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowDouble - (Matcher<String> columnNameMatcher, Matcher<Double> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Double value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnNameMatcher - as a - - Matcher of String
    valueMatcher - a - - Matcher that matches a Double value -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowDouble - (int columnIndex, Matcher<Double> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Double value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnIndex - int column index
    valueMatcher - a - - Matcher that matches a Double value -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowFloat - (String columnName, Matcher<Float> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Float value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnName - as a String
    valueMatcher - a - - Matcher that matches a Float value -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowFloat - (int columnIndex, float value) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Float value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnIndex - int column index
    value - a float value to match -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowFloat - (String columnName, float value) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Float value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnName - as a String
    value - a float value to match -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowFloat - (Matcher<String> columnNameMatcher, Matcher<Float> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Float value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnNameMatcher - as a - - Matcher of String
    valueMatcher - a - - Matcher that matches a Float value -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowFloat - (int columnIndex, Matcher<Float> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Float value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnIndex - int column index
    valueMatcher - a - - Matcher that matches a Float value -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowInt - (String columnName, Matcher<Integer> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Integer value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnName - as a String
    valueMatcher - a - - Matcher that matches a Integer value -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowInt - (int columnIndex, int value) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Integer value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnIndex - int column index
    value - a int value to match -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowInt - (String columnName, int value) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Integer value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnName - as a String
    value - a int value to match -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowInt - (int columnIndex, Matcher<Integer> valueMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a Integer value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - - -
    columnIndex - int column index
    valueMatcher - a - - Matcher that matches a Integer value -
    -
    - -
    -
    +
    -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowInt - (Matcher<String> columnNameMatcher, Matcher<Integer> valueMatcher) -

    -
    -
    - - +
    +

    withRowInt

    +
    +
    + + -
    -
    - - - - -

    Returns a matcher that matches a Integer value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - +
    columnNameMatcher - as a + +
    +CursorMatchers.CursorMatcher withRowInt (Matcher<String> columnNameMatcher, 
    +                Matcher<Integer> valueMatcher)
    + + + + +

    Returns a matcher that matches a Integer value at a given column index + in a Cursors data row. +

    + + + + + - - - + + + + - -
    Parameters
    columnNameMatcher + Matcher: + as a - Matcher of String
    valueMatcher - a + Matcher of String
    valueMatcher + Matcher: + a - Matcher that matches a Integer value + Matcher that matches a Integer value
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowLong - (int columnIndex, Matcher<Long> valueMatcher) -

    -
    -
    - - - -
    -
    - - + +
    +

    withRowInt

    +
    +
    + + -

    Returns a matcher that matches a Long value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnIndex - int column index
    valueMatcher - a - - Matcher that matches a Long value + +
    +CursorMatchers.CursorMatcher withRowInt (int columnIndex, 
    +                int value)
    + + + + +

    Returns a matcher that matches a Integer value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnIndex + int: + int column index
    value + int: + a int value to match
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowLong - (int columnIndex, long value) -

    -
    -
    - - - -
    -
    - - + +
    +

    withRowInt

    +
    +
    + + -

    Returns a matcher that matches a Long value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnIndex - int column index
    value - a long value to match + +
    +CursorMatchers.CursorMatcher withRowInt (int columnIndex, 
    +                Matcher<Integer> valueMatcher)
    + + + + +

    Returns a matcher that matches a Integer value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnIndex + int: + int column index
    valueMatcher + Matcher: + a + + Matcher that matches a Integer value
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowLong - (String columnName, long value) -

    -
    -
    - - - -
    -
    - - +
    +

    withRowLong

    +
    +
    + + - -

    Returns a matcher that matches a Long value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnName - as a String
    value - a long value to match + +
    +CursorMatchers.CursorMatcher withRowLong (String columnName, 
    +                long value)
    + + + + +

    Returns a matcher that matches a Long value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnName + String: + as a String
    value + long: + a long value to match
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowLong - (String columnName, Matcher<Long> valueMatcher) -

    -
    -
    - - - -
    -
    - - + +
    +

    withRowLong

    +
    +
    + + -

    Returns a matcher that matches a Long value at a given column index in a - Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnName - as a String
    valueMatcher - a - - Matcher that matches a Long value + +
    +CursorMatchers.CursorMatcher withRowLong (int columnIndex, 
    +                long value)
    + + + + +

    Returns a matcher that matches a Long value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnIndex + int: + int column index
    value + long: + a long value to match
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowLong - (Matcher<String> columnNameMatcher, Matcher<Long> valueMatcher) -

    -
    -
    +
    +

    withRowLong

    +
    +
    + + - - -
    -
    - - - - -

    Returns a matcher that matches a Long value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - +
    columnNameMatcher - as a + +
    +CursorMatchers.CursorMatcher withRowLong (Matcher<String> columnNameMatcher, 
    +                Matcher<Long> valueMatcher)
    + + + + +

    Returns a matcher that matches a Long value at a given column index + in a Cursors data row. +

    + + + + + - - - + + + + - -
    Parameters
    columnNameMatcher + Matcher: + as a - Matcher of String
    valueMatcher - a + Matcher of String
    valueMatcher + Matcher: + a - Matcher that matches a Long value + Matcher that matches a Long value
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowShort - (int columnIndex, Matcher<Short> valueMatcher) -

    -
    -
    - - - -
    -
    - - + +
    +

    withRowLong

    +
    +
    + + -

    Returns a matcher that matches a Short value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnIndex - int column index
    valueMatcher - a + +
    +CursorMatchers.CursorMatcher withRowLong (String columnName, 
    +                Matcher<Long> valueMatcher)
    + + + + +

    Returns a matcher that matches a Long value at a given column index in a + Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnName + String: + as a String
    valueMatcher + Matcher: + a - Matcher that matches a Short value + Matcher that matches a Long value
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowShort - (String columnName, Matcher<Short> valueMatcher) -

    -
    -
    + +
    +

    withRowLong

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowLong (int columnIndex, 
    +                Matcher<Long> valueMatcher)
    + + + + +

    Returns a matcher that matches a Long value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnIndex + int: + int column index
    valueMatcher + Matcher: + a + + Matcher that matches a Long value +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    -
    +
    + +
    +

    withRowShort

    +
    +
    + + -

    Returns a matcher that matches a Short value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnName - as a String
    valueMatcher - a + +
    +CursorMatchers.CursorMatcher withRowShort (int columnIndex, 
    +                Matcher<Short> valueMatcher)
    + + + + +

    Returns a matcher that matches a Short value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnIndex + int: + int column index
    valueMatcher + Matcher: + a - Matcher that matches a Short value + Matcher that matches a Short value
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowShort - (String columnName, short value) -

    -
    -
    - - - -
    -
    - - +
    +

    withRowShort

    +
    +
    + + - -

    Returns a matcher that matches a Short value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnName - as a String
    value - a short value to match + +
    +CursorMatchers.CursorMatcher withRowShort (String columnName, 
    +                short value)
    + + + + +

    Returns a matcher that matches a Short value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnName + String: + as a String
    value + short: + a short value to match
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowShort - (Matcher<String> columnNameMatcher, Matcher<Short> valueMatcher) -

    -
    -
    +
    +

    withRowShort

    +
    +
    + + - - -
    -
    - - - - -

    Returns a matcher that matches a Short value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - +
    columnNameMatcher - as a + +
    +CursorMatchers.CursorMatcher withRowShort (Matcher<String> columnNameMatcher, 
    +                Matcher<Short> valueMatcher)
    + + + + +

    Returns a matcher that matches a Short value at a given column index + in a Cursors data row. +

    + + + + + - - - + + + + - -
    Parameters
    columnNameMatcher + Matcher: + as a - Matcher of String
    valueMatcher - a + Matcher of String
    valueMatcher + Matcher: + a - Matcher that matches a Short value + Matcher that matches a Short value
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowShort - (int columnIndex, short value) -

    -
    -
    - - - -
    -
    - - + +
    +

    withRowShort

    +
    +
    + + -

    Returns a matcher that matches a Short value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnIndex - int column index
    value - a short value to match + +
    +CursorMatchers.CursorMatcher withRowShort (String columnName, 
    +                Matcher<Short> valueMatcher)
    + + + + +

    Returns a matcher that matches a Short value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnName + String: + as a String
    valueMatcher + Matcher: + a + + Matcher that matches a Short value
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowString - (String columnName, String value) -

    -
    -
    - - - -
    -
    - - + +
    +

    withRowShort

    +
    +
    + + -

    Returns a matcher that matches a String value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnName - as a String
    value - a String value to match + +
    +CursorMatchers.CursorMatcher withRowShort (int columnIndex, 
    +                short value)
    + + + + +

    Returns a matcher that matches a Short value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnIndex + int: + int column index
    value + short: + a short value to match
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowString - (int columnIndex, Matcher<String> valueMatcher) -

    -
    -
    - - - -
    -
    - +
    +

    withRowString

    +
    +
    + + - - -

    Returns a matcher that matches a String value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnIndex - int column index
    valueMatcher - a + +
    +CursorMatchers.CursorMatcher withRowString (int columnIndex, 
    +                Matcher<String> valueMatcher)
    + + + + +

    Returns a matcher that matches a String value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnIndex + int: + int column index
    valueMatcher + Matcher: + a - Matcher that matches a String value + Matcher that matches a String value
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowString - (int columnIndex, String value) -

    -
    -
    - - - -
    -
    - - + +
    +

    withRowString

    +
    +
    + + -

    Returns a matcher that matches a String value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnIndex - int column index
    value - a String value to match + +
    +CursorMatchers.CursorMatcher withRowString (String columnName, 
    +                Matcher<String> valueMatcher)
    + + + + +

    Returns a matcher that matches a String value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnName + String: + as a String
    valueMatcher + Matcher: + a + + Matcher that matches a String value
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    - - -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowString - (String columnName, Matcher<String> valueMatcher) -

    -
    -
    + +
    +

    withRowString

    +
    +
    + + +
    +
    +CursorMatchers.CursorMatcher withRowString (String columnName, 
    +                String value)
    + + + + +

    Returns a matcher that matches a String value at a given column index + in a Cursors data row. +

    + + + + + + + + + + +
    Parameters
    columnName + String: + as a String
    value + String: + a String value to match +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    -
    +
    + +
    +

    withRowString

    +
    +
    + + -

    Returns a matcher that matches a String value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - - - - +
    columnName - as a String
    valueMatcher - a - - Matcher that matches a String value + +
    +CursorMatchers.CursorMatcher withRowString (int columnIndex, 
    +                String value)
    + + + + +

    Returns a matcher that matches a String value at a given column index + in a Cursors data row. +

    + + + + + + + + + - -
    Parameters
    columnIndex + int: + int column index
    value + String: + a String value to match
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    -
    -

    - - public - static - - - - CursorMatchers.CursorMatcher - - withRowString - (Matcher<String> columnPicker, Matcher<String> valueMatcher) -

    -
    -
    +
    +

    withRowString

    +
    +
    + + - - -
    -
    - - - - -

    Returns a matcher that matches a String value at a given column index - in a Cursors data row. -

    -
    -
    Parameters
    - - - +
    columnPicker - as a + +
    +CursorMatchers.CursorMatcher withRowString (Matcher<String> columnPicker, 
    +                Matcher<String> valueMatcher)
    + + + + +

    Returns a matcher that matches a String value at a given column index + in a Cursors data row. +

    + + + + + - - - + + + + - -
    Parameters
    columnPicker + Matcher: + as a - Matcher of String
    valueMatcher - a + Matcher of String
    valueMatcher + Matcher: + a - Matcher that matches a String value + Matcher that matches a String value
    - +
    + + + + + + +
    Returns
    CursorMatchers.CursorMatcher
    -
    @@ -3615,193 +3346,39 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/matcher/LayoutMatchers.html b/docs/html/reference/android/support/test/espresso/matcher/LayoutMatchers.html index 7fc041999d65..61b58d8f09a1 100644 --- a/docs/html/reference/android/support/test/espresso/matcher/LayoutMatchers.html +++ b/docs/html/reference/android/support/test/espresso/matcher/LayoutMatchers.html @@ -1,4 +1,3 @@ - @@ -93,492 +92,85 @@ - - - - - - -LayoutMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +LayoutMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    LayoutMatchers

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    LayoutMatchers

    +

    + + public + + final + + class + LayoutMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.matcher.LayoutMatchers
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.matcher.LayoutMatchers +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of hamcrest matches to detect typical layout issues. +

    A collection of hamcrest matches to detect typical layout issues.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -730,55 +295,64 @@ Summary: - - - - - - -
    Public Methods
    - + + - static - - Matcher - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - hasEllipsizedText() - -
    - Matches TextView elements having ellipsized text. - - - -
    - -
    - - - - static - - Matcher - - hasMultilineText() - -
    - Matches TextView elements having multiline text. - - - -
    - -
    + + + static + + + Matcher + + + hasEllipsizedText() + + +

    Matches TextView elements having ellipsized text. + + +

    + +
    + + + static + + + Matcher + + + hasMultilineText() + + +

    Matches TextView elements having multiline text. + + +

    + +
    @@ -790,207 +364,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -999,16 +642,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1034,76 +667,68 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Matcher - - hasEllipsizedText - () -

    -
    -
    - - - -
    -
    - - +
    +

    hasEllipsizedText

    +
    +
    + + +
    +
    +Matcher hasEllipsizedText ()
    + + -

    Matches TextView elements having ellipsized text. If text is too long to fit into a TextView, + +

    Matches TextView elements having ellipsized text. If text is too long to fit into a TextView, it can be either ellipsized ('Too long' shown as 'Too l…' or '… long') or cut off ('Too long' shown as 'Too l'). Though acceptable in some cases, usually indicates bad user experience. -

    +

    + + + + + + +
    Returns
    Matcher
    -
    -
    -

    - - public - static - - - - Matcher - - hasMultilineText - () -

    -
    -
    - - - -
    -
    - - +
    +

    hasMultilineText

    +
    +
    + + +
    +
    +Matcher hasMultilineText ()
    + + -

    Matches TextView elements having multiline text. -

    + +

    Matches TextView elements having multiline text. +

    + + + + + + +
    Returns
    Matcher
    -
    @@ -1115,193 +740,39 @@ From class - -
    - -
    - -
    - - -
    - - - + + diff --git a/docs/html/reference/android/support/test/espresso/matcher/PreferenceMatchers.html b/docs/html/reference/android/support/test/espresso/matcher/PreferenceMatchers.html index ce1268c16a33..bf215d9b92c0 100644 --- a/docs/html/reference/android/support/test/espresso/matcher/PreferenceMatchers.html +++ b/docs/html/reference/android/support/test/espresso/matcher/PreferenceMatchers.html @@ -1,4 +1,3 @@ - @@ -93,492 +92,85 @@ - - - - - - -PreferenceMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +PreferenceMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    PreferenceMatchers

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    PreferenceMatchers

    +

    + + public + + final + + class + PreferenceMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.matcher.PreferenceMatchers
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.matcher.PreferenceMatchers +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of hamcrest matchers that match Preferences. +

    A collection of hamcrest matchers that match Preferences.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -730,153 +295,208 @@ Summary: - - - - - - - - - + + - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Methods
    - - + + - static - Matcher<Preference> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - isEnabled() - -
    - - - - static - - Matcher<Preference> - - withKey(String key) - -
    - - - - static - - Matcher<Preference> - - withKey(Matcher<String> keyMatcher) - -
    - - - - static - - Matcher<Preference> - - withSummary(int resourceId) - -
    - - - - static - - Matcher<Preference> - - withSummaryText(Matcher<String> summaryMatcher) - -
    - - - - static - - Matcher<Preference> - - withSummaryText(String summary) - -
    - - - - static - - Matcher<Preference> - - withTitle(int resourceId) - -
    - - - - static - - Matcher<Preference> - - withTitleText(String title) - -
    - - - - static - - Matcher<Preference> - - withTitleText(Matcher<String> titleMatcher) - -
    + + + static + + + Matcher<Preference> + + + isEnabled() + + +
    + + + static + + + Matcher<Preference> + + + withKey(Matcher<String> keyMatcher) + + +
    + + + static + + + Matcher<Preference> + + + withKey(String key) + + +
    + + + static + + + Matcher<Preference> + + + withSummary(int resourceId) + + +
    + + + static + + + Matcher<Preference> + + + withSummaryText(Matcher<String> summaryMatcher) + + +
    + + + static + + + Matcher<Preference> + + + withSummaryText(String summary) + + +
    + + + static + + + Matcher<Preference> + + + withTitle(int resourceId) + + +
    + + + static + + + Matcher<Preference> + + + withTitleText(String title) + + +
    + + + static + + + Matcher<Preference> + + + withTitleText(Matcher<String> titleMatcher) + + +
    @@ -888,207 +508,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1097,16 +786,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1132,295 +811,331 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Matcher<Preference> - - isEnabled - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    isEnabled

    +
    +
    + +
    -
    - - - - -
    -

    - - public - static - - - - Matcher<Preference> - - withKey - (String key) -

    -
    -
    - - - -
    -
    +
    +Matcher<Preference> isEnabled ()
    + + + + +

    + + + + + + +
    Returns
    Matcher<Preference>
    - - - -

    - -
    -
    -

    - - public - static - +
    +

    withKey

    +
    +
    + + +
    +
    +Matcher<Preference> withKey (Matcher<String> keyMatcher)
    + + + + +

    + + + + + + +
    Parameters
    keyMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Preference>
    - Matcher<Preference> - - withKey - (Matcher<String> keyMatcher) -

    -
    -
    - - - -
    -
    - +
    + -

    +
    +

    withKey

    +
    +
    + +
    +
    +Matcher<Preference> withKey (String key)
    + + + + +

    + + + + + + +
    Parameters
    key + String +
    + + + + + + +
    Returns
    Matcher<Preference>
    +
    -
    -

    - - public - static - - - - Matcher<Preference> - - withSummary - (int resourceId) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withSummary

    +
    +
    + +
    +
    +Matcher<Preference> withSummary (int resourceId)
    + + + + +

    + + + + + + +
    Parameters
    resourceId + int +
    + + + + + + +
    Returns
    Matcher<Preference>
    +
    -
    -

    - - public - static - - - - Matcher<Preference> - - withSummaryText - (Matcher<String> summaryMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withSummaryText

    +
    +
    + +
    +
    +Matcher<Preference> withSummaryText (Matcher<String> summaryMatcher)
    + + + + +

    + + + + + + +
    Parameters
    summaryMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Preference>
    +
    -
    -

    - - public - static - - - - Matcher<Preference> - - withSummaryText - (String summary) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withSummaryText

    +
    +
    + +
    +
    +Matcher<Preference> withSummaryText (String summary)
    + + + + +

    + + + + + + +
    Parameters
    summary + String +
    + + + + + + +
    Returns
    Matcher<Preference>
    +
    -
    -

    - - public - static - - - - Matcher<Preference> - - withTitle - (int resourceId) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withTitle

    +
    +
    + +
    +
    +Matcher<Preference> withTitle (int resourceId)
    + + + + +

    + + + + + + +
    Parameters
    resourceId + int +
    + + + + + + +
    Returns
    Matcher<Preference>
    +
    -
    -

    - - public - static - - - - Matcher<Preference> - - withTitleText - (String title) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withTitleText

    +
    +
    + +
    +
    +Matcher<Preference> withTitleText (String title)
    + + + + +

    + + + + + + +
    Parameters
    title + String +
    + + + + + + +
    Returns
    Matcher<Preference>
    +
    -
    -

    - - public - static - - - - Matcher<Preference> - - withTitleText - (Matcher<String> titleMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    withTitleText

    +
    +
    + +
    +
    +Matcher<Preference> withTitleText (Matcher<String> titleMatcher)
    + + + + +

    + + + + + + +
    Parameters
    titleMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Preference>
    +
    @@ -1432,193 +1147,39 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/matcher/RootMatchers.html b/docs/html/reference/android/support/test/espresso/matcher/RootMatchers.html index e55797e47b65..365aec01c665 100644 --- a/docs/html/reference/android/support/test/espresso/matcher/RootMatchers.html +++ b/docs/html/reference/android/support/test/espresso/matcher/RootMatchers.html @@ -1,4 +1,3 @@ - @@ -93,492 +92,85 @@ - - - - - - -RootMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +RootMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    RootMatchers

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    RootMatchers

    +

    + + public + + final + + class + RootMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.matcher.RootMatchers
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.matcher.RootMatchers +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of matchers for Root objects. +

    A collection of matchers for Root objects.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -724,25 +289,26 @@ Summary: - - - +
    Fields
    + - - - - - - + + + + +

    Fields

    - public - static - final - Matcher<Root>DEFAULT - Espresso's default Root matcher. - -
    + public + static + final + Matcher<Root> + DEFAULT +

    Espresso's default Root matcher. + + +

    +
    @@ -758,124 +324,145 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - + +

    Returns a matcher that matches Views currently have focus. +

    +
    Public Methods
    - - - - static - - Matcher<Root> - - isDialog() - -
    - Matches Roots that are dialogs (i.e. - - - -
    - -
    - - - - static - - Matcher<Root> - - isFocusable() - -
    - Matches Roots that can take window focus. - - - -
    - -
    - - - - static - - Matcher<Root> - - isPlatformPopup() - -
    - Matches Roots that are popups - like autocomplete suggestions or the actionbar spinner. - - - -
    + + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - - - - static - - Matcher<Root> - - isTouchable() - -
    - Matches Roots that can receive touch events. - - - -
    - -
    - - - - static - - Matcher<Root> - - withDecorView(Matcher<View> decorViewMatcher) - -
    - Matches Roots with decor views that match the given view matcher. - - - -
    - -
    + + + static + + + Matcher<Root> + + + isDialog() + + +

    Matches Roots that are dialogs (i.e. + + +

    + +
    + + + static + + + Matcher<Root> + + + isFocusable() + + +

    Matches Roots that can take window focus. + + +

    + +
    + + + static + + + Matcher<Root> + + + isPlatformPopup() + + +

    Matches Roots that are popups - like autocomplete suggestions or the actionbar spinner. + + +

    + +
    + + + static + + + Matcher<Root> + + + isTouchable() + + +

    Matches Roots that can receive touch events. + + +

    + +
    + + + static + + + Matcher<Root> + + + withDecorView(Matcher<View> decorViewMatcher) + + +

    Matches Roots with decor views that match the given view matcher. + + +

    + +
    @@ -887,207 +474,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1096,16 +752,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1120,39 +766,31 @@ From class -

    Fields

    +

    Fields

    -
    -

    - - public - static - final - Matcher<Root> - - DEFAULT -

    -
    - - - - -
    -
    - - - +
    +

    DEFAULT

    +
    + + + -

    Espresso's default Root matcher. -

    +
    +
    +Matcher<Root> DEFAULT
    + + + +

    Espresso's default Root matcher. +

    -
    +
    @@ -1170,173 +808,162 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Matcher<Root> - - isDialog - () -

    -
    -
    - - - -
    -
    - - +
    +

    isDialog

    +
    +
    + + +
    +
    +Matcher<Root> isDialog ()
    + + -

    Matches Roots that are dialogs (i.e. is not a window of the currently resumed + +

    Matches Roots that are dialogs (i.e. is not a window of the currently resumed activity). -

    +

    + + + + + + +
    Returns
    Matcher<Root>
    -
    -
    -

    - - public - static - - - - Matcher<Root> - - isFocusable - () -

    -
    -
    - - - -
    -
    - - +
    +

    isFocusable

    +
    +
    + + +
    +
    +Matcher<Root> isFocusable ()
    + + -

    Matches Roots that can take window focus. -

    + +

    Matches Roots that can take window focus. +

    + + + + + + +
    Returns
    Matcher<Root>
    -
    -
    -

    - - public - static - - - - Matcher<Root> - - isPlatformPopup - () -

    -
    -
    - - - -
    -
    - - +
    +

    isPlatformPopup

    +
    +
    + + +
    +
    +Matcher<Root> isPlatformPopup ()
    + + -

    Matches Roots that are popups - like autocomplete suggestions or the actionbar spinner. -

    + +

    Matches Roots that are popups - like autocomplete suggestions or the actionbar spinner. +

    + + + + + + +
    Returns
    Matcher<Root>
    -
    -
    -

    - - public - static - - - - Matcher<Root> - - isTouchable - () -

    -
    -
    - - - -
    -
    - - +
    +

    isTouchable

    +
    +
    + + +
    +
    +Matcher<Root> isTouchable ()
    + + -

    Matches Roots that can receive touch events. -

    + +

    Matches Roots that can receive touch events. +

    + + + + + + +
    Returns
    Matcher<Root>
    -
    -
    -

    - - public - static - - - - Matcher<Root> - - withDecorView - (Matcher<View> decorViewMatcher) -

    -
    -
    - - - -
    -
    - - +
    +

    withDecorView

    +
    +
    + + +
    +
    +Matcher<Root> withDecorView (Matcher<View> decorViewMatcher)
    + + -

    Matches Roots with decor views that match the given view matcher. -

    + +

    Matches Roots with decor views that match the given view matcher. +

    + + + + + + +
    Parameters
    decorViewMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Root>
    -
    @@ -1348,193 +975,39 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/matcher/ViewMatchers.Visibility.html b/docs/html/reference/android/support/test/espresso/matcher/ViewMatchers.Visibility.html index 65b46a7c0b48..7085d997cf7e 100644 --- a/docs/html/reference/android/support/test/espresso/matcher/ViewMatchers.Visibility.html +++ b/docs/html/reference/android/support/test/espresso/matcher/ViewMatchers.Visibility.html @@ -1,4 +1,3 @@ - @@ -93,511 +92,104 @@ - - - - - - -ViewMatchers.Visibility | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ViewMatchers.Visibility - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - final - - enum -

    ViewMatchers.Visibility

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - +

    ViewMatchers.Visibility

    +

    + + public + static + final + + enum + ViewMatchers.Visibility + +
    + + + + + + + + + + + extends Enum<ViewMatchers.Visibility> + + + + + + + + + + + +

    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.espresso.matcher.ViewMatchers.Visibility
    + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Enum<android.support.test.espresso.matcher.ViewMatchers.Visibility> +
        ↳android.support.test.espresso.matcher.ViewMatchers.Visibility +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Enumerates the possible list of values for View.getVisibility(). +

    Enumerates the possible list of values for View.getVisibility().

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -750,45 +318,46 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - +
    Enum Values
    ViewMatchers.Visibility GONE  -   - - - -
    ViewMatchers.Visibility INVISIBLE  -   - - - -
    ViewMatchers.Visibility VISIBLE  -   - - - -
    + + + + + + + + + + + + + + + + + + + + + @@ -808,57 +377,76 @@ Summary: -

    Enum values

    ViewMatchers.Visibility  + GONE +

      + + +

    +
    ViewMatchers.Visibility  + INVISIBLE +

      + + +

    +
    ViewMatchers.Visibility  + VISIBLE +

      + + +

    +
    - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - int - - getValue() - -
    - - - - static - - ViewMatchers.Visibility - - valueOf(String name) - -
    - - - final - static - - Visibility[] - - values() - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + int + + + getValue() + + +
    + + + static + + + ViewMatchers.Visibility + + + valueOf(String name) + + +
    + + + static + final + + Visibility[] + + + values() + + +
    @@ -870,207 +458,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1078,201 +735,271 @@ From class - @@ -1282,41 +1009,51 @@ From class - @@ -1325,16 +1062,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Enum + + From +class + + + java.lang.Enum + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - java.lang.Comparable + + From +interface + + + java.lang.Comparable + +
    -
    - - - - - - - - - @@ -1343,100 +1070,76 @@ From interface -

    Enum Values

    +

    Enum values

    -
    -

    - - public - static - final - ViewMatchers.Visibility - - GONE -

    -
    - - - - -
    -
    - - +
    +

    GONE

    +
    + + + +
    +
    +ViewMatchers.Visibility GONE
    + + -

    - + +

    -
    +
    -
    -

    - - public - static - final - ViewMatchers.Visibility - - INVISIBLE -

    -
    - - - +
    +

    INVISIBLE

    +
    + + + -
    -
    - - - - -

    +
    +
    +ViewMatchers.Visibility INVISIBLE
    + + + +

    -
    +
    -
    -

    - - public - static - final - ViewMatchers.Visibility - - VISIBLE -

    -
    - - - - -
    -
    - - - +
    +

    VISIBLE

    +
    + + + -

    +
    +
    +ViewMatchers.Visibility VISIBLE
    + + + +

    -
    +
    @@ -1460,103 +1163,100 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - int - - getValue - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getValue

    +
    +
    + +
    +
    +int getValue ()
    + + + + +

    + + + + + + +
    Returns
    int
    +
    -
    -

    - - public - static - - - - ViewMatchers.Visibility - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +ViewMatchers.Visibility valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    ViewMatchers.Visibility
    +
    -
    -

    - - public - static - final - - - Visibility[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +Visibility[] values ()
    + + + + +

    + + + + + + +
    Returns
    Visibility[]
    +
    @@ -1568,193 +1268,39 @@ From interface - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/matcher/ViewMatchers.html b/docs/html/reference/android/support/test/espresso/matcher/ViewMatchers.html index 53d3d1e5da3e..374cc4abcc58 100644 --- a/docs/html/reference/android/support/test/espresso/matcher/ViewMatchers.html +++ b/docs/html/reference/android/support/test/espresso/matcher/ViewMatchers.html @@ -1,4 +1,3 @@ - @@ -93,492 +92,85 @@ - - - - - - -ViewMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ViewMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public +

    ViewMatchers

    +

    + + public + + final + + class + ViewMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + - final +
    java.lang.Object +
       ↳android.support.test.espresso.matcher.ViewMatchers +
    + - class -

    ViewMatchers

    + +

    +

    A collection of hamcrest matchers that match Views. +

    - extends Object
    +

    Summary

    + + + + + + + + + + + + - -
    -
    -

    Nested classes

    + + + + + enum + ViewMatchers.Visibility +

    Enumerates the possible list of values for View.getVisibility().  + + +

    +
    - - - - - - - -
    java.lang.Object
       ↳android.support.test.espresso.matcher.ViewMatchers
    @@ -673,22 +317,1367 @@ Summary: -
    -

    Class Overview

    -

    A collection of hamcrest matchers that match Views. -

    + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + static + + <T> + void + + + assertThat(String message, T actual, Matcher<T> matcher) + + +

    A replacement for MatcherAssert.assertThat that renders View objects nicely. + + +

    + +
    + + + static + + <T> + void + + + assertThat(T actual, Matcher<T> matcher) + + +

    A replacement for MatcherAssert.assertThat that renders View objects nicely. + + +

    + +
    + + + static + + + Matcher<View> + + + hasContentDescription() + + +

    Returns an + Matcher that matches Views with any content description. + + +

    + +
    + + + static + + + Matcher<View> + + + hasDescendant(Matcher<View> descendantMatcher) + + +

    Returns a matcher that matches Views based on the presence of a descendant in its view + hierarchy. + + +

    + +
    + + + static + + + Matcher<View> + + + hasErrorText(String expectedError) + + +

    Returns a matcher that matches EditText based on edit text error string value. + + +

    + +
    + + + static + + + Matcher<View> + + + hasErrorText(Matcher<String> stringMatcher) + + +

    Returns a matcher that matches EditText based on edit text error string value. + + +

    + +
    + + + static + + + Matcher<View> + + + hasFocus() + + +

    Returns a matcher that matches Views currently have focus. + + +

    + +
    + + + static + + + Matcher<View> + + + hasImeAction(int imeAction) + + +

    Returns a matcher that matches views that support input methods (e.g. + + +

    + +
    + + + static + + + Matcher<View> + + + hasImeAction(Matcher<Integer> imeActionMatcher) + + +

    Returns a matcher that matches views that support input methods (e.g. + + +

    + +
    + + + static + + + Matcher<View> + + + hasLinks() + + +

    Returns a matcher that matches TextViews that have links. + + +

    + +
    + + + static + + + Matcher<View> + + + hasSibling(Matcher<View> siblingMatcher) + + +

    Returns an + Matcher that matches Views based on their siblings. + + +

    + +
    + + + static + + + Matcher<View> + + + isAssignableFrom(Class<? extends View> clazz) + + +

    Returns a matcher that matches Views which are an instance of or subclass of the provided + class. + + +

    + +
    + + + static + + + Matcher<View> + + + isChecked() + + +

    Returns a matcher that accepts if and only if the view is a CompoundButton (or subtype of) and + is in checked state. + + +

    + +
    + + + static + + + Matcher<View> + + + isClickable() + + +

    Returns a matcher that matches Views that are clickable. + + +

    + +
    + + + static + + + Matcher<View> + + + isCompletelyDisplayed() + + +

    Returns a matcher which only accepts a view whose height and width fit perfectly within + the currently displayed region of this view. + + +

    + +
    + + + static + + + Matcher<View> + + + isDescendantOfA(Matcher<View> ancestorMatcher) + + +

    Returns a matcher that matches Views based on the given ancestor type. + + +

    + +
    + + + static + + + Matcher<View> + + + isDisplayed() + + +

    Returns a matcher that matches Views that are currently displayed on the screen to the + user. + + +

    + +
    + + + static + + + Matcher<View> + + + isDisplayingAtLeast(int areaPercentage) + + +

    Returns a matcher which accepts a view so long as a given percentage of that view's area is + not obscured by any other view and is thus visible to the user. + + +

    + +
    + + + static + + + Matcher<View> + + + isEnabled() + + +

    Returns a matcher that matches Views that are enabled. + + +

    + +
    + + + static + + + Matcher<View> + + + isFocusable() + + +

    Returns a matcher that matches Views that are focusable. + + +

    + +
    + + + static + + + Matcher<View> + + + isJavascriptEnabled() + + +

    Returns a matcher that matches WebView if they are evaluating Javascript. + + +

    + +
    + + + static + + + Matcher<View> + + + isNotChecked() + + +

    Returns a matcher that accepts if and only if the view is a CompoundButton (or subtype of) and + is not in checked state. + + +

    + +
    + + + static + + + Matcher<View> + + + isRoot() + + +

    Returns a matcher that matches root View. + + +

    + +
    + + + static + + + Matcher<View> + + + isSelected() + + +

    Returns a matcher that matches Views that are selected. + + +

    + +
    + + + static + + + Matcher<View> + + + supportsInputMethods() + + +

    Returns a matcher that matches views that support input methods. + + +

    + +
    + + + static + + + Matcher<View> + + + withChild(Matcher<View> childMatcher) + + +

    A matcher that returns true if and only if the view's child is accepted by the provided + matcher. + + +

    + +
    + + + static + + + Matcher<View> + + + withClassName(Matcher<String> classNameMatcher) + + +

    Returns a matcher that matches Views with class name matching the given matcher. + + +

    + +
    + + + static + + + Matcher<View> + + + withContentDescription(int resourceId) + + +

    Returns a + Matcher that matches Views based on content description property + value. + + +

    + +
    + + + static + + + Matcher<View> + + + withContentDescription(String text) + + +

    Returns an + Matcher that matches Views based on content description property + value. + + +

    + +
    + + + static + + + Matcher<View> + + + withContentDescription(Matcher<? extends CharSequence> charSequenceMatcher) + + +

    Returns an + Matcher that matches Views based on content description property + value. + + +

    + +
    + + + static + + + Matcher<View> + + + withEffectiveVisibility(ViewMatchers.Visibility visibility) + + +

    Returns a matcher that matches Views that have "effective" visibility set to the given + value. + + +

    + +
    + + + static + + + Matcher<View> + + + withHint(Matcher<String> stringMatcher) + + +

    Returns a matcher that matches TextViews based on hint property value. + + +

    + +
    + + + static + + + Matcher<View> + + + withHint(int resourceId) + + +

    Returns a matcher that matches a descendant of TextView that is displaying the hint + associated with the given resource id. + + +

    + +
    + + + static + + + Matcher<View> + + + withHint(String hintText) + + +

    Returns a matcher that matches TextView based on it's hint property value. + + +

    + +
    + + + static + + + Matcher<View> + + + withId(Matcher<Integer> integerMatcher) + + +

    Returns a matcher that matches Views based on resource ids. + + +

    + +
    + + + static + + + Matcher<View> + + + withId(int id) + + +

    Same as withId(is(int)), but attempts to look up resource name of the given id and use an + R.id.myView style description with describeTo. + + +

    + +
    + + + static + + + Matcher<View> + + + withInputType(int inputType) + + +

    Returns a matcher that matches InputType. + + +

    + +
    + + + static + + + Matcher<View> + + + withParent(Matcher<View> parentMatcher) + + +

    A matcher that accepts a view if and only if the view's parent is accepted by the provided + matcher. + + +

    + +
    + + + static + + + Matcher<View> + + + withResourceName(String name) + + +

    Returns a matcher that matches Views based on resource id names, + (for instance, channel_avatar). + + +

    + +
    + + + static + + + Matcher<View> + + + withResourceName(Matcher<String> stringMatcher) + + +

    Returns a matcher that matches Views based on resource id names, + (for instance, channel_avatar). + + +

    + +
    + + + static + + + Matcher<View> + + + withSpinnerText(int resourceId) + + +

    Returns a matcher that matches a descendant of Spinner that is displaying the string + of the selected item associated with the given resource id. + + +

    + +
    + + + static + + + Matcher<View> + + + withSpinnerText(String text) + + +

    Returns a matcher that matches Spinner based on it's selected item's toString value. + + +

    + +
    + + + static + + + Matcher<View> + + + withSpinnerText(Matcher<String> stringMatcher) + + +

    Returns a matcher that matches Spinners based on toString value of the selected item. + + +

    + +
    + + + static + + + Matcher<View> + + + withTagKey(int key) + + +

    Returns a matcher that matches View based on tag keys. + + +

    + +
    + + + static + + + Matcher<View> + + + withTagKey(int key, Matcher<Object> objectMatcher) + + +

    Returns a matcher that matches Views based on tag keys. + + +

    + +
    + + + static + + + Matcher<View> + + + withTagValue(Matcher<Object> tagValueMatcher) + + +

    Returns a matcher that matches Views based on tag property values. + + +

    + +
    + + + static + + + Matcher<View> + + + withText(Matcher<String> stringMatcher) + + +

    Returns a matcher that matches TextViews based on text property value. + + +

    + +
    + + + static + + + Matcher<View> + + + withText(String text) + + +

    Returns a matcher that matches TextView based on its text property value. + + +

    + +
    + + + static + + + Matcher<View> + + + withText(int resourceId) + + +

    Returns a matcher that matches a descendant of TextView that is displaying the string + associated with the given resource id. + + +

    + +
    @@ -696,3300 +1685,2132 @@ Summary: + + + + + -
    +

    Inherited methods

    + From +class + + + java.lang.Object + + +
    + + +
    +
    -

    Summary

    + - - + + - - - - - + + +

    Public methods

    + +
    +

    assertThat

    +
    +
    + + +
    +
    +void assertThat (String message, 
    +                T actual, 
    +                Matcher<T> matcher)
    + + + + +

    A replacement for MatcherAssert.assertThat that renders View objects nicely.

    +
    Nested Classes
    + + - enumViewMatchers.Visibility - Enumerates the possible list of values for View.getVisibility().  + + -
    + + + + + + + + + + + + + +
    Parameters
    message + String: + the message to display.
    actual + T: + the actual value.
    matcher + Matcher: + a matcher that accepts or rejects actual. +
    +
    + +
    +

    assertThat

    +
    +
    + + +
    +
    +void assertThat (T actual, 
    +                Matcher<T> matcher)
    + + + + +

    A replacement for MatcherAssert.assertThat that renders View objects nicely.

    + + + + + + + + + + +
    Parameters
    actual + T: + the actual value.
    matcher + Matcher: + a matcher that accepts or rejects actual. +
    +
    + +
    +

    hasContentDescription

    +
    +
    + + +
    +
    +Matcher<View> hasContentDescription ()
    + + + + +

    Returns an + Matcher that matches Views with any content description. +

    + + + + + + +
    Returns
    Matcher<View>
    +
    + +
    +

    hasDescendant

    +
    +
    + + +
    +
    +Matcher<View> hasDescendant (Matcher<View> descendantMatcher)
    + + + + +

    Returns a matcher that matches Views based on the presence of a descendant in its view + hierarchy.

    + + + + + + +
    Parameters
    descendantMatcher + Matcher: + the type of the descendant to match on +
    + + + + + + +
    Returns
    Matcher<View>
    +
    + +
    +

    hasErrorText

    +
    +
    + + +
    +
    +Matcher<View> hasErrorText (String expectedError)
    + + - - + +

    Returns a matcher that matches EditText based on edit text error string value. +

    + Note: Sugar for hasErrorText(is("string")). +

    +
    Public Methods
    + + + + + +
    Parameters
    expectedError + String +
    + + + + + + +
    Returns
    Matcher<View>
    +
    + -
    +
    +

    hasErrorText

    +
    +
    + + +
    +
    +Matcher<View> hasErrorText (Matcher<String> stringMatcher)
    + + + +

    Returns a matcher that matches EditText based on edit text error string value. +

    + + + + + + +
    Parameters
    stringMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<View>
    - static - <T> - void
    -
    - assertThat(String message, T actual, Matcher<T> matcher) + -
    - A replacement for MatcherAssert.assertThat that renders View objects nicely. + +
    +

    hasFocus

    +
    +
    + + -
    +
    +
    +Matcher<View> hasFocus ()
    + + -
    + + + + + +
    Returns
    Matcher<View>
    +
    -
    + +
    +

    hasImeAction

    +
    +
    + + +
    +
    +Matcher<View> hasImeAction (int imeAction)
    + + + + +

    Returns a matcher that matches views that support input methods (e.g. EditText) and have the + specified IME action set in its EditorInfo.

    + + + + + + +
    Parameters
    imeAction + int: + the IME action to match +
    + + + + + + +
    Returns
    Matcher<View>
    - static - <T> - void
    -
    - assertThat(T actual, Matcher<T> matcher) + -
    - A replacement for MatcherAssert.assertThat that renders View objects nicely. + +
    +

    hasImeAction

    +
    +
    + + -
    +
    +
    +Matcher<View> hasImeAction (Matcher<Integer> imeActionMatcher)
    + + + + +

    Returns a matcher that matches views that support input methods (e.g. EditText) and have the + specified IME action set in its EditorInfo.

    + + + + + + +
    Parameters
    imeActionMatcher + Matcher: + a matcher for the IME action +
    + + + + + + +
    Returns
    Matcher<View>
    -
    +
    +

    hasLinks

    +
    +
    + + +
    +
    +Matcher<View> hasLinks ()
    + + + +

    Returns a matcher that matches TextViews that have links. +

    + + + + + + +
    Returns
    Matcher<View>
    - static +
    - Matcher<View>
    -
    - hasContentDescription() -
    - Returns an - Matcher that matches Views with any content description. + +
    +

    hasSibling

    +
    +
    + + +
    +
    +Matcher<View> hasSibling (Matcher<View> siblingMatcher)
    + + + + +

    Returns an + Matcher that matches Views based on their siblings.
    +
    + This may be particularly useful when a view cannot be uniquely selected on properties such as + text or R.id. For example: a call button is repeated several times in a contacts layout and the + only way to differentiate the call button view is by what appears next to it (e.g. the unique + name of the contact).

    + + + + + + +
    Parameters
    siblingMatcher + Matcher: + a + + Matcher for the sibling of the view. +
    + + + + + + +
    Returns
    Matcher<View>
    -
    +
    -
    - - - - static - - Matcher<View> - - hasDescendant(Matcher<View> descendantMatcher) - -
    - Returns a matcher that matches Views based on the presence of a descendant in its view - hierarchy. - - - -
    - -
    - - - - static - - Matcher<View> - - hasErrorText(String expectedError) - -
    - Returns a matcher that matches EditText based on edit text error string value. - - - -
    - -
    - - - - static - - Matcher<View> - - hasErrorText(Matcher<String> stringMatcher) - -
    - Returns a matcher that matches EditText based on edit text error string value. - - - -
    - -
    - - - - static - - Matcher<View> - - hasFocus() - -
    - Returns a matcher that matches Views currently have focus. - - - -
    - -
    - - - - static - - Matcher<View> - - hasImeAction(int imeAction) - -
    - Returns a matcher that matches views that support input methods (e.g. - - - -
    - -
    - - - - static - - Matcher<View> - - hasImeAction(Matcher<Integer> imeActionMatcher) - -
    - Returns a matcher that matches views that support input methods (e.g. - - - -
    - -
    - - - - static - - Matcher<View> - - hasLinks() - -
    - Returns a matcher that matches TextViews that have links. - - - -
    - -
    - - - - static - - Matcher<View> - - hasSibling(Matcher<View> siblingMatcher) - -
    - Returns an - Matcher that matches Views based on their siblings. - - - -
    - -
    - - - - static - - Matcher<View> - - isAssignableFrom(Class<? extends View> clazz) - -
    - Returns a matcher that matches Views which are an instance of or subclass of the provided - class. - - - -
    - -
    - - - - static - - Matcher<View> - - isChecked() - -
    - Returns a matcher that accepts if and only if the view is a CompoundButton (or subtype of) and - is in checked state. - - - -
    - -
    - - - - static - - Matcher<View> - - isClickable() - -
    - Returns a matcher that matches Views that are clickable. - - - -
    - -
    - - - - static - - Matcher<View> - - isCompletelyDisplayed() - -
    - Returns a matcher which only accepts a view whose height and width fit perfectly within - the currently displayed region of this view. - - - -
    - -
    - - - - static - - Matcher<View> - - isDescendantOfA(Matcher<View> ancestorMatcher) - -
    - Returns a matcher that matches Views based on the given ancestor type. - - - -
    - -
    - - - - static - - Matcher<View> - - isDisplayed() - -
    - Returns a matcher that matches Views that are currently displayed on the screen to the - user. - - - -
    - -
    - - - - static - - Matcher<View> - - isDisplayingAtLeast(int areaPercentage) - -
    - Returns a matcher which accepts a view so long as a given percentage of that view's area is - not obscured by any other view and is thus visible to the user. - - - -
    - -
    - - - - static - - Matcher<View> - - isEnabled() - -
    - Returns a matcher that matches Views that are enabled. - - - -
    - -
    - - - - static - - Matcher<View> - - isFocusable() - -
    - Returns a matcher that matches Views that are focusable. - - - -
    - -
    - - - - static - - Matcher<View> - - isJavascriptEnabled() - -
    - Returns a matcher that matches WebView if they are evaluating Javascript. - - - -
    - -
    - - - - static - - Matcher<View> - - isNotChecked() - -
    - Returns a matcher that accepts if and only if the view is a CompoundButton (or subtype of) and - is not in checked state. - - - -
    - -
    - - - - static - - Matcher<View> - - isRoot() - -
    - Returns a matcher that matches root View. - - - -
    - -
    - - - - static - - Matcher<View> - - isSelected() - -
    - Returns a matcher that matches Views that are selected. - - - -
    - -
    - - - - static - - Matcher<View> - - supportsInputMethods() - -
    - Returns a matcher that matches views that support input methods. - - - -
    - -
    - - - - static - - Matcher<View> - - withChild(Matcher<View> childMatcher) - -
    - A matcher that returns true if and only if the view's child is accepted by the provided - matcher. - - - -
    - -
    - - - - static - - Matcher<View> - - withClassName(Matcher<String> classNameMatcher) - -
    - Returns a matcher that matches Views with class name matching the given matcher. - - - -
    - -
    - - - - static - - Matcher<View> - - withContentDescription(String text) - -
    - Returns an - Matcher that matches Views based on content description property - value. - - - -
    - -
    - - - - static - - Matcher<View> - - withContentDescription(Matcher<? extends CharSequence> charSequenceMatcher) - -
    - Returns an - Matcher that matches Views based on content description property - value. - - - -
    - -
    - - - - static - - Matcher<View> - - withContentDescription(int resourceId) - -
    - Returns a - Matcher that matches Views based on content description property - value. - - - -
    - -
    - - - - static - - Matcher<View> - - withEffectiveVisibility(ViewMatchers.Visibility visibility) - -
    - Returns a matcher that matches Views that have "effective" visibility set to the given - value. - - - -
    - -
    - - - - static - - Matcher<View> - - withHint(int resourceId) - -
    - Returns a matcher that matches a descendant of TextView that is displaying the hint - associated with the given resource id. - - - -
    - -
    - - - - static - - Matcher<View> - - withHint(Matcher<String> stringMatcher) - -
    - Returns a matcher that matches TextViews based on hint property value. - - - -
    - -
    - - - - static - - Matcher<View> - - withHint(String hintText) - -
    - Returns a matcher that matches TextView based on it's hint property value. - - - -
    - -
    - - - - static - - Matcher<View> - - withId(Matcher<Integer> integerMatcher) - -
    - Returns a matcher that matches Views based on resource ids. - - - -
    - -
    - - - - static - - Matcher<View> - - withId(int id) - -
    - Same as withId(is(int)), but attempts to look up resource name of the given id and use an - R.id.myView style description with describeTo. - - - -
    - -
    - - - - static - - Matcher<View> - - withInputType(int inputType) - -
    - Returns a matcher that matches InputType. - - - -
    - -
    - - - - static - - Matcher<View> - - withParent(Matcher<View> parentMatcher) - -
    - A matcher that accepts a view if and only if the view's parent is accepted by the provided - matcher. - - - -
    - -
    - - - - static - - Matcher<View> - - withSpinnerText(String text) - -
    - Returns a matcher that matches Spinner based on it's selected item's toString value. - - - -
    - -
    - - - - static - - Matcher<View> - - withSpinnerText(int resourceId) - -
    - Returns a matcher that matches a descendant of Spinner that is displaying the string - of the selected item associated with the given resource id. - - - -
    - -
    - - - - static - - Matcher<View> - - withSpinnerText(Matcher<String> stringMatcher) - -
    - Returns a matcher that matches Spinners based on toString value of the selected item. - - - -
    - -
    - - - - static - - Matcher<View> - - withTagKey(int key, Matcher<Object> objectMatcher) - -
    - Returns a matcher that matches Views based on tag keys. - - - -
    - -
    - - - - static - - Matcher<View> - - withTagKey(int key) - -
    - Returns a matcher that matches View based on tag keys. - - - -
    - -
    - - - - static - - Matcher<View> - - withTagValue(Matcher<Object> tagValueMatcher) - -
    - Returns a matcher that matches Views based on tag property values. - - - -
    - -
    - - - - static - - Matcher<View> - - withText(String text) - -
    - Returns a matcher that matches TextView based on its text property value. - - - -
    - -
    - - - - static - - Matcher<View> - - withText(Matcher<String> stringMatcher) - -
    - Returns a matcher that matches TextViews based on text property value. - - - -
    - -
    - - - - static - - Matcher<View> - - withText(int resourceId) - -
    - Returns a matcher that matches a descendant of TextView that is displaying the string - associated with the given resource id. - - - -
    - -
    - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - static - - - - void - - assertThat - (String message, T actual, Matcher<T> matcher) -

    -
    -
    - - - -
    -
    - - - - -

    A replacement for MatcherAssert.assertThat that renders View objects nicely.

    -
    -
    Parameters
    - - - - - - - - - - -
    message - the message to display.
    actual - the actual value.
    matcher - a matcher that accepts or rejects actual. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - void - - assertThat - (T actual, Matcher<T> matcher) -

    -
    -
    - - - -
    -
    - - - - -

    A replacement for MatcherAssert.assertThat that renders View objects nicely.

    -
    -
    Parameters
    - - - - - - - -
    actual - the actual value.
    matcher - a matcher that accepts or rejects actual. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - hasContentDescription - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns an - Matcher that matches Views with any content description. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - hasDescendant - (Matcher<View> descendantMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views based on the presence of a descendant in its view - hierarchy.

    -
    -
    Parameters
    - - - - -
    descendantMatcher - the type of the descendant to match on -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - hasErrorText - (String expectedError) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches EditText based on edit text error string value. -

    - Note: Sugar for hasErrorText(is("string")). -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - hasErrorText - (Matcher<String> stringMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches EditText based on edit text error string value. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - hasFocus - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views currently have focus. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - hasImeAction - (int imeAction) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches views that support input methods (e.g. EditText) and have the - specified IME action set in its EditorInfo.

    -
    -
    Parameters
    - - - - -
    imeAction - the IME action to match -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - hasImeAction - (Matcher<Integer> imeActionMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches views that support input methods (e.g. EditText) and have the - specified IME action set in its EditorInfo.

    -
    -
    Parameters
    - - - - -
    imeActionMatcher - a matcher for the IME action -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - hasLinks - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches TextViews that have links. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - hasSibling - (Matcher<View> siblingMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns an - Matcher that matches Views based on their siblings.
    -
    - This may be particularly useful when a view cannot be uniquely selected on properties such as - text or R.id. For example: a call button is repeated several times in a contacts layout and the - only way to differentiate the call button view is by what appears next to it (e.g. the unique - name of the contact).

    -
    -
    Parameters
    - - - - -
    siblingMatcher - a - - Matcher for the sibling of the view. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isAssignableFrom - (Class<? extends View> clazz) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views which are an instance of or subclass of the provided - class. Some versions of Hamcrest make the generic typing of this a nightmare, so we have a - special case for our users. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isChecked - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that accepts if and only if the view is a CompoundButton (or subtype of) and - is in checked state. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isClickable - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views that are clickable. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isCompletelyDisplayed - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher which only accepts a view whose height and width fit perfectly within - the currently displayed region of this view. - - There exist views (such as ScrollViews) whose height and width are larger then the physical - device screen by design. Such views will _never_ be completely displayed. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isDescendantOfA - (Matcher<View> ancestorMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views based on the given ancestor type.

    -
    -
    Parameters
    - - - - -
    ancestorMatcher - the type of the ancestor to match on -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isDisplayed - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views that are currently displayed on the screen to the - user. - - Note: isDisplayed will select views that are partially displayed (eg: the full height/width of - the view is greater then the height/width of the visible rectangle). If you wish to ensure the - entire rectangle this view draws is displayed to the user use isCompletelyDisplayed. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isDisplayingAtLeast - (int areaPercentage) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher which accepts a view so long as a given percentage of that view's area is - not obscured by any other view and is thus visible to the user.

    -
    -
    Parameters
    - - - - -
    areaPercentage - an integer ranging from (0, 100] indicating how much percent of the - surface area of the view must be shown to the user to be accepted. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isEnabled - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views that are enabled. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isFocusable - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views that are focusable. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isJavascriptEnabled - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches WebView if they are evaluating Javascript. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isNotChecked - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that accepts if and only if the view is a CompoundButton (or subtype of) and - is not in checked state. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isRoot - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches root View. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - isSelected - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views that are selected. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - supportsInputMethods - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches views that support input methods. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - withChild - (Matcher<View> childMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    A matcher that returns true if and only if the view's child is accepted by the provided - matcher.

    -
    -
    Parameters
    - - - - -
    childMatcher - the matcher to apply on the child views. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - withClassName - (Matcher<String> classNameMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views with class name matching the given matcher. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - withContentDescription - (String text) -

    -
    -
    - - - -
    -
    - - - - -

    Returns an - Matcher that matches Views based on content description property - value. Sugar for withContentDescription(is("string")).

    -
    -
    Parameters
    - - - - -
    text - the text to match on. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - withContentDescription - (Matcher<? extends CharSequence> charSequenceMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Returns an - Matcher that matches Views based on content description property - value.

    -
    -
    Parameters
    - - - - -
    charSequenceMatcher - a CharSequence - - Matcher for the content description -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - withContentDescription - (int resourceId) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a - Matcher that matches Views based on content description property - value.

    -
    -
    Parameters
    - - - - -
    resourceId - the resource id of the content description to match on. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - withEffectiveVisibility - (ViewMatchers.Visibility visibility) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches Views that have "effective" visibility set to the given - value. Effective visibility takes into account not only the view's visibility value, but also - that of its ancestors. In case of View.VISIBLE, this means that the view and all of its - ancestors have visibility=VISIBLE. In case of GONE and INVISIBLE, it's the opposite - any GONE - or INVISIBLE parent will make all of its children have their effective visibility. - -

    -

    - Note: Contrary to what the name may imply, view visibility does not directly translate into - whether the view is displayed on screen (use isDisplayed() for that). For example, the view and - all of its ancestors can have visibility=VISIBLE, but the view may need to be scrolled to in - order to be actually visible to the user. Unless you're specifically targeting the visibility - value with your test, use isDisplayed. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - Matcher<View> - - withHint - (int resourceId) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a matcher that matches a descendant of TextView that is displaying the hint - associated with the given resource id.

    -
    -
    Parameters
    - - - - -
    resourceId - the string resource the text view is expected to have as a hint. -
    -
    +
    +

    isAssignableFrom

    +
    +
    + +
    -
    - - - +
    +Matcher<View> isAssignableFrom (Class<? extends View> clazz)
    + + -
    -

    - - public - static + +

    Returns a matcher that matches Views which are an instance of or subclass of the provided + class. Some versions of Hamcrest make the generic typing of this a nightmare, so we have a + special case for our users. +

    + + + + + + +
    Parameters
    clazz + Class +
    + + + + + + +
    Returns
    Matcher<View>
    +

    - Matcher<View> - - withHint - (Matcher<String> stringMatcher) - -
    -
    + +
    +

    isChecked

    +
    +
    + + +
    +
    +Matcher<View> isChecked ()
    + + -
    -
    + +

    Returns a matcher that accepts if and only if the view is a CompoundButton (or subtype of) and + is in checked state. +

    + + + + + + +
    Returns
    Matcher<View>
    +
    + -

    Returns a matcher that matches TextViews based on hint property value. Note: View's - hint property can be null.

    -
    -
    Parameters
    - - - - -
    stringMatcher - - Matcher of String with text to match -
    -
    +
    +

    isClickable

    +
    +
    + +
    -
    +
    +Matcher<View> isClickable ()
    + + + +

    Returns a matcher that matches Views that are clickable. +

    + + + + + + +
    Returns
    Matcher<View>
    - +
    -
    -

    - - public - static + +
    +

    isCompletelyDisplayed

    +
    +
    + + - Matcher<View> - - withHint - (String hintText) -

    -
    -
    +
    +
    +Matcher<View> isCompletelyDisplayed ()
    + + + +

    Returns a matcher which only accepts a view whose height and width fit perfectly within + the currently displayed region of this view. + There exist views (such as ScrollViews) whose height and width are larger then the physical + device screen by design. Such views will _never_ be completely displayed. +

    + + + + + + +
    Returns
    Matcher<View>
    -
    -
    +
    + +
    +

    isDescendantOfA

    +
    +
    + + -

    Returns a matcher that matches TextView based on it's hint property value. Note: View's - Sugar for withHint(is("string")).

    -
    -
    Parameters
    - - - +
    hintText - String with the hint text to match + +
    +Matcher<View> isDescendantOfA (Matcher<View> ancestorMatcher)
    + + + + +

    Returns a matcher that matches Views based on the given ancestor type.

    + + + + + - -
    Parameters
    ancestorMatcher + Matcher: + the type of the ancestor to match on
    - +
    + + + + + + +
    Returns
    Matcher<View>
    -
    - - -
    -

    - - public - static - + +
    +

    isDisplayed

    +
    +
    + + - Matcher<View> - - withId - (Matcher<Integer> integerMatcher) -

    -
    -
    +
    +
    +Matcher<View> isDisplayed ()
    + + + +

    Returns a matcher that matches Views that are currently displayed on the screen to the + user. + Note: isDisplayed will select views that are partially displayed (eg: the full height/width of + the view is greater then the height/width of the visible rectangle). If you wish to ensure the + entire rectangle this view draws is displayed to the user use isCompletelyDisplayed. +

    + + + + + + +
    Returns
    Matcher<View>
    -
    -
    +
    + +
    +

    isDisplayingAtLeast

    +
    +
    + + -

    Returns a matcher that matches Views based on resource ids. Note: Android resource ids - are not guaranteed to be unique. You may have to pair this matcher with another one to - guarantee a unique view selection.

    -
    -
    Parameters
    - - - +
    integerMatcher - a Matcher for resource ids + +
    +Matcher<View> isDisplayingAtLeast (int areaPercentage)
    + + + + +

    Returns a matcher which accepts a view so long as a given percentage of that view's area is + not obscured by any other view and is thus visible to the user.

    + + + + + - -
    Parameters
    areaPercentage + int: + an integer ranging from (0, 100] indicating how much percent of the + surface area of the view must be shown to the user to be accepted.
    - +
    + + + + + + +
    Returns
    Matcher<View>
    -
    - + -
    -

    - - public - static +
    +

    isEnabled

    +
    +
    + + +
    +
    +Matcher<View> isEnabled ()
    + + + +

    Returns a matcher that matches Views that are enabled. +

    + + + + + + +
    Returns
    Matcher<View>
    - Matcher<View> - - withId - (int id) -

    -
    -
    +
    + -
    -
    +
    +

    isFocusable

    +
    +
    + + +
    +
    +Matcher<View> isFocusable ()
    + + + +

    Returns a matcher that matches Views that are focusable. +

    + + + + + + +
    Returns
    Matcher<View>
    +
    -

    Same as withId(is(int)), but attempts to look up resource name of the given id and use an - R.id.myView style description with describeTo. If resource lookup is unavailable, at the time - describeTo is invoked, this will print out a simple "with id: %d". If resource lookup is - available, but looking up the name for the given id, fails, "with id: %d (resource name not - found)" will be returned as the description.

    -
    -
    Parameters
    - - - - -
    id - the resource id. -
    -
    -
    -
    + +
    +

    isJavascriptEnabled

    +
    +
    + + - +
    +
    +Matcher<View> isJavascriptEnabled ()
    + + -
    -

    - - public - static + +

    Returns a matcher that matches WebView if they are evaluating Javascript. +

    + + + + + + +
    Returns
    Matcher<View>
    +

    - Matcher<View> - - withInputType - (int inputType) - -
    -
    + +
    +

    isNotChecked

    +
    +
    + + +
    +
    +Matcher<View> isNotChecked ()
    + + -
    -
    + +

    Returns a matcher that accepts if and only if the view is a CompoundButton (or subtype of) and + is not in checked state. +

    + + + + + + +
    Returns
    Matcher<View>
    +
    + -

    Returns a matcher that matches InputType. -

    +
    +

    isRoot

    +
    +
    + +
    -
    +
    +Matcher<View> isRoot ()
    + + + +

    Returns a matcher that matches root View. +

    + + + + + + +
    Returns
    Matcher<View>
    - +
    -
    -

    - - public - static + +
    +

    isSelected

    +
    +
    + + - Matcher<View> - - withParent - (Matcher<View> parentMatcher) -

    -
    -
    +
    +
    +Matcher<View> isSelected ()
    + + + +

    Returns a matcher that matches Views that are selected. +

    + + + + + + +
    Returns
    Matcher<View>
    +
    -
    -
    + +
    +

    supportsInputMethods

    +
    +
    + + +
    +
    +Matcher<View> supportsInputMethods ()
    + + -

    A matcher that accepts a view if and only if the view's parent is accepted by the provided - matcher.

    -
    -
    Parameters
    - - - - -
    parentMatcher - the matcher to apply on getParent. -
    -
    + +

    Returns a matcher that matches views that support input methods. +

    + + + + + + +
    Returns
    Matcher<View>
    -
    - + -
    -

    - - public - static +
    +

    withChild

    +
    +
    + + + +
    +
    +Matcher<View> withChild (Matcher<View> childMatcher)
    + + + + +

    A matcher that returns true if and only if the view's child is accepted by the provided + matcher.

    + + + + + + +
    Parameters
    childMatcher + Matcher: + the matcher to apply on the child views. +
    + + + + + + +
    Returns
    Matcher<View>
    +
    - Matcher<View> -
    - withSpinnerText - (String text) -

    -
    -
    + +
    +

    withClassName

    +
    +
    + + +
    +
    +Matcher<View> withClassName (Matcher<String> classNameMatcher)
    + + -
    -
    + +

    Returns a matcher that matches Views with class name matching the given matcher. +

    + + + + + + +
    Parameters
    classNameMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<View>
    +
    + -

    Returns a matcher that matches Spinner based on it's selected item's toString value. -

    - Note: Sugar for withSpinnerText(is("string")). -

    +
    +

    withContentDescription

    +
    +
    + +
    +
    +Matcher<View> withContentDescription (int resourceId)
    + + + + +

    Returns a + Matcher that matches Views based on content description property + value.

    + + + + + + +
    Parameters
    resourceId + int: + the resource id of the content description to match on. +
    + + + + + + +
    Returns
    Matcher<View>
    +
    - + -
    -

    - - public - static +
    +

    withContentDescription

    +
    +
    + + +
    +
    +Matcher<View> withContentDescription (String text)
    + + + + +

    Returns an + Matcher that matches Views based on content description property + value. Sugar for withContentDescription(is("string")).

    + + + + + + +
    Parameters
    text + String: + the text to match on. +
    + + + + + + +
    Returns
    Matcher<View>
    +
    - Matcher<View> -
    - withSpinnerText - (int resourceId) -

    -
    -
    + +
    +

    withContentDescription

    +
    +
    + + -
    -
    +
    +
    +Matcher<View> withContentDescription (Matcher<? extends CharSequence> charSequenceMatcher)
    + + + + +

    Returns an + Matcher that matches Views based on content description property + value.

    + + + + + + +
    Parameters
    charSequenceMatcher + Matcher: + a CharSequence + + Matcher for the content description +
    + + + + + + +
    Returns
    Matcher<View>
    +
    + -

    Returns a matcher that matches a descendant of Spinner that is displaying the string - of the selected item associated with the given resource id.

    -
    -
    Parameters
    - - - - -
    resourceId - the string resource the text view is expected to hold. -
    -
    +
    +

    withEffectiveVisibility

    +
    +
    + +
    -
    - +
    +Matcher<View> withEffectiveVisibility (ViewMatchers.Visibility visibility)
    + + - + +

    Returns a matcher that matches Views that have "effective" visibility set to the given + value. Effective visibility takes into account not only the view's visibility value, but also + that of its ancestors. In case of View.VISIBLE, this means that the view and all of its + ancestors have visibility=VISIBLE. In case of GONE and INVISIBLE, it's the opposite - any GONE + or INVISIBLE parent will make all of its children have their effective visibility. -

    -

    - - public - static +

    +

    + Note: Contrary to what the name may imply, view visibility does not directly translate into + whether the view is displayed on screen (use isDisplayed() for that). For example, the view and + all of its ancestors can have visibility=VISIBLE, but the view may need to be scrolled to in + order to be actually visible to the user. Unless you're specifically targeting the visibility + value with your test, use isDisplayed. +

    + + + + + + +
    Parameters
    visibility + ViewMatchers.Visibility +
    + + + + + + +
    Returns
    Matcher<View>
    +

    - Matcher<View> - - withSpinnerText - (Matcher<String> stringMatcher) - -
    -
    + +
    +

    withHint

    +
    +
    + + +
    +
    +Matcher<View> withHint (Matcher<String> stringMatcher)
    + + + + +

    Returns a matcher that matches TextViews based on hint property value. Note: View's + hint property can be null.

    + + + + + + +
    Parameters
    stringMatcher + Matcher: + + Matcher of String with text to match +
    + + + + + + +
    Returns
    Matcher<View>
    -
    -
    +
    + +
    +

    withHint

    +
    +
    + + -

    Returns a matcher that matches Spinners based on toString value of the selected item.

    -
    -
    Parameters
    - - - +
    stringMatcher - - Matcher of String with text to match. + +
    +Matcher<View> withHint (int resourceId)
    + + + + +

    Returns a matcher that matches a descendant of TextView that is displaying the hint + associated with the given resource id.

    + + + + + - -
    Parameters
    resourceId + int: + the string resource the text view is expected to have as a hint.
    - +
    + + + + + + +
    Returns
    Matcher<View>
    -
    - + -
    -

    - - public - static +
    +

    withHint

    +
    +
    + + + +
    +
    +Matcher<View> withHint (String hintText)
    + + + + +

    Returns a matcher that matches TextView based on it's hint property value. Note: View's + Sugar for withHint(is("string")).

    + + + + + + +
    Parameters
    hintText + String: + String with the hint text to match +
    + + + + + + +
    Returns
    Matcher<View>
    +
    - Matcher<View> -
    - withTagKey - (int key, Matcher<Object> objectMatcher) -

    -
    -
    + +
    +

    withId

    +
    +
    + + +
    +
    +Matcher<View> withId (Matcher<Integer> integerMatcher)
    + + -
    -
    + +

    Returns a matcher that matches Views based on resource ids. Note: Android resource ids + are not guaranteed to be unique. You may have to pair this matcher with another one to + guarantee a unique view selection.

    + + + + + + +
    Parameters
    integerMatcher + Matcher: + a Matcher for resource ids +
    + + + + + + +
    Returns
    Matcher<View>
    +
    + -

    Returns a matcher that matches Views based on tag keys.

    -
    -
    Parameters
    - - - - - - - -
    key - to match
    objectMatcher - Object to match -
    -
    +
    +

    withId

    +
    +
    + +
    -
    - +
    +Matcher<View> withId (int id)
    + + - + +

    Same as withId(is(int)), but attempts to look up resource name of the given id and use an + R.id.myView style description with describeTo. If resource lookup is unavailable, at the time + describeTo is invoked, this will print out a simple "with id: %d". If resource lookup is + available, but looking up the name for the given id, fails, "with id: %d (resource name not + found)" will be returned as the description.

    + + + + + + +
    Parameters
    id + int: + the resource id. +
    + + + + + + +
    Returns
    Matcher<View>
    -
    -

    - - public - static +

    + - Matcher<View> - - withTagKey - (int key) - -
    -
    +
    +

    withInputType

    +
    +
    + + +
    +
    +Matcher<View> withInputType (int inputType)
    + + + +

    Returns a matcher that matches InputType. +

    + + + + + + +
    Parameters
    inputType + int +
    + + + + + + +
    Returns
    Matcher<View>
    -
    -
    +
    + +
    +

    withParent

    +
    +
    + + -

    Returns a matcher that matches View based on tag keys.

    -
    -
    Parameters
    - - - +
    key - to match + +
    +Matcher<View> withParent (Matcher<View> parentMatcher)
    + + + + +

    A matcher that accepts a view if and only if the view's parent is accepted by the provided + matcher.

    + + + + + - -
    Parameters
    parentMatcher + Matcher: + the matcher to apply on getParent.
    - +
    + + + + + + +
    Returns
    Matcher<View>
    -
    - + -
    -

    - - public - static +
    +

    withResourceName

    +
    +
    + + + +
    +
    +Matcher<View> withResourceName (String name)
    + + + + +

    Returns a matcher that matches Views based on resource id names, + (for instance, channel_avatar).

    + + + + + + +
    Parameters
    name + String: + the resource id name +
    + + + + + + +
    Returns
    Matcher<View>
    +
    - Matcher<View> -
    - withTagValue - (Matcher<Object> tagValueMatcher) -

    -
    -
    + +
    +

    withResourceName

    +
    +
    + + +
    +
    +Matcher<View> withResourceName (Matcher<String> stringMatcher)
    + + + + +

    Returns a matcher that matches Views based on resource id names, + (for instance, channel_avatar).

    + + + + + + +
    Parameters
    stringMatcher + Matcher: + a Matcher for resource id names +
    + + + + + + +
    Returns
    Matcher<View>
    -
    -
    +
    + +
    +

    withSpinnerText

    +
    +
    + + -

    Returns a matcher that matches Views based on tag property values.

    -
    -
    Parameters
    - - - +
    tagValueMatcher - a Matcher for the view's tag property value + +
    +Matcher<View> withSpinnerText (int resourceId)
    + + + + +

    Returns a matcher that matches a descendant of Spinner that is displaying the string + of the selected item associated with the given resource id.

    + + + + + - -
    Parameters
    resourceId + int: + the string resource the text view is expected to hold.
    - +
    + + + + + + +
    Returns
    Matcher<View>
    -
    - - -
    -

    - - public - static - - + - Matcher<View> - - withText - (String text) -

    -
    -
    +
    +

    withSpinnerText

    +
    +
    + + +
    +
    +Matcher<View> withSpinnerText (String text)
    + + + +

    Returns a matcher that matches Spinner based on it's selected item's toString value. +

    + Note: Sugar for withSpinnerText(is("string")). +

    + + + + + + +
    Parameters
    text + String +
    + + + + + + +
    Returns
    Matcher<View>
    -
    -
    +
    + +
    +

    withSpinnerText

    +
    +
    + + -

    Returns a matcher that matches TextView based on its text property value. Note: View's - Sugar for withText(is("string")).

    -
    -
    Parameters
    - - - +
    text - String with the text to match + +
    +Matcher<View> withSpinnerText (Matcher<String> stringMatcher)
    + + + + +

    Returns a matcher that matches Spinners based on toString value of the selected item.

    + + + + + - -
    Parameters
    stringMatcher + Matcher: + + Matcher of String with text to match.
    - +
    + + + + + + +
    Returns
    Matcher<View>
    -
    - + -
    -

    - - public - static +
    +

    withTagKey

    +
    +
    + + +
    +
    +Matcher<View> withTagKey (int key)
    + + + + +

    Returns a matcher that matches View based on tag keys.

    + + + + + + +
    Parameters
    key + int: + to match +
    + + + + + + +
    Returns
    Matcher<View>
    +
    - Matcher<View> -
    - withText - (Matcher<String> stringMatcher) -

    -
    -
    + +
    +

    withTagKey

    +
    +
    + + -
    -
    +
    +
    +Matcher<View> withTagKey (int key, 
    +                Matcher<Object> objectMatcher)
    + + + + +

    Returns a matcher that matches Views based on tag keys.

    + + + + + + + + + + +
    Parameters
    key + int: + to match
    objectMatcher + Matcher: + Object to match +
    + + + + + + +
    Returns
    Matcher<View>
    +
    + -

    Returns a matcher that matches TextViews based on text property value. Note: View's - text property is never null. If you setText(null) it will still be "". Do not use null matcher.

    -
    -
    Parameters
    - - - - -
    stringMatcher - - Matcher of String with text to match -
    -
    +
    +

    withTagValue

    +
    +
    + +
    +
    +Matcher<View> withTagValue (Matcher<Object> tagValueMatcher)
    + + + + +

    Returns a matcher that matches Views based on tag property values.

    + + + + + + +
    Parameters
    tagValueMatcher + Matcher: + a Matcher for the view's tag property value +
    + + + + + + +
    Returns
    Matcher<View>
    +
    - + -
    -

    - - public - static +
    +

    withText

    +
    +
    + + +
    +
    +Matcher<View> withText (Matcher<String> stringMatcher)
    + + + + +

    Returns a matcher that matches TextViews based on text property value. Note: View's + text property is never null. If you setText(null) it will still be "". Do not use null matcher.

    + + + + + + +
    Parameters
    stringMatcher + Matcher: + + Matcher of String with text to match +
    + + + + + + +
    Returns
    Matcher<View>
    +
    - Matcher<View> -
    - withText - (int resourceId) -

    -
    -
    + +
    +

    withText

    +
    +
    + + -
    -
    +
    +
    +Matcher<View> withText (String text)
    + + + + +

    Returns a matcher that matches TextView based on its text property value. Note: View's + Sugar for withText(is("string")).

    + + + + + + +
    Parameters
    text + String: + String with the text to match +
    + + + + + + +
    Returns
    Matcher<View>
    +
    + -

    Returns a matcher that matches a descendant of TextView that is displaying the string - associated with the given resource id.

    -
    -
    Parameters
    - - - - -
    resourceId - the string resource the text view is expected to hold. -
    -
    +
    +

    withText

    +
    +
    + +
    +
    +Matcher<View> withText (int resourceId)
    + + + + +

    Returns a matcher that matches a descendant of TextView that is displaying the string + associated with the given resource id.

    + + + + + + +
    Parameters
    resourceId + int: + the string resource the text view is expected to hold. +
    + + + + + + +
    Returns
    Matcher<View>
    +
    @@ -4001,193 +3822,39 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/matcher/package-summary.html b/docs/html/reference/android/support/test/espresso/matcher/package-summary.html index 8c87e684b7ec..fe2187077284 100644 --- a/docs/html/reference/android/support/test/espresso/matcher/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/matcher/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,820 +92,222 @@ - - - - - - -android.support.test.espresso.matcher | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.matcher - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.matcher

    -
    - -
    - -
    - - - +

    android.support.test.espresso.matcher

    + + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + +
    BoundedMatcher<T, S extends T>BoundedMatcher<T, S extends T> Some matcher sugar that lets you create a matcher for a given type but only process items of a specific subtype of that matcher.  - - + +
    CursorMatchersCursorMatchers - A collection of Hamcrest matchers that matches a data row in a Cursor.  - - + A collection of Hamcrest matchers that matches a data row in a Cursor.  + +
    CursorMatchers.CursorMatcherCursorMatchers.CursorMatcher - A Matcher that matches Cursors based on values in their columns.  - - + A Matcher that matches Cursors based on values in their columns.  + +
    LayoutMatchersLayoutMatchers A collection of hamcrest matches to detect typical layout issues.  - - + +
    PreferenceMatchersPreferenceMatchers - A collection of hamcrest matchers that match Preferences.  - - + A collection of hamcrest matchers that match Preferences.  + +
    RootMatchersRootMatchers - A collection of matchers for Root objects.  - - + A collection of matchers for Root objects.  + +
    ViewMatchersViewMatchers - A collection of hamcrest matchers that match Views.  - - + A collection of hamcrest matchers that match Views.  + +
    -
    - - + +

    Enums

    -
    - - + + - + - + + + +
    ViewMatchers.VisibilityViewMatchers.Visibility Enumerates the possible list of values for View.getVisibility().  - - + +
    + + + + -
    -
    - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + +
    + + diff --git a/docs/html/reference/android/support/test/espresso/package-summary.html b/docs/html/reference/android/support/test/espresso/package-summary.html index 45198104a54f..32e4d5b322c5 100644 --- a/docs/html/reference/android/support/test/espresso/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,1091 +92,491 @@ - - - - - - -android.support.test.espresso | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso

    -
    - -
    - -
    - - +

    android.support.test.espresso

    + +

    Interfaces

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + +
    BaseLayerComponentBaseLayerComponent Dagger component for base classes.  - - + +
    EspressoExceptionEspressoException - Used for identifying an exception as coming from the Espresso framework.  - - + Used for identifying an exception as coming from the Espresso framework.  + +
    FailureHandlerFailureHandler Handles failures that happen during test execution.  - - + +
    IdlingResourceIdlingResource Represents a resource of an application under test which can cause asynchronous background work to happen during test execution (e.g.  - - + +
    IdlingResource.ResourceCallbackIdlingResource.ResourceCallback - Registered by an IdlingResource to notify Espresso of a transition to idle.  - - + Registered by an IdlingResource to notify Espresso of a transition to idle.  + +
    UiControllerUiController - Provides base-level UI operations (such as injection of MotionEvents) that can be used to + Provides base-level UI operations (such as injection of MotionEvents) that can be used to build user actions such as clicks, scrolls, swipes, etc.  - - + +
    ViewActionViewAction Responsible for performing an interaction on the given View element.  - - + +
    ViewAssertionViewAssertion Responsible for performing assertions on a View element.  - - + +
    ViewFinderViewFinder Uses matchers to locate particular views within the view hierarchy.  - - + +
    ViewInteractionComponentViewInteractionComponent Dagger component for view interaction classes.  - - + +
    -
    - - + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + +
    AmbiguousViewMatcherException.BuilderAmbiguousViewMatcherException.Builder - Builder for AmbiguousViewMatcherException.  - - + Builder for AmbiguousViewMatcherException.  + +
    DataInteractionDataInteraction An interface to interact with data displayed in AdapterViews.  - - + +
    EspressoEspresso Entry point to the Espresso framework.  - - + +
    GraphHolderGraphHolder Holds Espresso's object graph.  - - + +
    IdlingPoliciesIdlingPolicies Allows users fine grain control over idling policies.  - - + +
    IdlingPolicyIdlingPolicy Allows users to control idling idleTimeouts in Espresso.  - - + +
    NoMatchingViewException.BuilderNoMatchingViewException.Builder - Builder for NoMatchingViewException.  - - + Builder for NoMatchingViewException.  + +
    PerformException.BuilderPerformException.Builder - Builder for PerformException.  - - + Builder for PerformException.  + +
    RootRoot Represents a root view in the application and optionally the layout params of the window holding it.  - - + +
    Root.BuilderRoot.Builder   - - + +
    ViewInteractionViewInteraction Provides the primary interface for test authors to perform actions or asserts on views.  - - + +
    -
    - - - + + +

    Exceptions

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + + + +
    AmbiguousViewMatcherExceptionAmbiguousViewMatcherException An exception which indicates that a Matcher matched multiple views in the hierarchy when only one view was expected.  - - + +
    AppNotIdleExceptionAppNotIdleException An exception which indicates that the App has not become idle even after the specified duration.  - - + +
    IdlingResourceTimeoutExceptionIdlingResourceTimeoutException - Indicates that an IdlingResource, which has been registered with the framework, has not + Indicates that an IdlingResource, which has been registered with the framework, has not idled within the allowed time.  - - + +
    InjectEventSecurityExceptionInjectEventSecurityException - An checked Exception indicating that event injection failed with a - SecurityException.  - - + An checked Exception indicating that event injection failed with a + SecurityException.  + +
    NoActivityResumedExceptionNoActivityResumedException An exception which indicates that there are no activities in stage RESUMED.  - - + +
    NoMatchingRootExceptionNoMatchingRootException - Indicates that a given matcher did not match any Roots (windows) from those that are + Indicates that a given matcher did not match any Roots (windows) from those that are currently available.  - - + +
    NoMatchingViewExceptionNoMatchingViewException Indicates that a given matcher did not match any elements in the view hierarchy.  - - + +
    PerformExceptionPerformException Indicates that an exception occurred while performing a ViewAction on the UI thread.  - - + +
    + -
    -
    - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + + +
    + diff --git a/docs/html/reference/android/support/test/espresso/util/ActivityLifecycles.html b/docs/html/reference/android/support/test/espresso/util/ActivityLifecycles.html index 95a6b3ed6d02..7881f7a7368f 100644 --- a/docs/html/reference/android/support/test/espresso/util/ActivityLifecycles.html +++ b/docs/html/reference/android/support/test/espresso/util/ActivityLifecycles.html @@ -1,4 +1,3 @@ - @@ -93,484 +92,85 @@ - - - - - - -ActivityLifecycles | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ActivityLifecycles - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ActivityLifecycles

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    ActivityLifecycles

    +

    + + public + + final + + class + ActivityLifecycles + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.util.ActivityLifecycles
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.util.ActivityLifecycles +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Helper methods to understand ActivityLifecycle of the app. +

    Helper methods to understand ActivityLifecycle of the app.

    -
    - - - - - - - - - - - - - - - -
    - -

    Summary

    +

    Summary

    @@ -722,79 +295,92 @@ Summary: - - - - - - - - - - - - -
    Public Methods
    - - - - static - - boolean - - hasForegroundActivities(ActivityLifecycleMonitor monitor) - -
    - Indicates whether or not an Activity in our app is currently in the foreground. - - - -
    - -
    - + + - static - boolean - - + + + + + + + + + + + + + + + - - - - - - - + + +

    + + + + + + + + + + + + + +

    Public methods

    - hasTransitioningActivities(ActivityLifecycleMonitor monitor) - -
    - Indicates whether or not an Activity, not in the foreground, exists in our app within the + +
    + + + static + + + boolean + + + hasForegroundActivities(ActivityLifecycleMonitor monitor) + + +

    Indicates whether or not an Activity in our app is currently in the foreground. + + +

    + +
    + + + static + + + boolean + + + hasTransitioningActivities(ActivityLifecycleMonitor monitor) + + +

    Indicates whether or not an Activity, not in the foreground, exists in our app within the "Visible Lifetime" state. - - - - - -

    - - - - static - - boolean - - hasVisibleActivities(ActivityLifecycleMonitor monitor) - -
    - Indicates whether or not an Activity exists in our app within the "Visible Lifetime" state. - - - -
    - -
    + + + static + + + boolean + + + hasVisibleActivities(ActivityLifecycleMonitor monitor) + + +

    Indicates whether or not an Activity exists in our app within the "Visible Lifetime" state. + + +

    + +
    @@ -806,207 +392,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1015,16 +670,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1050,89 +695,71 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - boolean - - hasForegroundActivities - (ActivityLifecycleMonitor monitor) -

    -
    -
    - - - -
    -
    - - +
    +

    hasForegroundActivities

    +
    +
    + + +
    +
    +boolean hasForegroundActivities (ActivityLifecycleMonitor monitor)
    + + -

    Indicates whether or not an Activity in our app is currently in the foreground. + +

    Indicates whether or not an Activity in our app is currently in the foreground.

    The "Foreground lifetime" of an activity occurs after a call to onResume and before a call to onPause.

    During this time, the activity is in front of all other activities and is currently - receiving user input.

    -
    -
    Parameters
    - - - - -
    monitor - the ActivityLifecycleMonitor to use.
    -
    -
    -
    Returns
    -
    • true if an activity exists in the foreground state. -
    -
    + receiving user input.

    + + + + + + +
    Parameters
    monitor + ActivityLifecycleMonitor: + the ActivityLifecycleMonitor to use.
    + + + + + + +
    Returns
    booleantrue if an activity exists in the foreground state. +
    -
    -
    -

    - - public - static - - - - boolean - - hasTransitioningActivities - (ActivityLifecycleMonitor monitor) -

    -
    -
    - - - -
    -
    - - +
    +

    hasTransitioningActivities

    +
    +
    + + +
    +
    +boolean hasTransitioningActivities (ActivityLifecycleMonitor monitor)
    + + -

    Indicates whether or not an Activity, not in the foreground, exists in our app within the + +

    Indicates whether or not an Activity, not in the foreground, exists in our app within the "Visible Lifetime" state.

    The "Visible Lifetime" is defined as an activity where the onStart() method has been called @@ -1144,53 +771,45 @@ From class

    It may be the case that an application has activities in the "visible lifetime" but none in the "Foreground lifetime." It may be the case that without user input an activity will shortly transition into the "Foreground lifetime" in this state, however it also may not transition - without further user interaction.

    -
    -
    Parameters
    - - - - -
    monitor - the ActivityLifecycleMonitor to use
    -
    -
    -
    Returns
    -
    • true if any activity exists with a transitioning stage. -
    -
    + without further user interaction.

    + + + + + + +
    Parameters
    monitor + ActivityLifecycleMonitor: + the ActivityLifecycleMonitor to use
    + + + + + + +
    Returns
    booleantrue if any activity exists with a transitioning stage. +
    -
    -
    -

    - - public - static - - - - boolean - - hasVisibleActivities - (ActivityLifecycleMonitor monitor) -

    -
    -
    - - - -
    -
    - - +
    +

    hasVisibleActivities

    +
    +
    + + +
    +
    +boolean hasVisibleActivities (ActivityLifecycleMonitor monitor)
    + + -

    Indicates whether or not an Activity exists in our app within the "Visible Lifetime" state. + +

    Indicates whether or not an Activity exists in our app within the "Visible Lifetime" state.

    The "Visible Lifetime" is defined as an activity where the onStart() method has been called but where the onStop() method has not been called. @@ -1201,23 +820,25 @@ From class

    It may be the case that an application has activities in the "visible lifetime" but none in the "Foreground lifetime." It may be the case that without user input an activity will shortly transition into the "Foreground lifetime" in this state, however it also may not transition - without further user interaction.

    -
    -
    Parameters
    - - - - -
    monitor - the ActivityLifecycleMonitor to use
    -
    -
    -
    Returns
    -
    • true if any activity exists within it's foreground lifetime. -
    -
    + without further user interaction.

    + + + + + + +
    Parameters
    monitor + ActivityLifecycleMonitor: + the ActivityLifecycleMonitor to use
    + + + + + + +
    Returns
    booleantrue if any activity exists within it's foreground lifetime. +
    -
    @@ -1229,193 +850,31 @@ From class - -
    - -
    - -
    - - -
    - -
    - + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/util/HumanReadables.html b/docs/html/reference/android/support/test/espresso/util/HumanReadables.html index fe73d805f905..a8ffbbad6dd7 100644 --- a/docs/html/reference/android/support/test/espresso/util/HumanReadables.html +++ b/docs/html/reference/android/support/test/espresso/util/HumanReadables.html @@ -1,4 +1,3 @@ - @@ -93,484 +92,85 @@ - - - - - - -HumanReadables | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +HumanReadables - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    HumanReadables

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    HumanReadables

    +

    + + public + + final + + class + HumanReadables + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.util.HumanReadables
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.util.HumanReadables +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Text converters for various Android objects. +

    Text converters for various Android objects.

    -
    - - - - - - - - - - - - - - - -
    - -

    Summary

    +

    Summary

    @@ -722,71 +295,86 @@ Summary: - - - - - - - - - - - - - @@ -1154,16 +825,6 @@ From interface
    Public Methods
    - - - - static - - String - - describe(View v) - -
    - Transforms an arbitrary view into a string with (hopefully) enough debug info. - - - -
    - -
    - + + - static - - String - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - describe(Cursor c) - -
    - - - - static - - String - - getViewHierarchyErrorMessage(View rootView, List<View> problemViews, String errorHeader, String problemViewSuffix) - -
    - Prints out an error message feature the view hierarchy starting at the rootView. - - - -
    - -
    + + + static + + + String + + + describe(Cursor c) + + +
    + + + static + + + String + + + describe(View v) + + +

    Transforms an arbitrary view into a string with (hopefully) enough debug info. + + +

    + +
    + + + static + + + String + + + getViewHierarchyErrorMessage(View rootView, List<View> problemViews, String errorHeader, String problemViewSuffix) + + +

    Prints out an error message feature the view hierarchy starting at the rootView. + + +

    + +
    @@ -798,207 +386,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1007,16 +664,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1042,146 +689,144 @@ From class -

    Public Methods

    - +

    Public methods

    - - -
    -

    - - public - static - - - - String - - describe - (View v) -

    -
    -
    - - - -
    -
    - - - - -

    Transforms an arbitrary view into a string with (hopefully) enough debug info.

    -
    -
    Parameters
    - - - - -
    v - nullable view
    -
    -
    -
    Returns
    -
    • a string for human consumption. -
    -
    - -
    -
    - -
    -

    - - public - static - - - - String - - describe - (Cursor c) -

    -
    -
    +
    +

    describe

    +
    +
    + + +
    +
    +String describe (Cursor c)
    + + + + +

    + + + + + + +
    Parameters
    c + Cursor +
    + + + + + + +
    Returns
    String
    - -
    -
    - +
    + -

    +
    +

    describe

    +
    +
    + +
    +
    +String describe (View v)
    + + + + +

    Transforms an arbitrary view into a string with (hopefully) enough debug info.

    + + + + + + +
    Parameters
    v + View: + nullable view
    + + + + + + +
    Returns
    Stringa string for human consumption. +
    +
    -
    -

    - - public - static - - - - String - - getViewHierarchyErrorMessage - (View rootView, List<View> problemViews, String errorHeader, String problemViewSuffix) -

    -
    -
    - - - -
    -
    +
    +

    getViewHierarchyErrorMessage

    +
    +
    + + - - - -

    Prints out an error message feature the view hierarchy starting at the rootView.

    -
    -
    Parameters
    - - - - - - +
    rootView - the root of the hierarchy tree to print out.
    problemViews - list of the views that you would like to point out are causing the error + +
    +String getViewHierarchyErrorMessage (View rootView, 
    +                List<View> problemViews, 
    +                String errorHeader, 
    +                String problemViewSuffix)
    + + + + +

    Prints out an error message feature the view hierarchy starting at the rootView.

    + + + + + + + + + - - - + + + - - - + + + - -
    Parameters
    rootView + View: + the root of the hierarchy tree to print out.
    problemViews + List: + list of the views that you would like to point out are causing the error message or null, if you want to skip this feature.
    errorHeader - the header of the error message (should contain the description of why the +
    errorHeader + String: + the header of the error message (should contain the description of why the error is happening).
    problemViewSuffix - the message to append to the view description in the tree printout. +
    problemViewSuffix + String: + the message to append to the view description in the tree printout. Required if problemViews is supplied. Otherwise, null is acceptable.
    - -
    -
    Returns
    -
    • a string for human consumption. -
    -
    +
    + + + + + + +
    Returns
    Stringa string for human consumption. +
    -
    @@ -1193,193 +838,31 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/util/TreeIterables.ViewAndDistance.html b/docs/html/reference/android/support/test/espresso/util/TreeIterables.ViewAndDistance.html index f544d58389fd..24954e95926f 100644 --- a/docs/html/reference/android/support/test/espresso/util/TreeIterables.ViewAndDistance.html +++ b/docs/html/reference/android/support/test/espresso/util/TreeIterables.ViewAndDistance.html @@ -1,4 +1,3 @@ - @@ -93,484 +92,85 @@ - - - - - - -TreeIterables.ViewAndDistance | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +TreeIterables.ViewAndDistance - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - - - class -

    TreeIterables.ViewAndDistance

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    TreeIterables.ViewAndDistance

    +

    + + public + static + + + class + TreeIterables.ViewAndDistance + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.util.TreeIterables.ViewAndDistance
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.util.TreeIterables.ViewAndDistance +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Represents the distance a given view is from the root view. +

    Represents the distance a given view is from the root view.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -722,41 +295,54 @@ Summary: - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - int - - getDistanceFromRoot() - -
    - - - - - - View - - getView() - -
    + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + int + + + getDistanceFromRoot() + + +
    + + + + + + View + + + getView() + + +
    @@ -768,207 +354,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -977,16 +632,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1012,71 +657,63 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - int - - getDistanceFromRoot - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getDistanceFromRoot

    +
    +
    + +
    +
    +int getDistanceFromRoot ()
    + + + + +

    + + + + + + +
    Returns
    int
    +
    -
    -

    - - public - - - - - View - - getView - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getView

    +
    +
    + +
    +
    +View getView ()
    + + + + +

    + + + + + + +
    Returns
    View
    +
    @@ -1088,193 +725,31 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/util/TreeIterables.html b/docs/html/reference/android/support/test/espresso/util/TreeIterables.html index bc1e5824fae8..2d8433e9608e 100644 --- a/docs/html/reference/android/support/test/espresso/util/TreeIterables.html +++ b/docs/html/reference/android/support/test/espresso/util/TreeIterables.html @@ -1,4 +1,3 @@ - @@ -93,484 +92,85 @@ - - - - - - -TreeIterables | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +TreeIterables - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    TreeIterables

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    TreeIterables

    +

    + + public + + final + + class + TreeIterables + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.util.TreeIterables
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.util.TreeIterables +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Utility methods for iterating over tree structured items. +

    Utility methods for iterating over tree structured items. Since the view hierarchy is a tree - having a method of iterating over its contents is useful. @@ -684,52 +275,35 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - classTreeIterables.ViewAndDistance
    + + + + + + - - + + @@ -758,80 +332,93 @@ Summary: -

    Nested classes

    + + + + + class - Represents the distance a given view is from the root view.  - - - + TreeIterables.ViewAndDistance +

    Represents the distance a given view is from the root view.  + + +

    - - - - - -
    Public Methods
    + + - static - - Iterable<View> - - + + + + + - - - - - - + + + + + + + + + + - - - - - - - + + +

    + + + + + + + + + + + + + +

    Public methods

    - breadthFirstViewTraversal(View root) - -
    - Returns an iterable which iterates thru the provided view and its children in a + +
    + + + static + + + Iterable<View> + + + breadthFirstViewTraversal(View root) + + +

    Returns an iterable which iterates thru the provided view and its children in a breadth-first, row-level-order traversal. - - - - - -

    - - - - static - - Iterable<View> - - depthFirstViewTraversal(View root) - -
    - Returns an iterable which iterates thru the provided view and its children in a + + +

    + +
    + + + static + + + Iterable<View> + + + depthFirstViewTraversal(View root) + + +

    Returns an iterable which iterates thru the provided view and its children in a depth-first, in-order traversal. - - - - - -

    - - - - static - - Iterable<TreeIterables.ViewAndDistance> - - depthFirstViewTraversalWithDistance(View root) - -
    - Creates an iterable that traverses the tree formed by the given root. - - - -
    - -
    + + + static + + + Iterable<TreeIterables.ViewAndDistance> + + + depthFirstViewTraversalWithDistance(View root) + + +

    Creates an iterable that traverses the tree formed by the given root. + + +

    + +
    @@ -843,207 +430,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1052,16 +708,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1087,154 +733,138 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Iterable<View> - - breadthFirstViewTraversal - (View root) -

    -
    -
    - - - -
    -
    - - +
    +

    breadthFirstViewTraversal

    +
    +
    + + +
    +
    +Iterable<View> breadthFirstViewTraversal (View root)
    + + -

    Returns an iterable which iterates thru the provided view and its children in a + +

    Returns an iterable which iterates thru the provided view and its children in a breadth-first, row-level-order traversal. That is to say that for a view such as: Root / | \ A R U /| |\ B D G N - Will be iterated: Root, A, R, U, B, D, G, N

    -
    -
    Parameters
    - - - +
    root - the non-null, root view. + Will be iterated: Root, A, R, U, B, D, G, N

    + + + + + - -
    Parameters
    root + View: + the non-null, root view.
    - +
    + + + + + + +
    Returns
    Iterable<View>
    -
    -
    -

    - - public - static - - - - Iterable<View> - - depthFirstViewTraversal - (View root) -

    -
    -
    - - - -
    -
    - - +
    +

    depthFirstViewTraversal

    +
    +
    + + +
    +
    +Iterable<View> depthFirstViewTraversal (View root)
    + + -

    Returns an iterable which iterates thru the provided view and its children in a + +

    Returns an iterable which iterates thru the provided view and its children in a depth-first, in-order traversal. That is to say that for a view such as: Root / | \ A R U /| |\ B D G N - Will be iterated: Root, A, B, D, R, G, N, U.

    -
    -
    Parameters
    - - - +
    root - the non-null, root view. + Will be iterated: Root, A, B, D, R, G, N, U.

    + + + + + - -
    Parameters
    root + View: + the non-null, root view.
    - +
    + + + + + + +
    Returns
    Iterable<View>
    -
    -
    -

    - - public - static - - - - Iterable<TreeIterables.ViewAndDistance> - - depthFirstViewTraversalWithDistance - (View root) -

    -
    -
    - - - -
    -
    - +
    +

    depthFirstViewTraversalWithDistance

    +
    +
    + + - - -

    Creates an iterable that traverses the tree formed by the given root. - - Along with iteration order, the distance from the root element is also tracked.

    -
    -
    Parameters
    - - - - -
    root - the root view to track from.
    -
    -
    -
    Returns
    -
    • An iterable of ViewAndDistance containing the view tree in a depth first order with +
    +
    +Iterable<TreeIterables.ViewAndDistance> depthFirstViewTraversalWithDistance (View root)
    + + + + +

    Creates an iterable that traverses the tree formed by the given root. + + Along with iteration order, the distance from the root element is also tracked.

    + + + + + + +
    Parameters
    root + View: + the root view to track from.
    + + + + + + +
    Returns
    Iterable<TreeIterables.ViewAndDistance>An iterable of ViewAndDistance containing the view tree in a depth first order with the distance of a given node from the root. - - +
    -
    @@ -1246,193 +876,31 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/util/package-summary.html b/docs/html/reference/android/support/test/espresso/util/package-summary.html index 89faa8d1026d..fe1aa9b3910f 100644 --- a/docs/html/reference/android/support/test/espresso/util/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/util/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,757 +92,161 @@ - - - - - - -android.support.test.espresso.util | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.util - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.util

    -
    - -
    - -
    - - - +

    android.support.test.espresso.util

    + + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + + + +
    ActivityLifecyclesActivityLifecycles Helper methods to understand ActivityLifecycle of the app.  - - + +
    HumanReadablesHumanReadables Text converters for various Android objects.  - - + +
    TreeIterablesTreeIterables Utility methods for iterating over tree structured items.  - - + +
    TreeIterables.ViewAndDistanceTreeIterables.ViewAndDistance Represents the distance a given view is from the root view.  - - + +
    + + + + + + + -
    -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + +
    +
    + + + +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/action/AtomAction.html b/docs/html/reference/android/support/test/espresso/web/action/AtomAction.html index 807c098dca3b..bf084ec58a54 100644 --- a/docs/html/reference/android/support/test/espresso/web/action/AtomAction.html +++ b/docs/html/reference/android/support/test/espresso/web/action/AtomAction.html @@ -1,4 +1,3 @@ - @@ -93,489 +92,92 @@ - - - - - - -AtomAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +AtomAction - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    AtomAction

    - - - - - extends Object
    - - - - - - +

    AtomAction

    +

    + + public + + final + + class + AtomAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.action.AtomAction<E>
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.action.AtomAction<E> +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A ViewAction which causes the provided Atom to be evaluated within a webview. +

    A ViewAction which causes the provided Atom to be evaluated within a webview.

    It is not recommended to use AtomAction directly.

    Instead for @@ -690,34 +283,16 @@ Summary: -

    -
    See Also
    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -742,32 +317,28 @@ Summary: - - - - - - - - - +
    Public Constructors
    - - - - - - - - AtomAction(Atom<E> atom, WindowReference window, ElementReference element) - -
    - Creates an AtomAction. - - - -
    - -
    + + + + + + + + + + +

    Public constructors

    + + AtomAction(Atom<E> atom, WindowReference window, ElementReference element) + + +

    Creates an AtomAction. + + +

    + +
    @@ -778,147 +349,172 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - E - - get() - -
    - Blocks until the atom has completed execution. - - - -
    - -
    - - - - - - E - - get(long val, TimeUnit unit) - -
    - Blocks until the atom has completed execution with a configurable timeout. - - - -
    - -
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - Future<E> - - getFuture() - -
    - Return a Future, which will be set and transformed from futureEval. - - - -
    - -
    - - - - - - void - - perform(UiController controller, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + E + + + get(long val, TimeUnit unit) + + +

    Blocks until the atom has completed execution with a configurable timeout. + + +

    + +
    + + + + + + E + + + get() + + +

    Blocks until the atom has completed execution. + + +

    + +
    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + Future<E> + + + getFuture() + + +

    Return a Future, which will be set and transformed from futureEval. + + +

    + +
    + + + + + + void + + + perform(UiController controller, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -930,207 +526,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1138,94 +803,110 @@ From class - @@ -1234,16 +915,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1261,57 +932,52 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - +
    +

    AtomAction

    +
    +
    + + - - - - AtomAction - (Atom<E> atom, WindowReference window, ElementReference element) -

    -
    -
    - - - -
    -
    - - - - -

    Creates an AtomAction.

    -
    -
    Parameters
    - - - - - - - - - +
    atom - the atom to execute
    window - (optional/nullable) the window context to execute on.
    element - (optional/nullable) the element to execute on. + +
    +AtomAction (Atom<E> atom, 
    +                WindowReference window, 
    +                ElementReference element)
    + + + + +

    Creates an AtomAction.

    + + + + + + + + + + + + + - -
    Parameters
    atom + Atom: + the atom to execute
    window + WindowReference: + (optional/nullable) the window context to execute on.
    element + ElementReference: + (optional/nullable) the element to execute on.
    - +
    -
    @@ -1326,260 +992,242 @@ From interface -

    Public Methods

    - - - - - -
    -

    - - public - - - - - E - - get - () -

    -
    -
    - - +

    Public methods

    -
    -
    + +
    +

    get

    +
    +
    + + -

    Blocks until the atom has completed execution. -

    -
    -
    Throws
    - + +
    +E get (long val, 
    +                TimeUnit unit)
    + + + + +

    Blocks until the atom has completed execution with a configurable timeout. +

    +
    + + + + + + + + + +
    Parameters
    val + long +
    unit + TimeUnit +
    + + + + + + +
    Returns
    E
    + + + + + + - + + - + +
    Throws
    ExecutionException
    ExecutionException - InterruptedException
    InterruptedException - TimeoutException
    -
    + -
    - - -
    -

    - - public - - - - - E - - get - (long val, TimeUnit unit) -

    -
    -
    - - - -
    -
    - - + +
    +

    get

    +
    +
    + + -

    Blocks until the atom has completed execution with a configurable timeout. -

    -
    -
    Throws
    - - - - + +
    +E get ()
    + + + + +

    Blocks until the atom has completed execution. +

    +
    ExecutionException -
    + + + + + +
    Returns
    E
    + + - + + - + +
    Throws
    InterruptedException - ExecutionException
    TimeoutException - InterruptedException
    -
    + -
    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - Future<E> - - getFuture - () -

    -
    -
    - - - -
    -
    - - +
    +

    getFuture

    +
    +
    + + +
    +
    +Future<E> getFuture ()
    + + -

    Return a Future, which will be set and transformed from futureEval. + +

    Return a Future, which will be set and transformed from futureEval. Espresso's public API cannot have guava types in its method signatures, so return Future instead of ListenableFuture or SettableFuture. -

    +

    + + + + + + +
    Returns
    Future<E>
    -
    -
    -

    - - public +
    +

    perform

    +
    +
    + + - - - - void - - perform - (UiController controller, View view) -

    -
    -
    - - - -
    -
    - - - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    controller - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController controller, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    controller + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1591,193 +1239,29 @@ From interface - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/action/EnableJavascriptAction.html b/docs/html/reference/android/support/test/espresso/web/action/EnableJavascriptAction.html index 290094dac564..e0601a986773 100644 --- a/docs/html/reference/android/support/test/espresso/web/action/EnableJavascriptAction.html +++ b/docs/html/reference/android/support/test/espresso/web/action/EnableJavascriptAction.html @@ -1,4 +1,3 @@ - @@ -93,489 +92,92 @@ - - - - - - -EnableJavascriptAction | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +EnableJavascriptAction - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    EnableJavascriptAction

    - - - - - extends Object
    - - - - - - +

    EnableJavascriptAction

    +

    + + public + + + + class + EnableJavascriptAction + +
    + + + + + extends Object + + + + + + + + implements - - ViewAction - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + ViewAction + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.action.EnableJavascriptAction
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.action.EnableJavascriptAction +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Forcibly enables Javascript on a WebView. +

    Forcibly enables Javascript on a WebView.

    This has side-effects callers should be aware of: @@ -693,27 +286,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -738,25 +313,23 @@ Summary: - - +
    Public Constructors
    + - - - - + + + + + + +

    Public constructors

    - - - - - - - - EnableJavascriptAction() - -
    + + EnableJavascriptAction() + + +
    @@ -767,78 +340,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Matcher<View> - - getConstraints() - -
    - A mechanism for ViewActions to specify what type of views they can operate on. - - - -
    - -
    - - - - - - String - - getDescription() - -
    - Returns a description of the view action. - - - -
    - -
    - - - - - - void - - perform(UiController controller, View view) - -
    - Performs this action on the given view. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Matcher<View> + + + getConstraints() + + +

    A mechanism for ViewActions to specify what type of views they can operate on. + + +

    + +
    + + + + + + String + + + getDescription() + + +

    Returns a description of the view action. + + +

    + +
    + + + + + + void + + + perform(UiController controller, View view) + + +

    Performs this action on the given view. + + +

    + +
    @@ -850,207 +436,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1058,94 +713,110 @@ From class -

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.ViewAction + + From +interface + + + android.support.test.espresso.ViewAction + +
    -
    - - - - - - - - - @@ -1181,39 +842,28 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - EnableJavascriptAction - () -

    -
    -
    - - - -
    -
    - - +
    +

    EnableJavascriptAction

    +
    +
    + + +
    +
    +EnableJavascriptAction ()
    + + -

    + +

    -
    @@ -1228,129 +878,109 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Matcher<View> - - getConstraints - () -

    -
    -
    - - - -
    -
    - - +
    +

    getConstraints

    +
    +
    + + +
    +
    +Matcher<View> getConstraints ()
    + + -

    A mechanism for ViewActions to specify what type of views they can operate on. + +

    A mechanism for ViewActions to specify what type of views they can operate on. A ViewAction can demand that the view passed to perform meets certain constraints. For example it may want to ensure the view is already in the viewable physical screen of the device or is - of a certain type.

    -
    -
    -

    - - public - - - - - String - - getDescription - () -

    -
    -
    - - - -
    -
    - - +
    +

    getDescription

    +
    +
    + + +
    +
    +String getDescription ()
    + + -

    Returns a description of the view action. The description should not be overly long and should + +

    Returns a description of the view action. The description should not be overly long and should fit nicely in a sentence like: "performing %description% action on view with id ..." -

    +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - +
    +

    perform

    +
    +
    + + - - - void - - perform - (UiController controller, View view) -

    -
    -
    - - - -
    -
    - - - - -

    Performs this action on the given view.

    -
    -
    Parameters
    - - - - - - +
    controller - the controller to use to interact with the UI.
    view - the view to act upon. never null. + +
    +void perform (UiController controller, 
    +                View view)
    + + + + +

    Performs this action on the given view.

    + + + + + + + + + - -
    Parameters
    controller + UiController: + the controller to use to interact with the UI.
    view + View: + the view to act upon. never null.
    - +
    -
    @@ -1362,193 +992,29 @@ From interface - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/action/package-summary.html b/docs/html/reference/android/support/test/espresso/web/action/package-summary.html index 2d8d14997085..06f85323a60e 100644 --- a/docs/html/reference/android/support/test/espresso/web/action/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/web/action/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,732 +92,136 @@ - - - - - - -android.support.test.espresso.web.action | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.web.action - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.web.action

    -
    - -
    - -
    - - - +

    android.support.test.espresso.web.action

    + + +

    Classes

    -
    - - + + - + - + - - + + - + + + +
    AtomAction<E>AtomAction<E> A ViewAction which causes the provided Atom to be evaluated within a webview.  - - + +
    EnableJavascriptActionEnableJavascriptAction Forcibly enables Javascript on a WebView.  - - + +
    + -
    -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + + + + + + + + +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/assertion/TagSoupDocumentParser.html b/docs/html/reference/android/support/test/espresso/web/assertion/TagSoupDocumentParser.html index c095b81d0396..1c8f00d1b47a 100644 --- a/docs/html/reference/android/support/test/espresso/web/assertion/TagSoupDocumentParser.html +++ b/docs/html/reference/android/support/test/espresso/web/assertion/TagSoupDocumentParser.html @@ -1,4 +1,3 @@ - @@ -93,488 +92,85 @@ - - - - - - -TagSoupDocumentParser | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +TagSoupDocumentParser - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    TagSoupDocumentParser

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    TagSoupDocumentParser

    +

    + + public + + final + + class + TagSoupDocumentParser + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.assertion.TagSoupDocumentParser
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.assertion.TagSoupDocumentParser +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Uses TagSoup to parse html into Documents. +

    Uses TagSoup to parse html into Documents.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -726,48 +295,59 @@ Summary: - - - - - - - - - + + -
    Public Methods
    + + - static - - TagSoupDocumentParser - - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - newInstance() - -
    - - - - - - Document - - parse(String html) - -
    - Parses the given html into an Document. - - - -
    - -
    + + + static + + + TagSoupDocumentParser + + + newInstance() + + +
    + + + + + + Document + + + parse(String html) + + +

    Parses the given html into an Document. + + +

    + +
    @@ -779,207 +359,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -988,16 +637,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1023,98 +662,97 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - TagSoupDocumentParser - - newInstance - () -

    -
    -
    - - - -
    -
    - +
    +

    newInstance

    +
    +
    + + - - -

    -
    -
    Throws
    - + +
    +TagSoupDocumentParser newInstance ()
    + + + + +

    +
    + + + + + +
    Returns
    TagSoupDocumentParser
    + + - + + - + +
    Throws
    SAXNotRecognizedException - SAXNotRecognizedException
    SAXNotSupportedException - SAXNotSupportedException
    -
    + -
    -
    -

    - - public - - - - - Document - - parse - (String html) -

    -
    -
    - - - -
    -
    - - +
    +

    parse

    +
    +
    + + +
    +
    +Document parse (String html)
    + + -

    Parses the given html into an Document. -

    -
    -
    Throws
    - + +

    Parses the given html into an Document. +

    +
    + + + + + +
    Parameters
    html + String +
    + + + + + + +
    Returns
    Document
    + + - + + - + +
    Throws
    SAXException - SAXException
    IOException - IOException
    -
    + -
    @@ -1126,193 +764,35 @@ From class - -
    - -
    - -
    - - -
    - -
    - + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/assertion/WebAssertion.html b/docs/html/reference/android/support/test/espresso/web/assertion/WebAssertion.html index 894e6039f351..2ebe91c36df5 100644 --- a/docs/html/reference/android/support/test/espresso/web/assertion/WebAssertion.html +++ b/docs/html/reference/android/support/test/espresso/web/assertion/WebAssertion.html @@ -1,4 +1,3 @@ - @@ -93,488 +92,85 @@ - - - - - - -WebAssertion | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +WebAssertion - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - abstract - class -

    WebAssertion

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    WebAssertion

    +

    + + public + + + abstract + class + WebAssertion + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.assertion.WebAssertion<E>
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.assertion.WebAssertion<E> +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Similar to a ViewAssertion - a WebAssertion allows users to check the results of an atom +

    Similar to a ViewAssertion - a WebAssertion allows users to check the results of an atom evaluated against the provided webview.

    -
    - - - - - - - - - - - - - - - - -
    -

    Summary

    +

    Summary

    @@ -728,25 +297,23 @@ Summary: - +
    Public Constructors
    + - - - - - + + + + + + +

    Public constructors

    - - - - - - - - WebAssertion(Atom<E> atom) - -
    + + WebAssertion(Atom<E> atom) + + +
    @@ -757,41 +324,54 @@ Summary: - - - - - - - - - - - - - + + - -
    Public Methods
    - - - final - - - Atom<E> - - getAtom() - -
    + + - final - - - ViewAssertion - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - toViewAssertion(E result) - -
    + + + + final + + Atom<E> + + + getAtom() + + +
    + + + + final + + ViewAssertion + + + toViewAssertion(E result) + + +
    @@ -800,32 +380,37 @@ Summary: - - - - - - - + +
    Protected Methods
    - abstract - + + - void - - - + + + + + + + + +

    Protected methods

    - checkResult(WebView view, E result) - -
    - Extension point to validate a view and atom result on the main thread. - - - -
    - -
    + abstract + + + + + void + + + checkResult(WebView view, E result) + + +

    Extension point to validate a view and atom result on the main thread. + + +

    + +
    @@ -835,207 +420,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1044,16 +698,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1071,39 +715,37 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - WebAssertion - (Atom<E> atom) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    WebAssertion

    +
    +
    + +
    +
    +WebAssertion (Atom<E> atom)
    + + + + +

    + + + + + + +
    Parameters
    atom + Atom +
    +
    @@ -1118,71 +760,72 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - final - - - Atom<E> - - getAtom - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getAtom

    +
    +
    + +
    +
    +Atom<E> getAtom ()
    + + + + +

    + + + + + + +
    Returns
    Atom<E>
    +
    -
    -

    - - public - - final - - - ViewAssertion - - toViewAssertion - (E result) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toViewAssertion

    +
    +
    + +
    +
    +ViewAssertion toViewAssertion (E result)
    + + + + +

    + + + + + + +
    Parameters
    result + E +
    + + + + + + +
    Returns
    ViewAssertion
    +
    @@ -1191,53 +834,45 @@ From class -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - abstract - - void - - checkResult - (WebView view, E result) -

    -
    -
    - - - -
    -
    - - +
    +

    checkResult

    +
    +
    + + - -

    Extension point to validate a view and atom result on the main thread.

    -
    -
    Parameters
    - - - - - - +
    view - the WebView that the Atom was evaluated on.
    result - the result of atom evaluation. + +
    +void checkResult (WebView view, 
    +                E result)
    + + + + +

    Extension point to validate a view and atom result on the main thread.

    + + + + + + + + + - -
    Parameters
    view + WebView: + the WebView that the Atom was evaluated on.
    result + E: + the result of atom evaluation.
    - +
    -
    @@ -1245,193 +880,35 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/assertion/WebViewAssertions.ResultDescriber.html b/docs/html/reference/android/support/test/espresso/web/assertion/WebViewAssertions.ResultDescriber.html index c562ef40df76..68ffdac2d117 100644 --- a/docs/html/reference/android/support/test/espresso/web/assertion/WebViewAssertions.ResultDescriber.html +++ b/docs/html/reference/android/support/test/espresso/web/assertion/WebViewAssertions.ResultDescriber.html @@ -1,17 +1,3 @@ - - - - - - - - - - - - - - @@ -92,569 +78,149 @@ - - - - - - - -WebViewAssertions.ResultDescriber | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    - - - - - - - -
    -
    - -
    -
    -
    + + + + + + + - + + + -
    - public - static + + - interface -

    WebViewAssertions.ResultDescriber

    + + + + +WebViewAssertions.ResultDescriber + + + -
    -
    - - - - - - - - - -
    android.support.test.espresso.web.assertion.WebViewAssertions.ResultDescriber<E>
    - - - - - - +
    +
    + + + -
    +
    -

    Class Overview

    -

    Converts a result to a String.

    + +
    +
    -
    + +

    WebViewAssertions.ResultDescriber

    +

    + + public + static + + + interface + WebViewAssertions.ResultDescriber + +
    + + + + + +

    + + + + + +
    android.support.test.espresso.web.assertion.WebViewAssertions.ResultDescriber<E> +
    + + +

    +

    Converts a result to a String.

    -
    -

    Summary

    +

    Summary

    @@ -683,25 +249,32 @@ type="text/css"> - - - - - - - - -
    Public Methods
    - abstract - - + + - String - - + + + + + + + + +

    Public methods

    - apply(E input) - -
    + abstract + + + + + String + + + apply(E input) + + +
    @@ -712,16 +285,6 @@ type="text/css"> - - - - - - - - - - @@ -747,39 +310,44 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - String - - apply - (E input) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    apply

    +
    +
    + +
    +
    +String apply (E input)
    + + + + +

    + + + + + + +
    Parameters
    input + E +
    + + + + + + +
    Returns
    String
    +
    @@ -791,193 +359,35 @@ type="text/css"> - -
    - -
    - -
    - - -
    - - - + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/assertion/WebViewAssertions.html b/docs/html/reference/android/support/test/espresso/web/assertion/WebViewAssertions.html index af52ddc73e69..8aa075ac87c3 100644 --- a/docs/html/reference/android/support/test/espresso/web/assertion/WebViewAssertions.html +++ b/docs/html/reference/android/support/test/espresso/web/assertion/WebViewAssertions.html @@ -1,4 +1,3 @@ - @@ -93,488 +92,85 @@ - - - - - - -WebViewAssertions | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +WebViewAssertions - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    WebViewAssertions

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    WebViewAssertions

    +

    + + public + + final + + class + WebViewAssertions + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.assertion.WebViewAssertions
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.assertion.WebViewAssertions +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of WebAssertions that assert on WebViews. +

    A collection of WebAssertions that assert on WebViews.

    -
    - - - - - - - - - - - - - - - - -
    -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - interfaceWebViewAssertions.ResultDescriber<E>
    + + + + + + - - + + @@ -754,78 +324,91 @@ Summary: -

    Nested classes

    + + + + + interface - Converts a result to a String.  - - - + WebViewAssertions.ResultDescriber<E> +

    Converts a result to a String.  + + +

    - - - - - - - - - + -
    Public Methods
    - - - - static + + - WebAssertion<Document> - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - webContent(Matcher<Document> domMatcher) -
    - A WebAssertion which asserts that the document is matched by th provided matcher. - - - -
    - -
    - - - - static - <E> - WebAssertion<E> - - webMatches(Atom<E> atom, Matcher<E> resultMatcher) - -
    - A WebAssertion which asserts that the given Atom's result is accepted by the provided matcher. - - - -
    - -
    - - - - static - <E> - WebAssertion<E> - - webMatches(Atom<E> atom, Matcher<E> resultMatcher, ResultDescriber<? super E> resultDescriber) - -
    - A WebAssertion which asserts that the given Atom's result is accepted by the provided matcher. - - - -
    - -
    + + + static + + + WebAssertion<Document> + + + webContent(Matcher<Document> domMatcher) + + +

    A WebAssertion which asserts that the document is matched by th provided matcher. + + +

    + +
    + + + static + + <E> + WebAssertion<E> + + + webMatches(Atom<E> atom, Matcher<E> resultMatcher, ResultDescriber<? super E> resultDescriber) + + +

    A WebAssertion which asserts that the given Atom's result is accepted by the provided matcher. + + +

    + +
    + + + static + + <E> + WebAssertion<E> + + + webMatches(Atom<E> atom, Matcher<E> resultMatcher) + + +

    A WebAssertion which asserts that the given Atom's result is accepted by the provided matcher. + + +

    + +
    @@ -837,207 +420,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1046,16 +698,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1081,136 +723,142 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - WebAssertion<Document> - - webContent - (Matcher<Document> domMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    A WebAssertion which asserts that the document is matched by th provided matcher. -

    +
    +

    webContent

    +
    +
    + +
    -
    - - - - -
    -

    - - public - static - +
    +WebAssertion<Document> webContent (Matcher<Document> domMatcher)
    + + + +

    A WebAssertion which asserts that the document is matched by th provided matcher. +

    + + + + + + +
    Parameters
    domMatcher + Matcher +
    + + + + + + +
    Returns
    WebAssertion<Document>
    - WebAssertion<E> -
    - webMatches - (Atom<E> atom, Matcher<E> resultMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    A WebAssertion which asserts that the given Atom's result is accepted by the provided matcher.

    -
    -
    Parameters
    - - - - - - - -
    atom - an atom to evaluate on the webview
    resultMatcher - a matcher to apply to the result of the atom. -
    -
    - -
    -
    -

    - - public - static - - - - WebAssertion<E> - - webMatches - (Atom<E> atom, Matcher<E> resultMatcher, ResultDescriber<? super E> resultDescriber) -

    -
    -
    - +
    +

    webMatches

    +
    +
    + + +
    +
    +WebAssertion<E> webMatches (Atom<E> atom, 
    +                Matcher<E> resultMatcher, 
    +                ResultDescriber<? super E> resultDescriber)
    + + + + +

    A WebAssertion which asserts that the given Atom's result is accepted by the provided matcher.

    + + + + + + + + + + + + + + +
    Parameters
    atom + Atom: + an atom to evaluate on the webview
    resultMatcher + Matcher: + a matcher to apply to the result of the atom.
    resultDescriber + ResultDescriber: + a describer that converts the result to a string. +
    + + + + + + +
    Returns
    WebAssertion<E>
    -
    -
    +
    + +
    +

    webMatches

    +
    +
    + + -

    A WebAssertion which asserts that the given Atom's result is accepted by the provided matcher.

    -
    -
    Parameters
    - - - - - - - - - +
    atom - an atom to evaluate on the webview
    resultMatcher - a matcher to apply to the result of the atom.
    resultDescriber - a describer that converts the result to a string. + +
    +WebAssertion<E> webMatches (Atom<E> atom, 
    +                Matcher<E> resultMatcher)
    + + + + +

    A WebAssertion which asserts that the given Atom's result is accepted by the provided matcher.

    + + + + + + + + + - -
    Parameters
    atom + Atom: + an atom to evaluate on the webview
    resultMatcher + Matcher: + a matcher to apply to the result of the atom.
    - +
    + + + + + + +
    Returns
    WebAssertion<E>
    -
    @@ -1222,193 +870,35 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/assertion/package-summary.html b/docs/html/reference/android/support/test/espresso/web/assertion/package-summary.html index fed18ca13cd1..a4014f167822 100644 --- a/docs/html/reference/android/support/test/espresso/web/assertion/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/web/assertion/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,771 +92,173 @@ - - - - - - -android.support.test.espresso.web.assertion | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.web.assertion - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.web.assertion

    -
    - -
    - -
    - - +

    android.support.test.espresso.web.assertion

    + +

    Interfaces

    -
    - - + + - + - + - - + +
    WebViewAssertions.ResultDescriber<E>WebViewAssertions.ResultDescriber<E> Converts a result to a String.  - - + +
    -
    - - + +

    Classes

    -
    - - + + - + - + - - + + - + + + + + + + + + +
    TagSoupDocumentParserTagSoupDocumentParser Uses TagSoup to parse html into Documents.  - - + +
    WebAssertion<E>WebAssertion<E> Similar to a ViewAssertion - a WebAssertion allows users to check the results of an atom evaluated against the provided webview.  + + - +
    WebViewAssertions + A collection of WebAssertions that assert on WebViews.  + +
    + -
    WebViewAssertions - A collection of WebAssertions that assert on WebViews.  + -
    + -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/bridge/Conduit.html b/docs/html/reference/android/support/test/espresso/web/bridge/Conduit.html index 05ef71c28a16..73ed1e976a05 100644 --- a/docs/html/reference/android/support/test/espresso/web/bridge/Conduit.html +++ b/docs/html/reference/android/support/test/espresso/web/bridge/Conduit.html @@ -1,4 +1,3 @@ - @@ -93,482 +92,85 @@ - - - - - - -Conduit | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Conduit - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    Conduit

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    Conduit

    +

    + + public + + final + + class + Conduit + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.bridge.Conduit
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.bridge.Conduit +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A mechanism to get results out of a Javascript context and into a Java context. +

    A mechanism to get results out of a Javascript context and into a Java context.

    Users can get instances of this class via JavaScriptBridge.makeConduit(). Each conduit can be used once (and only once) to transmit results. Before evaluating javascript via a loadUrl call @@ -678,27 +271,9 @@ Summary: -

    - - - - - - - - - - - - - - - - -
    -

    Summary

    +

    Summary

    @@ -727,80 +302,93 @@ Summary: - - - - - - - - - - - - - - - - - - - + - - - +
    +

    launchActivity

    +
    +
    + + +
    +
    +T launchActivity (Intent startIntent)
    + + - -
    Public Methods
    - - - - - - ListenableFuture<String> - - getResult() - -
    - The future that will be resolved when the Javascript evaluation completes. - - - -
    - -
    - - - - - - String - - wrapScriptInConduit(String script) - -
    - Takes Javascript code and wraps it within a statement that will pipe the results of + + + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + + + + + - + + +

    + + + +

    Public methods

    + + + + + + ListenableFuture<String> + + + getResult() + + +

    The future that will be resolved when the Javascript evaluation completes. + + +

    + +
    + + + + + + String + + + wrapScriptInConduit(String script) + + +

    Takes Javascript code and wraps it within a statement that will pipe the results of evaluation to the ListenableFuture this conduit holds. - - - - - -

    - - - - - - StringBuilder - - wrapScriptInConduit(StringBuilder script) - -
    - Wraps a script within additional javascript code that will allow the function to + + +

    + +
    + + + + + + StringBuilder + + + wrapScriptInConduit(StringBuilder script) + + +

    Wraps a script within additional javascript code that will allow the function to return its results back thru this conduit. - - - - - -

    @@ -812,207 +400,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1021,16 +678,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1056,121 +703,114 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - ListenableFuture<String> - - getResult - () -

    -
    -
    - - - -
    -
    - - +
    +

    getResult

    +
    +
    + + +
    +
    +ListenableFuture<String> getResult ()
    + + -

    The future that will be resolved when the Javascript evaluation completes. -

    + +

    The future that will be resolved when the Javascript evaluation completes. +

    + + + + + + +
    Returns
    ListenableFuture<String>
    -
    -
    -

    - - public - - - - - String - - wrapScriptInConduit - (String script) -

    -
    -
    - - - -
    -
    - - +
    +

    wrapScriptInConduit

    +
    +
    + + +
    +
    +String wrapScriptInConduit (String script)
    + + -

    Takes Javascript code and wraps it within a statement that will pipe the results of + +

    Takes Javascript code and wraps it within a statement that will pipe the results of evaluation to the ListenableFuture this conduit holds. -

    +

    + + + + + + +
    Parameters
    script + String +
    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - - - - StringBuilder - - wrapScriptInConduit - (StringBuilder script) -

    -
    -
    - - - -
    -
    - - - - -

    Wraps a script within additional javascript code that will allow the function to - return its results back thru this conduit.

    -
    -
    Parameters
    - - - - -
    script - the buffer holding the script, it will be modified in place.
    -
    -
    -
    Returns
    -
    • the StringBuilder passed in. -
    -
    +
    +

    wrapScriptInConduit

    +
    +
    + +
    +
    +StringBuilder wrapScriptInConduit (StringBuilder script)
    + + + + +

    Wraps a script within additional javascript code that will allow the function to + return its results back thru this conduit.

    + + + + + + +
    Parameters
    script + StringBuilder: + the buffer holding the script, it will be modified in place.
    + + + + + + +
    Returns
    StringBuilderthe StringBuilder passed in. +
    +
    @@ -1182,193 +822,29 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/bridge/JavaScriptBridge.html b/docs/html/reference/android/support/test/espresso/web/bridge/JavaScriptBridge.html index 76fbfd61158c..0b466b52f2c4 100644 --- a/docs/html/reference/android/support/test/espresso/web/bridge/JavaScriptBridge.html +++ b/docs/html/reference/android/support/test/espresso/web/bridge/JavaScriptBridge.html @@ -1,4 +1,3 @@ - @@ -93,482 +92,85 @@ - - - - - - -JavaScriptBridge | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +JavaScriptBridge - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    JavaScriptBridge

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    JavaScriptBridge

    +

    + + public + + final + + class + JavaScriptBridge + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.bridge.JavaScriptBridge
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.bridge.JavaScriptBridge +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Provides a gateway for Java and Javascript code to communicate to eachother. +

    Provides a gateway for Java and Javascript code to communicate to eachother.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -719,25 +294,23 @@ Summary: - - - - - - - - - + + +

    Public constructors

    -
    Public Constructors
    + + - - - - - - + + + + + + +

    Public constructors

    - JavaScriptBridge() - -
    + + JavaScriptBridge() + + +
    @@ -748,56 +321,65 @@ Summary: - - - - - - -
    Public Methods
    - + + - static - void - - - - - - - - + + + + + + + + + + + + + + + - + + +

    + + + +

    Public methods

    - installBridge() - -
    - Sets up Java / Javascript bridging on every WebView in the app. - - - -
    - -
    - - - - static - - Conduit - - makeConduit() - -
    - Creates a Conduit object which allows Java to wrap Javascript code within a + +
    + + + static + + + void + + + installBridge() + + +

    Sets up Java / Javascript bridging on every WebView in the app. + + +

    + +
    + + + static + + + Conduit + + + makeConduit() + + +

    Creates a Conduit object which allows Java to wrap Javascript code within a handler that will foward evaluation results back to the Java process. - - - - - -

    @@ -809,207 +391,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1018,16 +669,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1045,39 +686,28 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - JavaScriptBridge - () -

    -
    -
    - - - -
    -
    - - +
    +

    JavaScriptBridge

    +
    +
    + + +
    +
    +JavaScriptBridge ()
    + + -

    + +

    -
    @@ -1092,82 +722,67 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - void - - installBridge - () -

    -
    -
    - - - -
    -
    - - +
    +

    installBridge

    +
    +
    + + +
    +
    +void installBridge ()
    + + -

    Sets up Java / Javascript bridging on every WebView in the app. + +

    Sets up Java / Javascript bridging on every WebView in the app.

    This method must be called very early (eg: before webviews are loaded in your app). GoogleInstrumentation invokes this method if this library is present on your classpath.

    This method must be called from the main thread. It'll return immedately if the bridge is already installed. -

    +

    -
    -
    -

    - - public - static - - - - Conduit - - makeConduit - () -

    -
    -
    - - - -
    -
    - - +
    +

    makeConduit

    +
    +
    + + +
    +
    +Conduit makeConduit ()
    + + -

    Creates a Conduit object which allows Java to wrap Javascript code within a + +

    Creates a Conduit object which allows Java to wrap Javascript code within a handler that will foward evaluation results back to the Java process.

    Conduits can be used for only 1 evaluation. Creating new ones is relatively cheap. -

    +

    + + + + + + +
    Returns
    Conduit
    -
    @@ -1179,193 +794,29 @@ From class - -
    - -
    - -
    - - - -
    - -
    - + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/bridge/package-summary.html b/docs/html/reference/android/support/test/espresso/web/bridge/package-summary.html index ebfb30597ea0..1384923576c1 100644 --- a/docs/html/reference/android/support/test/espresso/web/bridge/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/web/bridge/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,732 +92,136 @@ - - - - - - -android.support.test.espresso.web.bridge | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.web.bridge - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.web.bridge

    -
    - -
    - -
    - - - +

    android.support.test.espresso.web.bridge

    + + +

    Classes

    -
    - - + + - + - + - - + + - + + + +
    ConduitConduit A mechanism to get results out of a Javascript context and into a Java context.  - - + +
    JavaScriptBridgeJavaScriptBridge Provides a gateway for Java and Javascript code to communicate to eachother.  - - + +
    + -
    - - - - - - - - - - - - - - - -
    - -
    - - - - - - - + + + + + + + + + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/matcher/AmbiguousElementMatcherException.html b/docs/html/reference/android/support/test/espresso/web/matcher/AmbiguousElementMatcherException.html index ed0b7b3c6b7d..0c44d0eba8c1 100644 --- a/docs/html/reference/android/support/test/espresso/web/matcher/AmbiguousElementMatcherException.html +++ b/docs/html/reference/android/support/test/espresso/web/matcher/AmbiguousElementMatcherException.html @@ -1,4 +1,3 @@ - @@ -93,513 +92,112 @@ - - - - - - -AmbiguousElementMatcherException | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +AmbiguousElementMatcherException - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    AmbiguousElementMatcherException

    - - - - - - - - - - - - - - - - - extends RuntimeException
    - - - - - - +

    AmbiguousElementMatcherException

    +

    + + public + + final + + class + AmbiguousElementMatcherException + +
    + + + + + + + + + + + + + + + + + + + + + + + extends RuntimeException + + + + + + + + implements - - EspressoException - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + EspressoException + + + + + +

    java.lang.Object
       ↳java.lang.Throwable
        ↳java.lang.Exception
         ↳java.lang.RuntimeException
          ↳android.support.test.espresso.web.matcher.AmbiguousElementMatcherException
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Throwable +
        ↳java.lang.Exception +
         ↳java.lang.RuntimeException +
          ↳android.support.test.espresso.web.matcher.AmbiguousElementMatcherException +
    + + +

    - - - -
    - - -

    Class Overview

    -

    An exception which indicates that for a given XPath there were multiple Elements found when only +

    An exception which indicates that for a given XPath there were multiple Elements found when only 1 element was expected.

    @@ -756,27 +354,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -801,25 +381,23 @@ Summary: - - - - - - - +
    Public Constructors
    - + + - - - - - + + + + + + +

    Public constructors

    - AmbiguousElementMatcherException(String xpath) - -
    + + AmbiguousElementMatcherException(String xpath) + + +
    @@ -835,9 +413,8 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + @@ -845,233 +422,315 @@ Summary: - @@ -1079,201 +738,271 @@ From class - @@ -1286,16 +1015,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Throwable + + From +class + + + java.lang.Throwable + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1313,39 +1032,37 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - AmbiguousElementMatcherException - (String xpath) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    AmbiguousElementMatcherException

    +
    +
    + +
    +
    +AmbiguousElementMatcherException (String xpath)
    + + + + +

    + + + + + + +
    Parameters
    xpath + String +
    +
    @@ -1367,193 +1084,33 @@ From class - -
    - -
    - -
    - - - -
    - - + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/matcher/DomMatchers.html b/docs/html/reference/android/support/test/espresso/web/matcher/DomMatchers.html index ae850d99b925..6a47f0117e13 100644 --- a/docs/html/reference/android/support/test/espresso/web/matcher/DomMatchers.html +++ b/docs/html/reference/android/support/test/espresso/web/matcher/DomMatchers.html @@ -1,4 +1,3 @@ - @@ -93,486 +92,85 @@ - - - - - - -DomMatchers | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +DomMatchers - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    DomMatchers

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    DomMatchers

    +

    + + public + + final + + class + DomMatchers + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.matcher.DomMatchers
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.matcher.DomMatchers +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A collection of hamcrest matchers for objects in the org.w3c.dom package (such as - Document and Element). +

    A collection of hamcrest matchers for objects in the org.w3c.dom package (such as + Document and Element).

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -725,198 +296,231 @@ Summary: - - - - - - - -
    Public Methods
    - - - - static - - Matcher<Document> - - containingTextInBody(String text) - -
    - Returns a matcher that matches Documents that have a body containing the given test. - - + + - - - - - - - + + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + +

    + + + +

    Public methods

    - - - - static - - Matcher<Document> - - elementById(String id, Matcher<Element> elementMatcher) - -
    - Matches Documents that have an Element with the given id that matches the given + +
    + + + static + + + Matcher<Document> + + + containingTextInBody(String text) + + +

    Returns a matcher that matches Documents that have a body containing the given test. + + +

    + +
    + + + static + + + Matcher<Document> + + + elementById(String id, Matcher<Element> elementMatcher) + + +

    Matches Documents that have an Element with the given id that matches the given element matcher. - - - - - -

    - - - - static - - Matcher<Document> - - elementByXPath(String xpath, Matcher<Element> elementMatcher) - -
    - Matches a XPath and validates it against the first Element that it finds in the - NodeList. - - - -
    - -
    - - - - static - - Matcher<Document> - - hasElementWithId(String id) - -
    - Returns a matcher that matches Documents that have at least one element with the given + + +

    + +
    + + + static + + + Matcher<Document> + + + elementByXPath(String xpath, Matcher<Element> elementMatcher) + + +

    Matches a XPath and validates it against the first Element that it finds in the + NodeList. + + +

    + +
    + + + static + + + Matcher<Document> + + + hasElementWithId(String id) + + +

    Returns a matcher that matches Documents that have at least one element with the given id. - - - - - -

    - - - - static - - Matcher<Document> - - hasElementWithXpath(String xpath) - -
    - Returns a matcher that matches Documents that have at least one element with the given + + +

    + +
    + + + static + + + Matcher<Document> + + + hasElementWithXpath(String xpath) + + +

    Returns a matcher that matches Documents that have at least one element with the given xpath. - - - - - -

    - - - - static - - Matcher<Document> - - withBody(Matcher<Element> bodyMatcher) - -
    - Returns a matcher that matches Documents with body that matches the given matcher. - - - -
    - -
    - - - - static - - Matcher<Element> - - withTextContent(String textContent) - -
    - Returns a matcher that matches Elements with the given textContent. - - - -
    - -
    - - - - static - - Matcher<Element> - - withTextContent(Matcher<String> textContentMatcher) - -
    - Returns a matcher that matches Elements that have textContent matching the given + + +

    + +
    + + + static + + + Matcher<Document> + + + withBody(Matcher<Element> bodyMatcher) + + +

    Returns a matcher that matches Documents with body that matches the given matcher. + + +

    + +
    + + + static + + + Matcher<Element> + + + withTextContent(String textContent) + + +

    Returns a matcher that matches Elements with the given textContent. + + +

    + +
    + + + static + + + Matcher<Element> + + + withTextContent(Matcher<String> textContentMatcher) + + +

    Returns a matcher that matches Elements that have textContent matching the given matcher. - - - - - -

    @@ -928,207 +532,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1137,16 +810,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1172,277 +835,331 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Matcher<Document> - - containingTextInBody - (String text) -

    -
    -
    - - - -
    -
    - - +
    +

    containingTextInBody

    +
    +
    + + +
    +
    +Matcher<Document> containingTextInBody (String text)
    + + -

    Returns a matcher that matches Documents that have a body containing the given test. -

    + +

    Returns a matcher that matches Documents that have a body containing the given test. +

    + + + + + + +
    Parameters
    text + String +
    + + + + + + +
    Returns
    Matcher<Document>
    -
    -
    -

    - - public - static - - - - Matcher<Document> - - elementById - (String id, Matcher<Element> elementMatcher) -

    -
    -
    - - - -
    -
    - +
    +

    elementById

    +
    +
    + + - - -

    Matches Documents that have an Element with the given id that matches the given +

    +
    +Matcher<Document> elementById (String id, 
    +                Matcher<Element> elementMatcher)
    + + + + +

    Matches Documents that have an Element with the given id that matches the given element matcher. -

    +

    + + + + + + + + + + +
    Parameters
    id + String +
    elementMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Document>
    -
    -
    -

    - - public - static - - - - Matcher<Document> - - elementByXPath - (String xpath, Matcher<Element> elementMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    Matches a XPath and validates it against the first Element that it finds in the - NodeList. -

    +
    +

    elementByXPath

    +
    +
    + +
    +
    +Matcher<Document> elementByXPath (String xpath, 
    +                Matcher<Element> elementMatcher)
    + + + + +

    Matches a XPath and validates it against the first Element that it finds in the + NodeList. +

    + + + + + + + + + + +
    Parameters
    xpath + String +
    elementMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Document>
    +
    -
    -

    - - public - static - - - - Matcher<Document> - - hasElementWithId - (String id) -

    -
    -
    - - - -
    -
    - - +
    +

    hasElementWithId

    +
    +
    + + +
    +
    +Matcher<Document> hasElementWithId (String id)
    + + -

    Returns a matcher that matches Documents that have at least one element with the given + +

    Returns a matcher that matches Documents that have at least one element with the given id. -

    +

    + + + + + + +
    Parameters
    id + String +
    + + + + + + +
    Returns
    Matcher<Document>
    -
    -
    -

    - - public - static - - - - Matcher<Document> - - hasElementWithXpath - (String xpath) -

    -
    -
    - - - -
    -
    - - +
    +

    hasElementWithXpath

    +
    +
    + + +
    +
    +Matcher<Document> hasElementWithXpath (String xpath)
    + + -

    Returns a matcher that matches Documents that have at least one element with the given + +

    Returns a matcher that matches Documents that have at least one element with the given xpath. -

    +

    + + + + + + +
    Parameters
    xpath + String +
    + + + + + + +
    Returns
    Matcher<Document>
    -
    -
    -

    - - public - static - - - - Matcher<Document> - - withBody - (Matcher<Element> bodyMatcher) -

    -
    -
    - - - -
    -
    - - +
    +

    withBody

    +
    +
    + + +
    +
    +Matcher<Document> withBody (Matcher<Element> bodyMatcher)
    + + -

    Returns a matcher that matches Documents with body that matches the given matcher. -

    + +

    Returns a matcher that matches Documents with body that matches the given matcher. +

    + + + + + + +
    Parameters
    bodyMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Document>
    -
    -
    -

    - - public - static - - - - Matcher<Element> - - withTextContent - (String textContent) -

    -
    -
    - - - -
    -
    - - +
    +

    withTextContent

    +
    +
    + + +
    +
    +Matcher<Element> withTextContent (String textContent)
    + + -

    Returns a matcher that matches Elements with the given textContent. Equivalent of + +

    Returns a matcher that matches Elements with the given textContent. Equivalent of withTextContent(is(textContent)). -

    +

    + + + + + + +
    Parameters
    textContent + String +
    + + + + + + +
    Returns
    Matcher<Element>
    -
    -
    -

    - - public - static - - - - Matcher<Element> - - withTextContent - (Matcher<String> textContentMatcher) -

    -
    -
    - - - -
    -
    - - +
    +

    withTextContent

    +
    +
    + + +
    +
    +Matcher<Element> withTextContent (Matcher<String> textContentMatcher)
    + + -

    Returns a matcher that matches Elements that have textContent matching the given + +

    Returns a matcher that matches Elements that have textContent matching the given matcher. -

    +

    + + + + + + +
    Parameters
    textContentMatcher + Matcher +
    + + + + + + +
    Returns
    Matcher<Element>
    -
    @@ -1454,193 +1171,33 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/matcher/package-summary.html b/docs/html/reference/android/support/test/espresso/web/matcher/package-summary.html index 594cf7e80410..3e2640368838 100644 --- a/docs/html/reference/android/support/test/espresso/web/matcher/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/web/matcher/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,748 +92,150 @@ - - - - - - -android.support.test.espresso.web.matcher | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.web.matcher - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.web.matcher

    -
    - -
    - -
    - - - +

    android.support.test.espresso.web.matcher

    + + +

    Classes

    -
    - - + + - + - + - - + +
    DomMatchersDomMatchers A collection of hamcrest matchers for objects in the org.w3c.dom package (such as - Document and Element).  - - + Document and Element).  + +
    -
    - - - + + +

    Exceptions

    -
    - - + + - + - + + + +
    AmbiguousElementMatcherExceptionAmbiguousElementMatcherException An exception which indicates that for a given XPath there were multiple Elements found when only 1 element was expected.  - - + +
    + -
    -
    - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + + +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/model/Atom.html b/docs/html/reference/android/support/test/espresso/web/model/Atom.html index 1eb87e06725d..1be51adf2cf2 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/Atom.html +++ b/docs/html/reference/android/support/test/espresso/web/model/Atom.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,76 @@ - - - - - - -Atom | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Atom - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -597,123 +181,110 @@ Summary: Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public - - - - interface -

    Atom

    - +

    Atom

    +

    + + public + + + + interface + Atom + +
    + + + + + +

    - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.web.model.Atom<R>
    android.support.test.espresso.web.model.Atom<R> +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    An Atom is a thin wrapper around javascript. +

    An Atom is a thin wrapper around javascript. The wrapped script can return a value or be a statement. The Atom can supply positional arguments to pass to the wrapped script. @@ -724,27 +295,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -773,78 +326,91 @@ Summary: - - - - - - - - + +
    Public Methods
    - abstract + + - - List<? extends Object> - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - getArguments(ElementReference elementContext) - -
    - Creates a list of arguments to pass to the script. - - - -
    - -
    - abstract - - - - - String - - getScript() - -
    - Provides the script to be evaluated. - - - -
    - -
    - abstract - - - - - R - - transform(Evaluation evaluation) - -
    - Converts an Evaluation into another more suitable type. - - - -
    - -
    + abstract + + + + + List<? extends Object> + + + getArguments(ElementReference elementContext) + + +

    Creates a list of arguments to pass to the script. + + +

    + +
    + abstract + + + + + String + + + getScript() + + +

    Provides the script to be evaluated. + + +

    + +
    + abstract + + + + + R + + + transform(Evaluation evaluation) + + +

    Converts an Evaluation into another more suitable type. + + +

    + +
    @@ -855,16 +421,6 @@ Summary: - - - - - - - - - - @@ -890,120 +446,113 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - List<? extends Object> - - getArguments - (ElementReference elementContext) -

    -
    -
    - +
    +

    getArguments

    +
    +
    + + - -
    -
    - - - - -

    Creates a list of arguments to pass to the script.

    -
    -
    Parameters
    - - - +
    elementContext - null unless an ElementReference has been supplied to execute this atom + +
    +List<? extends Object> getArguments (ElementReference elementContext)
    + + + + +

    Creates a list of arguments to pass to the script.

    + + + + + - -
    Parameters
    elementContext + ElementReference: + null unless an ElementReference has been supplied to execute this atom with.
    - -
    -
    Returns
    -
    • the List of objects to pass to the script as arguments. -
    -
    +
    + + + + + + +
    Returns
    List<? extends Object>the List of objects to pass to the script as arguments. +
    -
    -
    -

    - - public - - - abstract - - String - - getScript - () -

    -
    -
    - - - -
    -
    - - - - -

    Provides the script to be evaluated. -

    +
    +

    getScript

    +
    +
    + +
    +
    +String getScript ()
    + + + + +

    Provides the script to be evaluated. +

    + + + + + + +
    Returns
    String
    +
    -
    -

    - - public - - - abstract - - R - - transform - (Evaluation evaluation) -

    -
    -
    - - - -
    -
    - - - - -

    Converts an Evaluation into another more suitable type. -

    +
    +

    transform

    +
    +
    + +
    +
    +R transform (Evaluation evaluation)
    + + + + +

    Converts an Evaluation into another more suitable type. +

    + + + + + + +
    Parameters
    evaluation + Evaluation +
    + + + + + + +
    Returns
    R
    +
    @@ -1015,193 +564,47 @@ Summary: - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/model/Atoms.html b/docs/html/reference/android/support/test/espresso/web/model/Atoms.html index fe4c2e39b116..252900d0c45c 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/Atoms.html +++ b/docs/html/reference/android/support/test/espresso/web/model/Atoms.html @@ -1,4 +1,3 @@ - @@ -93,500 +92,85 @@ - - - - - - -Atoms | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Atoms - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    Atoms

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    Atoms

    +

    + + public + + final + + class + Atoms + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.model.Atoms
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.model.Atoms +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Utility class wrapping simple and more commonly used atoms. +

    Utility class wrapping simple and more commonly used atoms.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -738,172 +295,201 @@ Summary: - - - +
    Public Methods
    + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + - + + +

    + + + +

    Public methods

    - - - static - <E> - Transformer<Evaluation, E> - - castOrDie(Class<E> clazz) - -
    - Creates a transformer which will convert an Evaluation to a given type (or die trying). - - - -
    - -
    - - - - static - - Atom<String> - - getCurrentUrl() - -
    - Returns the value of document.location.href. - - - -
    - -
    - - - - static - - Atom<String> - - getTitle() - -
    - Returns the value of document.title. - - - -
    - -
    - - - - static - - Atom<Evaluation> - - script(String script) - -
    - Creates an atom that will execute the provided script and return an evaluation object. - - - -
    - -
    - - - - static - <O> - Atom<O> - - script(String script, Transformer<Evaluation, O> transformer) - -
    - Creates an atom that will execute the provided script and return an object created by the given + +
    + + + static + + <E> + Transformer<Evaluation, E> + + + castOrDie(Class<E> clazz) + + +

    Creates a transformer which will convert an Evaluation to a given type (or die trying). + + +

    + +
    + + + static + + + Atom<String> + + + getCurrentUrl() + + +

    Returns the value of document.location.href. + + +

    + +
    + + + static + + + Atom<String> + + + getTitle() + + +

    Returns the value of document.title. + + +

    + +
    + + + static + + + Atom<Evaluation> + + + script(String script) + + +

    Creates an atom that will execute the provided script and return an evaluation object. + + +

    + +
    + + + static + + <O> + Atom<O> + + + script(String script, Transformer<Evaluation, O> transformer) + + +

    Creates an atom that will execute the provided script and return an object created by the given transformer. - - - - - -

    - - - - static - - Atom<Evaluation> - - scriptWithArgs(String script, List<? extends Object> args) - -
    - Creates an atom that will execute the provided script with the given non-contextual arguments. - - - -
    - -
    - - - - static - <I, O> - Atom<O> - - transform(Atom<I> in, Transformer<I, O> transformer) - -
    - Creates an atom which wraps the input atom and transforms its output using the given + + +

    + +
    + + + static + + + Atom<Evaluation> + + + scriptWithArgs(String script, List<? extends Object> args) + + +

    Creates an atom that will execute the provided script with the given non-contextual arguments. + + +

    + +
    + + + static + + <I, O> + Atom<O> + + + transform(Atom<I> in, Transformer<I, O> transformer) + + +

    Creates an atom which wraps the input atom and transforms its output using the given transformer. - - - - - -

    @@ -915,207 +501,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1124,16 +779,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1159,240 +804,278 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Transformer<Evaluation, E> - - castOrDie - (Class<E> clazz) -

    -
    -
    - - - -
    -
    - - +
    +

    castOrDie

    +
    +
    + + +
    +
    +Transformer<Evaluation, E> castOrDie (Class<E> clazz)
    + + -

    Creates a transformer which will convert an Evaluation to a given type (or die trying). -

    + +

    Creates a transformer which will convert an Evaluation to a given type (or die trying). +

    + + + + + + +
    Parameters
    clazz + Class +
    + + + + + + +
    Returns
    Transformer<Evaluation, E>
    -
    -
    -

    - - public - static - - - - Atom<String> - - getCurrentUrl - () -

    -
    -
    - - - -
    -
    - - +
    +

    getCurrentUrl

    +
    +
    + + +
    +
    +Atom<String> getCurrentUrl ()
    + + -

    Returns the value of document.location.href. -

    + +

    Returns the value of document.location.href. +

    + + + + + + +
    Returns
    Atom<String>
    -
    -
    -

    - - public - static - - - - Atom<String> - - getTitle - () -

    -
    -
    - - - -
    -
    - - +
    +

    getTitle

    +
    +
    + + +
    +
    +Atom<String> getTitle ()
    + + -

    Returns the value of document.title. -

    + +

    Returns the value of document.title. +

    + + + + + + +
    Returns
    Atom<String>
    -
    -
    -

    - - public - static - - - - Atom<Evaluation> - - script - (String script) -

    -
    -
    - - - -
    -
    - - +
    +

    script

    +
    +
    + + +
    +
    +Atom<Evaluation> script (String script)
    + + -

    Creates an atom that will execute the provided script and return an evaluation object. -

    + +

    Creates an atom that will execute the provided script and return an evaluation object. +

    + + + + + + +
    Parameters
    script + String +
    + + + + + + +
    Returns
    Atom<Evaluation>
    -
    -
    -

    - - public - static - - - - Atom<O> - - script - (String script, Transformer<Evaluation, O> transformer) -

    -
    -
    - - - -
    -
    +
    +

    script

    +
    +
    + + - - - -

    Creates an atom that will execute the provided script and return an object created by the given +

    +
    +Atom<O> script (String script, 
    +                Transformer<Evaluation, O> transformer)
    + + + + +

    Creates an atom that will execute the provided script and return an object created by the given transformer. -

    +

    + + + + + + + + + + +
    Parameters
    script + String +
    transformer + Transformer +
    + + + + + + +
    Returns
    Atom<O>
    -
    -
    -

    - - public - static - - - - Atom<Evaluation> - - scriptWithArgs - (String script, List<? extends Object> args) -

    -
    -
    - - - -
    -
    - - - - -

    Creates an atom that will execute the provided script with the given non-contextual arguments. -

    +
    +

    scriptWithArgs

    +
    +
    + +
    +
    +Atom<Evaluation> scriptWithArgs (String script, 
    +                List<? extends Object> args)
    + + + + +

    Creates an atom that will execute the provided script with the given non-contextual arguments. +

    + + + + + + + + + + +
    Parameters
    script + String +
    args + List +
    + + + + + + +
    Returns
    Atom<Evaluation>
    +
    -
    -

    - - public - static - - - - Atom<O> - - transform - (Atom<I> in, Transformer<I, O> transformer) -

    -
    -
    - - - -
    -
    +
    +

    transform

    +
    +
    + + - - - -

    Creates an atom which wraps the input atom and transforms its output using the given +

    +
    +Atom<O> transform (Atom<I> in, 
    +                Transformer<I, O> transformer)
    + + + + +

    Creates an atom which wraps the input atom and transforms its output using the given transformer. -

    +

    + + + + + + + + + + +
    Parameters
    in + Atom +
    transformer + Transformer +
    + + + + + + +
    Returns
    Atom<O>
    -
    @@ -1404,193 +1087,47 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/model/ElementReference.html b/docs/html/reference/android/support/test/espresso/web/model/ElementReference.html index bb72bdb9d79f..54c8f5d01162 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/ElementReference.html +++ b/docs/html/reference/android/support/test/espresso/web/model/ElementReference.html @@ -1,4 +1,3 @@ - @@ -93,507 +92,92 @@ - - - - - - -ElementReference | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ElementReference - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ElementReference

    - - - - - extends Object
    - - - - - - +

    ElementReference

    +

    + + public + + final + + class + ElementReference + +
    + + + + + extends Object + + + + + + + + implements - - JSONAble - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + JSONAble + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.model.ElementReference
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.model.ElementReference +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A reference to a javascript element existing within a WebView. +

    A reference to a javascript element existing within a WebView.

    This reference is only a pointer to data held within the javascript context of a given WebView. It may no longer be valid the next time you attempt to @@ -707,27 +282,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -756,73 +313,98 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - boolean - - equals(Object other) - -
    - - - - - - int - - hashCode() - -
    - - - - - - String - - toJSONString() - -
    - - - - - - String - - toString() - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + boolean + + + equals(Object other) + + +
    + + + + + + int + + + hashCode() + + +
    + + + + + + String + + + toJSONString() + + +
    + + + + + + String + + + toString() + + +
    @@ -834,207 +416,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1042,41 +693,51 @@ From class - @@ -1085,16 +746,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.web.model.JSONAble + + From +interface + + + android.support.test.espresso.web.model.JSONAble + +
    -
    - - - - - - - - - @@ -1120,135 +771,128 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - boolean - - equals - (Object other) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    equals

    +
    +
    + +
    +
    +boolean equals (Object other)
    + + + + +

    + + + + + + +
    Parameters
    other + Object +
    + + + + + + +
    Returns
    boolean
    +
    -
    -

    - - public - - - - - int - - hashCode - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hashCode

    +
    +
    + +
    +
    +int hashCode ()
    + + + + +

    + + + + + + +
    Returns
    int
    +
    -
    -

    - - public - - - - - String - - toJSONString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toJSONString

    +
    +
    + +
    +
    +String toJSONString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    -
    -

    - - public - - - - - String - - toString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toString

    +
    +
    + +
    +
    +String toString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    @@ -1260,193 +904,47 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/model/Evaluation.html b/docs/html/reference/android/support/test/espresso/web/model/Evaluation.html index 959cd5328d44..5a6671f8b72b 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/Evaluation.html +++ b/docs/html/reference/android/support/test/espresso/web/model/Evaluation.html @@ -1,4 +1,3 @@ - @@ -93,507 +92,92 @@ - - - - - - -Evaluation | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Evaluation - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    Evaluation

    - - - - - extends Object
    - - - - - - +

    Evaluation

    +

    + + public + + final + + class + Evaluation + +
    + + + + + extends Object + + + + + + + + implements - - JSONAble - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + JSONAble + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.model.Evaluation
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.model.Evaluation +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Represents the results of a Javascript execution. +

    Represents the results of a Javascript execution.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -750,137 +307,186 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - boolean - - equals(Object o) - -
    - - - - - - String - - getMessage() - -
    - - - - - - int - - getStatus() - -
    - - - - - - Object - - getValue() - -
    - - - - - - boolean - - hasMessage() - -
    - - - - - - int - - hashCode() - -
    - - - - - - String - - toJSONString() - -
    - - - - - - String - - toString() - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + boolean + + + equals(Object o) + + +
    + + + + + + String + + + getMessage() + + +
    + + + + + + int + + + getStatus() + + +
    + + + + + + Object + + + getValue() + + +
    + + + + + + boolean + + + hasMessage() + + +
    + + + + + + int + + + hashCode() + + +
    + + + + + + String + + + toJSONString() + + +
    + + + + + + String + + + toString() + + +
    @@ -892,207 +498,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1100,41 +775,51 @@ From class - @@ -1143,16 +828,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.web.model.JSONAble + + From +interface + + + android.support.test.espresso.web.model.JSONAble + +
    -
    - - - - - - - - - @@ -1178,263 +853,240 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - boolean - - equals - (Object o) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    equals

    +
    +
    + +
    +
    +boolean equals (Object o)
    + + + + +

    + + + + + + +
    Parameters
    o + Object +
    + + + + + + +
    Returns
    boolean
    +
    -
    -

    - - public - - - - - String - - getMessage - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getMessage

    +
    +
    + +
    +
    +String getMessage ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    -
    -

    - - public - - - - - int - - getStatus - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getStatus

    +
    +
    + +
    +
    +int getStatus ()
    + + + + +

    + + + + + + +
    Returns
    int
    +
    -
    -

    - - public - - - - - Object - - getValue - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getValue

    +
    +
    + +
    +
    +Object getValue ()
    + + + + +

    + + + + + + +
    Returns
    Object
    +
    -
    -

    - - public - - - - - boolean - - hasMessage - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hasMessage

    +
    +
    + +
    +
    +boolean hasMessage ()
    + + + + +

    + + + + + + +
    Returns
    boolean
    +
    -
    -

    - - public - - - - - int - - hashCode - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hashCode

    +
    +
    + +
    +
    +int hashCode ()
    + + + + +

    + + + + + + +
    Returns
    int
    +
    -
    -

    - - public - - - - - String - - toJSONString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toJSONString

    +
    +
    + +
    +
    +String toJSONString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    -
    -

    - - public - - - - - String - - toString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toString

    +
    +
    + +
    +
    +String toString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    @@ -1446,193 +1098,47 @@ From interface - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/model/JSONAble.DeJSONFactory.html b/docs/html/reference/android/support/test/espresso/web/model/JSONAble.DeJSONFactory.html index ee7b44c8205d..63e935e8f31c 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/JSONAble.DeJSONFactory.html +++ b/docs/html/reference/android/support/test/espresso/web/model/JSONAble.DeJSONFactory.html @@ -1,5 +1,3 @@ - - @@ -92,555 +90,129 @@ - - - - - - - -JSONAble.DeJSONFactory | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    + + + -
    + + + + + + + + + - -
    + + + -
    -
    +JSONAble.DeJSONFactory - + -
    - public - static + + - interface -

    JSONAble.DeJSONFactory

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    JSONAble.DeJSONFactory

    +

    + + public + static + + + interface + JSONAble.DeJSONFactory + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.espresso.web.model.JSONAble.DeJSONFactory
    android.support.test.espresso.web.model.JSONAble.DeJSONFactory +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Allows implementors to replace a JSONObject (representated as a map) with a more applicable +

    Allows implementors to replace a JSONObject (representated as a map) with a more applicable object.

    @@ -648,27 +220,9 @@ type="text/css"> -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -697,32 +251,37 @@ type="text/css"> - - - - - - -
    Public Methods
    - abstract + + - - Object - - - + + + + + + + + +

    Public methods

    - attemptDeJSONize(Map<String, Object> jsonObject) - -
    - Attempt to convert this map to another Java object. - - - -
    - -
    + abstract + + + + + Object + + + attemptDeJSONize(Map<String, Object> jsonObject) + + +

    Attempt to convert this map to another Java object. + + +

    + +
    @@ -733,16 +292,6 @@ type="text/css"> - - - - - - - - - - @@ -768,53 +317,45 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - Object - - attemptDeJSONize - (Map<String, Object> jsonObject) -

    -
    -
    - - - -
    -
    - - - - -

    Attempt to convert this map to another Java object.

    -
    -
    Parameters
    - - - - -
    jsonObject - the json object encountered
    -
    -
    -
    Returns
    -
    • null if it could not be converted, or the object. -
    -
    +
    +

    attemptDeJSONize

    +
    +
    + +
    +
    +Object attemptDeJSONize (Map<String, Object> jsonObject)
    + + + + +

    Attempt to convert this map to another Java object.

    + + + + + + +
    Parameters
    jsonObject + Map: + the json object encountered
    + + + + + + +
    Returns
    Objectnull if it could not be converted, or the object. +
    +
    @@ -826,193 +367,47 @@ type="text/css"> - -
    - -
    - -
    - - - -
    - - - + + diff --git a/docs/html/reference/android/support/test/espresso/web/model/JSONAble.html b/docs/html/reference/android/support/test/espresso/web/model/JSONAble.html index adb1d8ae4ce3..d21cff98bf78 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/JSONAble.html +++ b/docs/html/reference/android/support/test/espresso/web/model/JSONAble.html @@ -1,5 +1,3 @@ - - @@ -93,491 +91,77 @@ - - - - - - -JSONAble | Android Developers - - - - - - - - - - - - - - - - - - - -
    - + - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + + +
    @@ -587,7 +171,7 @@ type="text/css"> Summary: Nested Classes - + @@ -600,189 +184,159 @@ Summary: | Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public - - - - interface -

    JSONAble

    - +

    JSONAble

    +

    + + public + + + + interface + JSONAble + +
    + + + + + +

    - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.espresso.web.model.JSONAble
    android.support.test.espresso.web.model.JSONAble +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Allows implementors to instruct ModelCodec on how to encode this object as JSON. +

    Allows implementors to instruct ModelCodec on how to encode this object as JSON.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - interfaceJSONAble.DeJSONFactory
    + + + + + + - - + + @@ -811,25 +365,32 @@ Summary: -

    Nested classes

    + + + + + interface - Allows implementors to replace a JSONObject (representated as a map) with a more applicable + JSONAble.DeJSONFactory +

    Allows implementors to replace a JSONObject (representated as a map) with a more applicable object.  - - - + + +

    - - - +
    Public Methods
    + - - - + + + + + + + + +

    Public methods

    - abstract - - - - - String - - toJSONString() -
    + abstract + + + + + String + + + toJSONString() + + +
    @@ -840,16 +401,6 @@ Summary: -
    - - - - - - - - - @@ -875,39 +426,35 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - String - - toJSONString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toJSONString

    +
    +
    + +
    +
    +String toJSONString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    @@ -919,193 +466,47 @@ Summary: - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/model/ModelCodec.html b/docs/html/reference/android/support/test/espresso/web/model/ModelCodec.html index 1dde64e00717..80fe56a3bc78 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/ModelCodec.html +++ b/docs/html/reference/android/support/test/espresso/web/model/ModelCodec.html @@ -1,4 +1,3 @@ - @@ -93,500 +92,85 @@ - - - - - - -ModelCodec | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ModelCodec - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ModelCodec

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    ModelCodec

    +

    + + public + + final + + class + ModelCodec + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.model.ModelCodec
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.model.ModelCodec +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Encodes/Decodes JSON. +

    Encodes/Decodes JSON.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -738,101 +295,118 @@ Summary: - - - - - - - - - - - - - - @@ -1307,16 +967,6 @@ From interface
    Public Methods
    - - - - static - - void - - addDeJSONFactory(JSONAble.DeJSONFactory dejson) - -
    - Adds a DeJSONFactory to intercept JSONObjects and replace them with more suitable types. - - - -
    - -
    - - - - static - - Evaluation - - decodeEvaluation(String json) - -
    - Transforms a JSON string to an evaluation. - - - -
    + + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - - - - static - - String - - encode(Object javaObject) - -
    - Encodes a Java Object into a JSON string. - - - -
    - -
    - - - - static - - void - - removeDeJSONFactory(JSONAble.DeJSONFactory dejson) - -
    - Removes a DeJSONFactory from the list of factories that transform JSONObjects to java objects. - - - -
    - -
    + + + static + + + void + + + addDeJSONFactory(JSONAble.DeJSONFactory dejson) + + +

    Adds a DeJSONFactory to intercept JSONObjects and replace them with more suitable types. + + +

    + +
    + + + static + + + Evaluation + + + decodeEvaluation(String json) + + +

    Transforms a JSON string to an evaluation. + + +

    + +
    + + + static + + + String + + + encode(Object javaObject) + + +

    Encodes a Java Object into a JSON string. + + +

    + +
    + + + static + + + void + + + removeDeJSONFactory(JSONAble.DeJSONFactory dejson) + + +

    Removes a DeJSONFactory from the list of factories that transform JSONObjects to java objects. + + +

    + +
    @@ -844,207 +418,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1053,16 +696,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1088,139 +721,145 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - void - - addDeJSONFactory - (JSONAble.DeJSONFactory dejson) -

    -
    -
    - - - -
    -
    - - +
    +

    addDeJSONFactory

    +
    +
    + + +
    +
    +void addDeJSONFactory (JSONAble.DeJSONFactory dejson)
    + + -

    Adds a DeJSONFactory to intercept JSONObjects and replace them with more suitable types. -

    + +

    Adds a DeJSONFactory to intercept JSONObjects and replace them with more suitable types. +

    + + + + + + +
    Parameters
    dejson + JSONAble.DeJSONFactory +
    -
    -
    -

    - - public - static - - - - Evaluation - - decodeEvaluation - (String json) -

    -
    -
    - - - -
    -
    - - +
    +

    decodeEvaluation

    +
    +
    + + +
    +
    +Evaluation decodeEvaluation (String json)
    + + -

    Transforms a JSON string to an evaluation. -

    + +

    Transforms a JSON string to an evaluation. +

    + + + + + + +
    Parameters
    json + String +
    + + + + + + +
    Returns
    Evaluation
    -
    -
    -

    - - public - static - - - - String - - encode - (Object javaObject) -

    -
    -
    - - - -
    -
    - - +
    +

    encode

    +
    +
    + + +
    +
    +String encode (Object javaObject)
    + + -

    Encodes a Java Object into a JSON string. -

    + +

    Encodes a Java Object into a JSON string. +

    + + + + + + +
    Parameters
    javaObject + Object +
    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - static - - - - void - - removeDeJSONFactory - (JSONAble.DeJSONFactory dejson) -

    -
    -
    - - - -
    -
    - - +
    +

    removeDeJSONFactory

    +
    +
    + + +
    +
    +void removeDeJSONFactory (JSONAble.DeJSONFactory dejson)
    + + -

    Removes a DeJSONFactory from the list of factories that transform JSONObjects to java objects. -

    + +

    Removes a DeJSONFactory from the list of factories that transform JSONObjects to java objects. +

    + + + + + + +
    Parameters
    dejson + JSONAble.DeJSONFactory +
    -
    @@ -1232,193 +871,47 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    + + diff --git a/docs/html/reference/android/support/test/espresso/web/model/SimpleAtom.ElementReferencePlacement.html b/docs/html/reference/android/support/test/espresso/web/model/SimpleAtom.ElementReferencePlacement.html index 24a874a290ec..082c2ce91623 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/SimpleAtom.ElementReferencePlacement.html +++ b/docs/html/reference/android/support/test/espresso/web/model/SimpleAtom.ElementReferencePlacement.html @@ -1,4 +1,3 @@ - @@ -93,519 +92,104 @@ - - - - - - -SimpleAtom.ElementReferencePlacement | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +SimpleAtom.ElementReferencePlacement - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - static - final - - enum -

    SimpleAtom.ElementReferencePlacement

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - +

    SimpleAtom.ElementReferencePlacement

    +

    + + public + static + final + + enum + SimpleAtom.ElementReferencePlacement + +
    + + + + + + + + + + + extends Enum<SimpleAtom.ElementReferencePlacement> + + + + + + + + + + + +

    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.espresso.web.model.SimpleAtom.ElementReferencePlacement
    + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Enum<android.support.test.espresso.web.model.SimpleAtom.ElementReferencePlacement> +
        ↳android.support.test.espresso.web.model.SimpleAtom.ElementReferencePlacement +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Controls whether the ElementReference appears as the first arg or last arg to the script. +

    Controls whether the ElementReference appears as the first arg or last arg to the script.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -758,33 +318,34 @@ Summary: - - - - - - - - - - - - - - - - - +
    Enum Values
    SimpleAtom.ElementReferencePlacement FIRST  -   - - - -
    SimpleAtom.ElementReferencePlacement LAST  -   - - - -
    + + + + + + + + + + + + + + + @@ -804,41 +365,54 @@ Summary: -

    Enum values

    SimpleAtom.ElementReferencePlacement  + FIRST +

      + + +

    +
    SimpleAtom.ElementReferencePlacement  + LAST +

      + + +

    +
    - - - +
    Public Methods
    + - - - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - - static - - SimpleAtom.ElementReferencePlacement - - valueOf(String name) - -
    - - - final - static - - ElementReferencePlacement[] - - values() - -
    + + + static + + + SimpleAtom.ElementReferencePlacement + + + valueOf(String name) + + +
    + + + static + final + + ElementReferencePlacement[] + + + values() + + +
    @@ -850,207 +424,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1058,201 +701,271 @@ From class - @@ -1262,41 +975,51 @@ From class - @@ -1305,16 +1028,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Enum + + From +class + + + java.lang.Enum + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - java.lang.Comparable + + From +interface + + + java.lang.Comparable + +
    -
    - - - - - - - - - @@ -1323,69 +1036,53 @@ From interface -

    Enum Values

    +

    Enum values

    -
    -

    - - public - static - final - SimpleAtom.ElementReferencePlacement - - FIRST -

    -
    - - - - -
    -
    - - +
    +

    FIRST

    +
    + + + +
    +
    +SimpleAtom.ElementReferencePlacement FIRST
    + + -

    - + +

    -
    +
    -
    -

    - - public - static - final - SimpleAtom.ElementReferencePlacement - - LAST -

    -
    - - - +
    +

    LAST

    +
    + + + -
    -
    - - - - -

    +
    +
    +SimpleAtom.ElementReferencePlacement LAST
    + + + +

    -
    +
    @@ -1409,71 +1106,72 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - SimpleAtom.ElementReferencePlacement - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +SimpleAtom.ElementReferencePlacement valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    SimpleAtom.ElementReferencePlacement
    +
    -
    -

    - - public - static - final - - - ElementReferencePlacement[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +ElementReferencePlacement[] values ()
    + + + + +

    + + + + + + +
    Returns
    ElementReferencePlacement[]
    +
    @@ -1485,193 +1183,47 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/model/SimpleAtom.html b/docs/html/reference/android/support/test/espresso/web/model/SimpleAtom.html index 8d67f058912c..c3c70d3f9fe0 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/SimpleAtom.html +++ b/docs/html/reference/android/support/test/espresso/web/model/SimpleAtom.html @@ -1,583 +1,3 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -SimpleAtom | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    - -
    @@ -596,614 +16,838 @@ type="text/css"> - -
    - - - - -
    -
    - - - - -
    - public - - - - class -

    SimpleAtom

    - - - - - extends Object
    - - - - - - - implements - - Atom<R> - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳android.support.test.espresso.web.model.SimpleAtom
    - - - - - - - -
    - - -

    Class Overview

    -

    A simple implementation of Atom suitable for subclassing. -

    - - - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Nested Classes
    - - - - - enumSimpleAtom.ElementReferencePlacement - Controls whether the ElementReference appears as the first arg or last arg to the script.  - - - -
    - - - - - - - - - - -
    Public Constructors
    - - - - - - - - SimpleAtom(String script) - -
    - Creates a SimpleAtom which runs the given script and places any ElementReference as the first - argument to the script. - - -
    -
    - - - SimpleAtom(String script, SimpleAtom.ElementReferencePlacement elementPlacement) -
    - Creates a SimpleAtom which runs the given script and places any supplied ElementReference - either as the first or last argument to the script. -
    -
    - - - - - - - - - - - -
    Public Methods
    - final - List<? extends Object> - - getArguments(ElementReference elementRef) -
    - The SimpleAtom presents an argument list to the script which follows some basic conventions. -
    -
    - final - String - - getScript() -
    - Returns the script this SimpleAtom was created with. -
    -
    - final - Evaluation - - transform(Evaluation e) -
    - The SimpleAtom's transform method checks the Evaluation object for success. -
    -
    - - - - - - - - - - - + +SimpleAtom -
    Protected Methods
    - List<? extends Object> - - getNonContextualArguments() -
    - Extend this method to pass additional arguments to the script. -
    -
    - Evaluation - - handleBadEvaluation(Evaluation e) -
    - Extend this method to handle a failure code in the Evaluation object. -
    -
    + + + + + + + + + + - void - - handleNoElementReference() + -
    - Extend this method to handle the case where getArguments() has been called without - an ElementReference. + + + -
    + -
    + + + - - +
    - - - - - - - - @@ -1211,94 +855,110 @@ From class -
    - [Expand] -
    Inherited Methods
    - -From class +
    +
    + + + - java.lang.Object +
    -
    - -
    +

    - final +

    A simple implementation of Atom suitable for subclassing. +

    - Class<?>
    -
    - getClass() -
    +

    Summary

    + + + + + + + + + + + + - int - - - - - - - - - - - - - + +

    Nested classes

    + + + + + enum + SimpleAtom.ElementReferencePlacement +

    Controls whether the ElementReference appears as the first arg or last arg to the script.  + + +

    +
    - hashCode() -
    - final - void - - notify() -
    - final - void - - notifyAll() -
    + + + - String - - + + + + + + + + + + + + + - +

    Public constructors

    - toString() + +
    + + SimpleAtom(String script) + + +

    Creates a SimpleAtom which runs the given script and places any ElementReference as the first + argument to the script. + + +

    + +
    + + SimpleAtom(String script, SimpleAtom.ElementReferencePlacement elementPlacement) + + +

    Creates a SimpleAtom which runs the given script and places any supplied ElementReference + either as the first or last argument to the script. + + +

    + +
    -
    - final - void - - wait() + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -

    Public methods

    + + + + final + + List<? extends Object> + + + getArguments(ElementReference elementRef) + + +

    The SimpleAtom presents an argument list to the script which follows some basic conventions. + + +

    + +
    + + + + final + + String + + + getScript() + + +

    Returns the script this SimpleAtom was created with. + + +

    + +
    + + + + final + + Evaluation + + + transform(Evaluation e) + + +

    The SimpleAtom's transform method checks the Evaluation object for success. + + +

    + +
    +
    - final - void -
    - wait(long arg0, int arg1) -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Protected methods

    + + + + + + List<? extends Object> + + + getNonContextualArguments() + + +

    Extend this method to pass additional arguments to the script. + + +

    + +
    + + + + + + Evaluation + + + handleBadEvaluation(Evaluation e) + + +

    Extend this method to handle a failure code in the Evaluation object. + + +

    + +
    + + + + + + void + + + handleNoElementReference() + + +

    Extend this method to handle the case where getArguments() has been called without + an ElementReference. + + +

    + +
    -
    - final - void - - wait(long arg0) + + + - + +

    Inherited methods

    -
    + From +class + + + java.lang.Object + + +
    + +
    - -From interface - - android.support.test.espresso.web.model.Atom + + From +interface + + + android.support.test.espresso.web.model.Atom + +
    -
    - - - - - - - - - @@ -1334,75 +984,78 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - SimpleAtom - (String script) -

    -
    -
    - - - -
    -
    - - +
    +

    SimpleAtom

    +
    +
    + + +
    +
    +SimpleAtom (String script)
    + + -

    Creates a SimpleAtom which runs the given script and places any ElementReference as the first + +

    Creates a SimpleAtom which runs the given script and places any ElementReference as the first argument to the script. -

    +

    + + + + + + +
    Parameters
    script + String +
    -
    -
    -

    - - public - - +
    +

    SimpleAtom

    +
    +
    + + - - - - SimpleAtom - (String script, SimpleAtom.ElementReferencePlacement elementPlacement) -

    -
    -
    - - - -
    -
    - - - - -

    Creates a SimpleAtom which runs the given script and places any supplied ElementReference +

    +
    +SimpleAtom (String script, 
    +                SimpleAtom.ElementReferencePlacement elementPlacement)
    + + + + +

    Creates a SimpleAtom which runs the given script and places any supplied ElementReference either as the first or last argument to the script. -

    +

    + + + + + + + + + + +
    Parameters
    script + String +
    elementPlacement + SimpleAtom.ElementReferencePlacement +
    -
    @@ -1417,130 +1070,123 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - final - - - List<? extends Object> - - getArguments - (ElementReference elementRef) -

    -
    -
    - - - -
    -
    - - +
    +

    getArguments

    +
    +
    + + +
    +
    +List<? extends Object> getArguments (ElementReference elementRef)
    + + -

    The SimpleAtom presents an argument list to the script which follows some basic conventions. + +

    The SimpleAtom presents an argument list to the script which follows some basic conventions. If an ElementReference is provided, it is placed either in the first or last position based on the ElementReferencePlacement provided to the constructor. The nonContextualArguments (if provided via getNonContextualArguments) will appear after the ElementReference. -

    -
    -
    Parameters
    - - - +
    elementRef - null unless an ElementReference has been supplied to execute this atom +

    + + + + + - -
    Parameters
    elementRef + ElementReference: + null unless an ElementReference has been supplied to execute this atom with.
    - -
    -
    Returns
    -
    • the List of objects to pass to the script as arguments. -
    -
    +
    + + + + + + +
    Returns
    List<? extends Object>the List of objects to pass to the script as arguments. +
    -
    -
    -

    - - public - - final - - - String - - getScript - () -

    -
    -
    - - - -
    -
    - - +
    +

    getScript

    +
    +
    + + +
    +
    +String getScript ()
    + + -

    Returns the script this SimpleAtom was created with. -

    + +

    Returns the script this SimpleAtom was created with. +

    + + + + + + +
    Returns
    String
    -
    -
    -

    - - public - - final - - - Evaluation - - transform - (Evaluation e) -

    -
    -
    - - - -
    -
    - - +
    +

    transform

    +
    +
    + + +
    +
    +Evaluation transform (Evaluation e)
    + + -

    The SimpleAtom's transform method checks the Evaluation object for success. + +

    The SimpleAtom's transform method checks the Evaluation object for success. If the Evaluation object has an error, the default behaviour is to throw an exception, subclasses may change this behaviour via the handleBadEvaluation method. -

    +

    + + + + + + +
    Parameters
    e + Evaluation +
    + + + + + + +
    Returns
    Evaluation
    -
    @@ -1549,128 +1195,109 @@ From interface -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - - - List<? extends Object> - - getNonContextualArguments - () -

    -
    -
    - - - -
    -
    - - - - -

    Extend this method to pass additional arguments to the script.

    -
    -
    Returns
    -
    • a list of arguments (non-null) -
    -
    +
    +

    getNonContextualArguments

    +
    +
    + +
    +
    +List<? extends Object> getNonContextualArguments ()
    + + + + +

    Extend this method to pass additional arguments to the script.

    + + + + + + +
    Returns
    List<? extends Object>a list of arguments (non-null) +
    +
    -
    -

    - - protected - - - - - Evaluation - - handleBadEvaluation - (Evaluation e) -

    -
    -
    - - - -
    -
    - - +
    +

    handleBadEvaluation

    +
    +
    + + +
    +
    +Evaluation handleBadEvaluation (Evaluation e)
    + + -

    Extend this method to handle a failure code in the Evaluation object. + +

    Extend this method to handle a failure code in the Evaluation object. The default implementation will throw an exception, subclasses may want to ignore - certain failure cases.

    -
    -
    Returns
    -
    • Evaluation the evaluation object (must be non-null)
    -
    -
    -
    Throws
    - + certain failure cases.

    +
    + + + + + +
    Parameters
    e + Evaluation +
    + + + + + + +
    Returns
    EvaluationEvaluation the evaluation object (must be non-null)
    + + - +
    Throws
    RuntimeException - if the badness level is too high. + RuntimeExceptionif the badness level is too high.
    -
    + -
    -
    -

    - - protected - - - - - void - - handleNoElementReference - () -

    -
    -
    - - - -
    -
    - - +
    +

    handleNoElementReference

    +
    +
    + + +
    +
    +void handleNoElementReference ()
    + + -

    Extend this method to handle the case where getArguments() has been called without + +

    Extend this method to handle the case where getArguments() has been called without an ElementReference. Implementors may want to throw an exception here if they require an ElementReference to evaluate properly. -

    +

    -
    @@ -1678,193 +1305,47 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/model/TransformingAtom.Transformer.html b/docs/html/reference/android/support/test/espresso/web/model/TransformingAtom.Transformer.html index 648e1d59ecdc..ad06be894944 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/TransformingAtom.Transformer.html +++ b/docs/html/reference/android/support/test/espresso/web/model/TransformingAtom.Transformer.html @@ -1,7 +1,3 @@ - - - - @@ -92,582 +88,140 @@ - - - - - - - -TransformingAtom.Transformer | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    + + + -
    + + + + + + + + + - -
    + + + -
    -
    +TransformingAtom.Transformer - + -
    - public - static + + - interface -

    TransformingAtom.Transformer

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    TransformingAtom.Transformer

    +

    + + public + static + + + interface + TransformingAtom.Transformer + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.espresso.web.model.TransformingAtom.Transformer<I, O>
    android.support.test.espresso.web.model.TransformingAtom.Transformer<I, O> +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Converts input to output. +

    Converts input to output.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -696,25 +250,32 @@ type="text/css"> - +
    Public Methods
    + - - - - - + + + + + + + + +

    Public methods

    - abstract - - - - - O - - apply(I input) - -
    + abstract + + + + + O + + + apply(I input) + + +
    @@ -725,16 +286,6 @@ type="text/css"> -
    - - - - - - - - - @@ -760,39 +311,44 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - O - - apply - (I input) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    apply

    +
    +
    + +
    +
    +O apply (I input)
    + + + + +

    + + + + + + +
    Parameters
    input + I +
    + + + + + + +
    Returns
    O
    +
    @@ -804,193 +360,47 @@ type="text/css"> - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/model/TransformingAtom.html b/docs/html/reference/android/support/test/espresso/web/model/TransformingAtom.html index 6e9006d1618b..9376e175db23 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/TransformingAtom.html +++ b/docs/html/reference/android/support/test/espresso/web/model/TransformingAtom.html @@ -1,4 +1,3 @@ - @@ -93,507 +92,92 @@ - - - - - - -TransformingAtom | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +TransformingAtom - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    TransformingAtom

    - - - - - extends Object
    - - - - - - +

    TransformingAtom

    +

    + + public + + final + + class + TransformingAtom + +
    + + + + + extends Object + + + + + + + + implements - - Atom<R> - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + Atom<O> + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.model.TransformingAtom<I, O>
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.model.TransformingAtom<I, O> +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Decorates another atom and transforms its output to another type.

    - +

    Decorates another atom and transforms its output to another type.

    -
    - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - interfaceTransformingAtom.Transformer<I, O>
    + + + + + + - - + + @@ -776,25 +334,23 @@ Summary: -

    Nested classes

    + + + + + interface - Converts input to output.  - - - + TransformingAtom.Transformer<I, O> +

    Converts input to output.  + + +

    - - - - - -
    Public Constructors
    - + + - - - - - + + + + + + +

    Public constructors

    - TransformingAtom(Atom<I> parent, Transformer<I, O> transformer) - -
    + + TransformingAtom(Atom<I> parent, Transformer<I, O> transformer) + + +
    @@ -805,78 +361,91 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - List<? extends Object> - - getArguments(ElementReference elementContext) - -
    - Creates a list of arguments to pass to the script. - - - -
    - -
    - - - - - - String - - getScript() - -
    - Provides the script to be evaluated. - - - -
    - -
    - - - - - - O - - transform(Evaluation eval) - -
    - Converts an Evaluation into another more suitable type. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + List<? extends Object> + + + getArguments(ElementReference elementContext) + + +

    Creates a list of arguments to pass to the script. + + +

    + +
    + + + + + + String + + + getScript() + + +

    Provides the script to be evaluated. + + +

    + +
    + + + + + + O + + + transform(Evaluation eval) + + +

    Converts an Evaluation into another more suitable type. + + +

    + +
    @@ -888,207 +457,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1096,94 +734,110 @@ From class - @@ -1192,16 +846,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.web.model.Atom + + From +interface + + + android.support.test.espresso.web.model.Atom + +
    - - - - - - - - - - @@ -1219,39 +863,44 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - TransformingAtom - (Atom<I> parent, Transformer<I, O> transformer) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    TransformingAtom

    +
    +
    + +
    +
    +TransformingAtom (Atom<I> parent, 
    +                Transformer<I, O> transformer)
    + + + + +

    + + + + + + + + + + +
    Parameters
    parent + Atom +
    transformer + Transformer +
    +
    @@ -1266,120 +915,113 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - List<? extends Object> - - getArguments - (ElementReference elementContext) -

    -
    -
    - - - -
    -
    - +
    +

    getArguments

    +
    +
    + + - - -

    Creates a list of arguments to pass to the script.

    -
    -
    Parameters
    - - - +
    elementContext - null unless an ElementReference has been supplied to execute this atom + +
    +List<? extends Object> getArguments (ElementReference elementContext)
    + + + + +

    Creates a list of arguments to pass to the script.

    + + + + + - -
    Parameters
    elementContext + ElementReference: + null unless an ElementReference has been supplied to execute this atom with.
    - -
    -
    Returns
    -
    • the List of objects to pass to the script as arguments. -
    -
    +
    + + + + + + +
    Returns
    List<? extends Object>the List of objects to pass to the script as arguments. +
    -
    -
    -

    - - public - - - - - String - - getScript - () -

    -
    -
    - - - -
    -
    - - - - -

    Provides the script to be evaluated. -

    +
    +

    getScript

    +
    +
    + +
    +
    +String getScript ()
    + + + + +

    Provides the script to be evaluated. +

    + + + + + + +
    Returns
    String
    +
    -
    -

    - - public - - - - - O - - transform - (Evaluation eval) -

    -
    -
    - - - -
    -
    - - - - -

    Converts an Evaluation into another more suitable type. -

    +
    +

    transform

    +
    +
    + +
    +
    +O transform (Evaluation eval)
    + + + + +

    Converts an Evaluation into another more suitable type. +

    + + + + + + +
    Parameters
    eval + Evaluation +
    + + + + + + +
    Returns
    O
    +
    @@ -1391,193 +1033,47 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/model/WindowReference.html b/docs/html/reference/android/support/test/espresso/web/model/WindowReference.html index cf7d54e9471d..20a5901e9b07 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/WindowReference.html +++ b/docs/html/reference/android/support/test/espresso/web/model/WindowReference.html @@ -1,4 +1,3 @@ - @@ -93,507 +92,92 @@ - - - - - - -WindowReference | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +WindowReference - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    WindowReference

    - - - - - extends Object
    - - - - - - +

    WindowReference

    +

    + + public + + final + + class + WindowReference + +
    + + + + + extends Object + + + + + + + + implements - - JSONAble - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + JSONAble + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.model.WindowReference
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.model.WindowReference +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A reference to a javascript window/frame existing within a WebView. +

    A reference to a javascript window/frame existing within a WebView.

    This reference is only a pointer to data held within the javascript context of a given WebView. It may no longer be valid the next time you attempt to @@ -707,27 +282,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -756,73 +313,98 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - boolean - - equals(Object other) - -
    - - - - - - int - - hashCode() - -
    - - - - - - String - - toJSONString() - -
    - - - - - - String - - toString() - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + boolean + + + equals(Object other) + + +
    + + + + + + int + + + hashCode() + + +
    + + + + + + String + + + toJSONString() + + +
    + + + + + + String + + + toString() + + +
    @@ -834,207 +416,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1042,41 +693,51 @@ From class - @@ -1085,16 +746,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - android.support.test.espresso.web.model.JSONAble + + From +interface + + + android.support.test.espresso.web.model.JSONAble + +
    -
    - - - - - - - - - @@ -1120,135 +771,128 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - boolean - - equals - (Object other) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    equals

    +
    +
    + +
    +
    +boolean equals (Object other)
    + + + + +

    + + + + + + +
    Parameters
    other + Object +
    + + + + + + +
    Returns
    boolean
    +
    -
    -

    - - public - - - - - int - - hashCode - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    hashCode

    +
    +
    + +
    +
    +int hashCode ()
    + + + + +

    + + + + + + +
    Returns
    int
    +
    -
    -

    - - public - - - - - String - - toJSONString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toJSONString

    +
    +
    + +
    +
    +String toJSONString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    -
    -

    - - public - - - - - String - - toString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toString

    +
    +
    + +
    +
    +String toString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    @@ -1260,193 +904,47 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/model/package-summary.html b/docs/html/reference/android/support/test/espresso/web/model/package-summary.html index 19a493947491..b3fc482c3a82 100644 --- a/docs/html/reference/android/support/test/espresso/web/model/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/web/model/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,881 +92,281 @@ - - - - - - -android.support.test.espresso.web.model | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.web.model - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.web.model

    -
    - -
    - -
    - - +

    android.support.test.espresso.web.model

    + +

    Interfaces

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + +
    Atom<R>Atom<R> An Atom is a thin wrapper around javascript.  - - + +
    JSONAbleJSONAble Allows implementors to instruct ModelCodec on how to encode this object as JSON.  - - + +
    JSONAble.DeJSONFactoryJSONAble.DeJSONFactory Allows implementors to replace a JSONObject (representated as a map) with a more applicable object.  - - + +
    TransformingAtom.Transformer<I, O>TransformingAtom.Transformer<I, O> Converts input to output.  - - + +
    -
    - - + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + +
    AtomsAtoms Utility class wrapping simple and more commonly used atoms.  - - + +
    ElementReferenceElementReference A reference to a javascript element existing within a WebView.  - - + +
    EvaluationEvaluation Represents the results of a Javascript execution.  - - + +
    ModelCodecModelCodec Encodes/Decodes JSON.  - - + +
    SimpleAtomSimpleAtom A simple implementation of Atom suitable for subclassing.  - - + +
    TransformingAtom<I, O>TransformingAtom<I, O> Decorates another atom and transforms its output to another type.  - - + +
    WindowReferenceWindowReference A reference to a javascript window/frame existing within a WebView.  - - + +
    -
    - - + +

    Enums

    -
    - - + + - + - + + + +
    SimpleAtom.ElementReferencePlacementSimpleAtom.ElementReferencePlacement Controls whether the ElementReference appears as the first arg or last arg to the script.  - - + +
    + -
    -
    - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + + + + + +
    + diff --git a/docs/html/reference/android/support/test/espresso/web/sugar/Web.WebInteraction.html b/docs/html/reference/android/support/test/espresso/web/sugar/Web.WebInteraction.html index db6f8a213312..eb1fe6d558a5 100644 --- a/docs/html/reference/android/support/test/espresso/web/sugar/Web.WebInteraction.html +++ b/docs/html/reference/android/support/test/espresso/web/sugar/Web.WebInteraction.html @@ -1,1011 +1,109 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Web.WebInteraction | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    - -
    - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - static - - - class -

    Web.WebInteraction

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳android.support.test.espresso.web.sugar.Web.WebInteraction<R>
    - - - - - - - -
    - - -

    Class Overview

    -

    Analogous to a ViewInteraction or a DataInteraction, a WebInteraction exposes a fluent API to - the underlying WebView. -

    - - - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Methods
    - - - - - <E> - WebInteraction<E> - - check(WebAssertion<E> assertion) - -
    - Evaluates the given WebAssertion. - - - -
    - -
    - - - - - - WebInteraction<R> - - forceJavascriptEnabled() - -
    - Performs a force enable of Javascript on a WebView. - - - -
    - -
    - R - - get() -
    - Returns the result of a prior call to perform or check. -
    -
    - WebInteraction<R> - - inWindow(Atom<WindowReference> windowPicker) -
    - Causes this WebInteraction to have it's javascript evaluated in a particular DOM window. -
    -
    - WebInteraction<R> - - inWindow(WindowReference window) -
    - Causes this WebInteraction to have it's javascript evaluated in a particular DOM window. -
    -
    - <E> - WebInteraction<E> - - perform(Atom<E> atom) - -
    - Executes the provided atom within the current context (the combination of Window and Element - References). - - - -
    - -
    - - - - - - WebInteraction<R> - - reset() - -
    - Removes the Element and Window references from this interaction. - -
    -
    - WebInteraction<R> - - withContextualElement(Atom<ElementReference> elementPicker) -
    - Allows for contextually evaluating this WebInteraction with the selected element. -
    -
    - WebInteraction<R> - - withElement(ElementReference element) -
    - Causes this WebInteraction to supply the given ElementReference to the Atom prior to - evaluation. - - - -
    - -
    - WebInteraction<R> - - withElement(Atom<ElementReference> elementPicker) - -
    - Causes this WebInteraction to supply the given ElementReference to the Atom prior to - evaluation. -
    -
    - WebInteraction<R> - - withNoTimeout() -
    - Disables all Timeouts on this WebInteraction. -
    -
    - WebInteraction<R> - - withTimeout(long amount, TimeUnit unit) -
    - Sets a specific timeout for this WebInteraction. -
    -
    @@ -1013,208 +111,803 @@ Summary: - - - - - - - - - - - - - - - - - - - @@ -1223,16 +916,6 @@ From class
    - [Expand] -
    Inherited Methods
    - -From class - java.lang.Object -
    - -
    +

    - final +

    Analogous to a ViewInteraction or a DataInteraction, a WebInteraction exposes a fluent API to + the underlying WebView. +

    - void
    -
    - notify() -
    +

    Summary

    - final - void
    -
    - notifyAll() -
    - String - - toString() -
    - final - void - - wait() -
    - final + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - void - - +

    Public methods

    + + + + + <E> + WebInteraction<E> + + + check(WebAssertion<E> assertion) + + +

    Evaluates the given WebAssertion. + + +

    + +
    + + + + + + WebInteraction<R> + + + forceJavascriptEnabled() + + +

    Performs a force enable of Javascript on a WebView. + + +

    + +
    + + + + + + R + + + get() + + +

    Returns the result of a prior call to perform or check. + + +

    + +
    + + + + + + WebInteraction<R> + + + inWindow(WindowReference window) + + +

    Causes this WebInteraction to have it's javascript evaluated in a particular DOM window. + + +

    + +
    + + + + + + WebInteraction<R> + + + inWindow(Atom<WindowReference> windowPicker) + + +

    Causes this WebInteraction to have it's javascript evaluated in a particular DOM window. + + +

    + +
    + + + + + <E> + WebInteraction<E> + + + perform(Atom<E> atom) + + +

    Executes the provided atom within the current context (the combination of Window and Element + References). + + +

    + +
    + + + + + + WebInteraction<R> + + + reset() + + +

    Removes the Element and Window references from this interaction. + + +

    + +
    + + + + + + WebInteraction<R> + + + withContextualElement(Atom<ElementReference> elementPicker) + + +

    Allows for contextually evaluating this WebInteraction with the selected element. + + +

    + +
    + + + + + + WebInteraction<R> + + + withElement(ElementReference element) + + +

    Causes this WebInteraction to supply the given ElementReference to the Atom prior to + evaluation. + + +

    + +
    + + + + + + WebInteraction<R> + + + withElement(Atom<ElementReference> elementPicker) + + +

    Causes this WebInteraction to supply the given ElementReference to the Atom prior to + evaluation. + + +

    + +
    + + + + + + WebInteraction<R> + + + withNoTimeout() + + +

    Disables all Timeouts on this WebInteraction. + + +

    + +
    + + + + + + WebInteraction<R> + + + withTimeout(long amount, TimeUnit unit) + + +

    Sets a specific timeout for this WebInteraction. + + +

    + +
    - wait(long arg0, int arg1) -
    -
    - final - void - - wait(long arg0) + + + - + +

    Inherited methods

    -
    + From +class + + + java.lang.Object + + +
    + +
    -
    - - - - - - - - - @@ -1258,295 +941,293 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - WebInteraction<E> - - check - (WebAssertion<E> assertion) -

    -
    -
    - - - -
    -
    - - +
    +

    check

    +
    +
    + + +
    +
    +WebInteraction<E> check (WebAssertion<E> assertion)
    + + -

    Evaluates the given WebAssertion. + +

    Evaluates the given WebAssertion. The WebAssertion's atom is evaluated, after it's evaluation completes, the WebAssertion is run on the main thread to perform further checks. The WebAssertion is given the Atom's result and the WebView it had run against. After this method completes, the result of the atom's evaluation is avaliable via get. -

    +

    + + + + + + +
    Parameters
    assertion + WebAssertion +
    + + + + + + +
    Returns
    WebInteraction<E>
    -
    -
    -

    - - public - - - - - WebInteraction<R> - - forceJavascriptEnabled - () -

    -
    -
    - - - -
    -
    - - +
    +

    forceJavascriptEnabled

    +
    +
    + + +
    +
    +WebInteraction<R> forceJavascriptEnabled ()
    + + -

    Performs a force enable of Javascript on a WebView. + +

    Performs a force enable of Javascript on a WebView. All WebView interactions are done via Javascript - therefore the WebView we are working on must support Javascript evaluation. Enabling Javascript may cause the WebView under test to be reloaded. This is necessary to ensure the test infrastructure javascript bridges are loaded by the WebView. -

    +

    + + + + + + +
    Returns
    WebInteraction<R>
    -
    -
    -

    - - public - - +
    +

    get

    +
    +
    + + +
    +
    +R get ()
    + + - R - - get - () -

    -
    -
    + +

    Returns the result of a prior call to perform or check. +

    + + + + + + +
    Returns
    R
    +
    -
    -
    + +
    +

    inWindow

    +
    +
    + + +
    +
    +WebInteraction<R> inWindow (WindowReference window)
    + + + +

    Causes this WebInteraction to have it's javascript evaluated in a particular DOM window. -

    Returns the result of a prior call to perform or check. -

    + By default Javascript may be evaluated in the main window. However in an application which + uses frames, you may want to evaluate in another frame. +

    + + + + + + +
    Parameters
    window + WindowReference +
    + + + + + + +
    Returns
    WebInteraction<R>
    -
    -
    -

    - - public - - - - - WebInteraction<R> - - inWindow - (Atom<WindowReference> windowPicker) -

    -
    -
    - - - -
    -
    - - +
    +

    inWindow

    +
    +
    + + +
    +
    +WebInteraction<R> inWindow (Atom<WindowReference> windowPicker)
    + + -

    Causes this WebInteraction to have it's javascript evaluated in a particular DOM window. + +

    Causes this WebInteraction to have it's javascript evaluated in a particular DOM window. This method accepts an Atom which will be evaluated in the main window to choose a particular DOM window for further interactions. This method will block until the the provided Atom returns with a result. -

    - -
    -
    - - - - -
    -

    - - public - - - - - WebInteraction<R> - - inWindow - (WindowReference window) -

    -
    -
    - - - -
    -
    - - - - -

    Causes this WebInteraction to have it's javascript evaluated in a particular DOM window. - - By default Javascript may be evaluated in the main window. However in an application which - uses frames, you may want to evaluate in another frame. -

    +

    + + + + + + +
    Parameters
    windowPicker + Atom +
    + + + + + + +
    Returns
    WebInteraction<R>
    -
    -
    -

    - - public - - - - - WebInteraction<E> - - perform - (Atom<E> atom) -

    -
    -
    - - - -
    -
    - - +
    +

    perform

    +
    +
    + + +
    +
    +WebInteraction<E> perform (Atom<E> atom)
    + + -

    Executes the provided atom within the current context (the combination of Window and Element + +

    Executes the provided atom within the current context (the combination of Window and Element References). This method blocks until the Atom returns. The result of the Atom's evaluation is used to create a new instance of WebInteraction which can be used to access the result of the Atom's evaluation. -

    +

    + + + + + + +
    Parameters
    atom + Atom +
    + + + + + + +
    Returns
    WebInteraction<E>
    -
    -
    -

    - - public - - - - - WebInteraction<R> - - reset - () -

    -
    -
    - - - -
    -
    - - +
    +

    reset

    +
    +
    + + +
    +
    +WebInteraction<R> reset ()
    + + -

    Removes the Element and Window references from this interaction. + +

    Removes the Element and Window references from this interaction. This is usually necessary when a prior action (for example a click) introduces a navigation that invalidates the ElementReference and WindowReference pointers. -

    +

    + + + + + + +
    Returns
    WebInteraction<R>
    -
    -
    -

    - - public - - - - - WebInteraction<R> - - withContextualElement - (Atom<ElementReference> elementPicker) -

    -
    -
    - - - -
    -
    - - +
    +

    withContextualElement

    +
    +
    + + +
    +
    +WebInteraction<R> withContextualElement (Atom<ElementReference> elementPicker)
    + + -

    Allows for contextually evaluating this WebInteraction with the selected element. + +

    Allows for contextually evaluating this WebInteraction with the selected element. Specifically the elementPicker atom will be evaluated with the CURRENTLY selected element to discover the new element to work against. @@ -1563,7 +1244,7 @@ From class <p>Plato</p> </div> </div> - + With code like this: @@ -1574,85 +1255,95 @@ From class .check(webMatches(getText(), containsString("Socrates"))); -

    +

    + + + + + + +
    Parameters
    elementPicker + Atom +
    + + + + + + +
    Returns
    WebInteraction<R>
    -
    -
    -

    - - public - - - - - WebInteraction<R> - - withElement - (ElementReference element) -

    -
    -
    - - - -
    -
    - - +
    +

    withElement

    +
    +
    + + +
    +
    +WebInteraction<R> withElement (ElementReference element)
    + + -

    Causes this WebInteraction to supply the given ElementReference to the Atom prior to + +

    Causes this WebInteraction to supply the given ElementReference to the Atom prior to evaluation. Calling this method resets any previously selected ElementReference. - -

    -
    -
    See Also
    -
    -
    -

    - - public - - - - - WebInteraction<R> - - withElement - (Atom<ElementReference> elementPicker) -

    -
    -
    - - - -
    -
    - - +
    +

    withElement

    +
    +
    + + +
    +
    +WebInteraction<R> withElement (Atom<ElementReference> elementPicker)
    + + -

    Causes this WebInteraction to supply the given ElementReference to the Atom prior to + +

    Causes this WebInteraction to supply the given ElementReference to the Atom prior to evaluation. - + This method accepts an Atom which it will evaluate on the current context's Window. This method blocks until the evaluation completes. @@ -1660,84 +1351,107 @@ From class Calling this method resets any previously selected ElementReference. If you want to evaluate the elementPicker in the context of the previously selected - ElementReference -

    -
    -
    See Also
    -
    -
    -

    - - public - - - - - WebInteraction<R> - - withNoTimeout - () -

    -
    -
    - - - -
    -
    - - +
    +

    withNoTimeout

    +
    +
    + + +
    +
    +WebInteraction<R> withNoTimeout ()
    + + -

    Disables all Timeouts on this WebInteraction. + +

    Disables all Timeouts on this WebInteraction. Javascript evaluation is performed asynchronously on the WebKit/Chromium thread. By default we wait a short while for the result to be delivered back to the test. -

    +

    + + + + + + +
    Returns
    WebInteraction<R>
    -
    -
    -

    - - public - - - - - WebInteraction<R> - - withTimeout - (long amount, TimeUnit unit) -

    -
    -
    - - - -
    -
    - - - - -

    Sets a specific timeout for this WebInteraction. -

    +
    +

    withTimeout

    +
    +
    + +
    +
    +WebInteraction<R> withTimeout (long amount, 
    +                TimeUnit unit)
    + + + + +

    Sets a specific timeout for this WebInteraction. +

    + + + + + + + + + + +
    Parameters
    amount + long +
    unit + TimeUnit +
    + + + + + + +
    Returns
    WebInteraction<R>
    +
    @@ -1749,193 +1463,29 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/sugar/Web.html b/docs/html/reference/android/support/test/espresso/web/sugar/Web.html index d495700d7c8d..8356e828bfc7 100644 --- a/docs/html/reference/android/support/test/espresso/web/sugar/Web.html +++ b/docs/html/reference/android/support/test/espresso/web/sugar/Web.html @@ -1,4 +1,3 @@ - @@ -93,482 +92,85 @@ - - - - - - -Web | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Web - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    Web

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    Web

    +

    + + public + + final + + class + Web + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.espresso.web.sugar.Web
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.espresso.web.sugar.Web +
    + + +

    - - - -
    - - -

    Class Overview

    -

    An Entry Point to work with WebViews on Android. +

    An Entry Point to work with WebViews on Android.

    Similar to onData, WebView interactions are actually composed of several ViewActions. However they need to be properly orchestrated and are quite verbose. Web and WebInteraction wrap this @@ -686,53 +279,36 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    - - - - - - - +
    Nested Classes
    - - - - - classWeb.WebInteraction<R>
    + + + + + + - - + + @@ -757,25 +333,23 @@ Summary: -

    Nested classes

    + + + + + class - Analogous to a ViewInteraction or a DataInteraction, a WebInteraction exposes a fluent API to + Web.WebInteraction<R> +

    Analogous to a ViewInteraction or a DataInteraction, a WebInteraction exposes a fluent API to the underlying WebView.  - - - + + +

    - - - - - -
    Public Constructors
    - - - - + + - - - + + + + + + +

    Public constructors

    - Web() -
    + + Web() + + +
    @@ -786,41 +360,54 @@ Summary: - - - - - - - - +
    Public Methods
    - - - - static - - WebInteraction<Void> - - onWebView() - -
    + - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - - - - static - - WebInteraction<Void> - - onWebView(Matcher<View> viewMatcher) - -
    + + + static + + + WebInteraction<Void> + + + onWebView() + + +
    + + + static + + + WebInteraction<Void> + + + onWebView(Matcher<View> viewMatcher) + + +
    @@ -832,207 +419,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1041,16 +697,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1068,39 +714,28 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - Web - () -

    -
    -
    - - - -
    -
    - - +
    +

    Web

    +
    +
    + + +
    +
    +Web ()
    + + -

    + +

    -
    @@ -1115,71 +750,72 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - WebInteraction<Void> - - onWebView - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    onWebView

    +
    +
    + +
    +
    +WebInteraction<Void> onWebView ()
    + + + + +

    + + + + + + +
    Returns
    WebInteraction<Void>
    +
    -
    -

    - - public - static - - - - WebInteraction<Void> - - onWebView - (Matcher<View> viewMatcher) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    onWebView

    +
    +
    + +
    +
    +WebInteraction<Void> onWebView (Matcher<View> viewMatcher)
    + + + + +

    + + + + + + +
    Parameters
    viewMatcher + Matcher +
    + + + + + + +
    Returns
    WebInteraction<Void>
    +
    @@ -1191,193 +827,29 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/sugar/package-summary.html b/docs/html/reference/android/support/test/espresso/web/sugar/package-summary.html index a5567f7ac52c..9a2b587e934b 100644 --- a/docs/html/reference/android/support/test/espresso/web/sugar/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/web/sugar/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,733 +92,137 @@ - - - - - - -android.support.test.espresso.web.sugar | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.web.sugar - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.web.sugar

    -
    - -
    - -
    - - - +

    android.support.test.espresso.web.sugar

    + + +

    Classes

    -
    - - + + - + - + - - + + - + + + +
    WebWeb An Entry Point to work with WebViews on Android.  - - + +
    Web.WebInteraction<R>Web.WebInteraction<R> Analogous to a ViewInteraction or a DataInteraction, a WebInteraction exposes a fluent API to the underlying WebView.  - - + +
    + -
    -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + + + + + + + + +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/webdriver/DriverAtoms.html b/docs/html/reference/android/support/test/espresso/web/webdriver/DriverAtoms.html index b2dedb592e22..2fe6ce119613 100644 --- a/docs/html/reference/android/support/test/espresso/web/webdriver/DriverAtoms.html +++ b/docs/html/reference/android/support/test/espresso/web/webdriver/DriverAtoms.html @@ -1,1197 +1,882 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -DriverAtoms | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    - -
    - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - - final - - class -

    DriverAtoms

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳android.support.test.espresso.web.webdriver.DriverAtoms
    - - - - - - - -
    - - -

    Class Overview

    -

    A collection of Javascript Atoms from the WebDriver project. -

    - - - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Methods
    - - - - static - - Atom<Evaluation> - - clearElement() - -
    - Clears content from an editable element. - - - -
    - -
    - - - - static - - Atom<ElementReference> - - findElement(Locator locator, String value) - -
    - Finds an element using the provided locator strategy. - - - -
    - -
    - - - - static - Atom<List<ElementReference>> - - findMultipleElements(Locator locator, String value) -
    - Finds multiple elements given a locator strategy. -
    -
    - static - Atom<String> - - getText() -
    - Returns the visible text beneath a given DOM element. -
    -
    - static - Atom<ElementReference> - - selectActiveElement() -
    - Finds the currently active element in the document. -
    -
    - static - Atom<WindowReference> - - selectFrameByIdOrName(String idOrName, WindowReference root) -
    - Selects a subframe of the given window by it's name or id. -
    -
    - static - Atom<WindowReference> - - selectFrameByIdOrName(String idOrName) -
    - Selects a subframe of the current window by it's name or id. -
    -
    - static - Atom<WindowReference> - - selectFrameByIndex(int index, WindowReference root) -
    - Selects a subframe of the given window by it's index. -
    -
    - static - Atom<WindowReference> - - selectFrameByIndex(int index) -
    - Selects a subframe of the currently selected window by it's index. -
    -
    - static - Atom<Evaluation> - - webClick() -
    - Simulates the javascript events to click on a particular element. -
    -
    - static - Atom<Evaluation> - - webKeys(String text) -
    - Simulates javascript key events sent to a certain element. -
    -
    - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class + + + - java.lang.Object + + + + -
    - - - - - - - - - - - @@ -1235,370 +910,417 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Atom<Evaluation> - - clearElement - () -

    -
    -
    - - - -
    -
    - - +
    +

    clearElement

    +
    +
    + + +
    +
    +Atom<Evaluation> clearElement ()
    + + -

    Clears content from an editable element. -

    + +

    Clears content from an editable element. +

    + + + + + + +
    Returns
    Atom<Evaluation>
    -
    -
    -

    - - public - static - - - - Atom<ElementReference> - - findElement - (Locator locator, String value) -

    -
    -
    - - - -
    -
    - - - - -

    Finds an element using the provided locator strategy. -

    +
    +

    findElement

    +
    +
    + +
    +
    +Atom<ElementReference> findElement (Locator locator, 
    +                String value)
    + + + + +

    Finds an element using the provided locator strategy. +

    + + + + + + + + + + +
    Parameters
    locator + Locator +
    value + String +
    + + + + + + +
    Returns
    Atom<ElementReference>
    +
    -
    -

    - - public - static - - - - Atom<List<ElementReference>> - - findMultipleElements - (Locator locator, String value) -

    -
    -
    - - - -
    -
    - - - - -

    Finds multiple elements given a locator strategy. -

    +
    +

    findMultipleElements

    +
    +
    + +
    +
    +Atom<List<ElementReference>> findMultipleElements (Locator locator, 
    +                String value)
    + + + + +

    Finds multiple elements given a locator strategy. +

    + + + + + + + + + + +
    Parameters
    locator + Locator +
    value + String +
    + + + + + + +
    Returns
    Atom<List<ElementReference>>
    +
    -
    -

    - - public - static - - - - Atom<String> - - getText - () -

    -
    -
    - - - -
    -
    - - +
    +

    getText

    +
    +
    + + +
    +
    +Atom<String> getText ()
    + + -

    Returns the visible text beneath a given DOM element. -

    + +

    Returns the visible text beneath a given DOM element. +

    + + + + + + +
    Returns
    Atom<String>
    -
    -
    -

    - - public - static - - - - Atom<ElementReference> - - selectActiveElement - () -

    -
    -
    - - - -
    -
    - - - - -

    Finds the currently active element in the document. -

    +
    +

    selectActiveElement

    +
    +
    + +
    -
    - - - - -
    -

    - - public - static - - - - Atom<WindowReference> - - selectFrameByIdOrName - (String idOrName, WindowReference root) -

    -
    -
    - - - -
    -
    - - +
    +Atom<ElementReference> selectActiveElement ()
    + + + +

    Finds the currently active element in the document. +

    + + + + + + +
    Returns
    Atom<ElementReference>
    -

    Selects a subframe of the given window by it's name or id. -

    - -
    -
    -

    - - public - static - - - - Atom<WindowReference> - - selectFrameByIdOrName - (String idOrName) -

    -
    -
    - - - -
    -
    - - - - -

    Selects a subframe of the current window by it's name or id. -

    +
    +

    selectFrameByIdOrName

    +
    +
    + +
    -
    - +
    +Atom<WindowReference> selectFrameByIdOrName (String idOrName)
    + + - - -
    -

    - - public - static - - - - Atom<WindowReference> - - selectFrameByIndex - (int index, WindowReference root) -

    -
    -
    - - - -
    -
    + +

    Selects a subframe of the current window by it's name or id. +

    + + + + + + +
    Parameters
    idOrName + String +
    + + + + + + +
    Returns
    Atom<WindowReference>
    +
    + -

    Selects a subframe of the given window by it's index. -

    +
    +

    selectFrameByIdOrName

    +
    +
    + +
    +
    +Atom<WindowReference> selectFrameByIdOrName (String idOrName, 
    +                WindowReference root)
    + + + + +

    Selects a subframe of the given window by it's name or id. +

    + + + + + + + + + + +
    Parameters
    idOrName + String +
    root + WindowReference +
    + + + + + + +
    Returns
    Atom<WindowReference>
    +
    -
    -

    - - public - static - - - - Atom<WindowReference> - - selectFrameByIndex - (int index) -

    -
    -
    - +
    +

    selectFrameByIndex

    +
    +
    + + +
    +
    +Atom<WindowReference> selectFrameByIndex (int index)
    + + -
    -
    + +

    Selects a subframe of the currently selected window by it's index. +

    + + + + + + +
    Parameters
    index + int +
    + + + + + + +
    Returns
    Atom<WindowReference>
    +
    + -

    Selects a subframe of the currently selected window by it's index. -

    +
    +

    selectFrameByIndex

    +
    +
    + +
    +
    +Atom<WindowReference> selectFrameByIndex (int index, 
    +                WindowReference root)
    + + + + +

    Selects a subframe of the given window by it's index. +

    + + + + + + + + + + +
    Parameters
    index + int +
    root + WindowReference +
    + + + + + + +
    Returns
    Atom<WindowReference>
    +
    -
    -

    - - public - static - - - - Atom<Evaluation> - - webClick - () -

    -
    -
    - - - -
    -
    - - +
    +

    webClick

    +
    +
    + + +
    +
    +Atom<Evaluation> webClick ()
    + + -

    Simulates the javascript events to click on a particular element. -

    + +

    Simulates the javascript events to click on a particular element. +

    + + + + + + +
    Returns
    Atom<Evaluation>
    -
    -
    -

    - - public - static - - - - Atom<Evaluation> - - webKeys - (String text) -

    -
    -
    - - - -
    -
    - - +
    +

    webKeys

    +
    +
    + + +
    +
    +Atom<Evaluation> webKeys (String text)
    + + -

    Simulates javascript key events sent to a certain element. -

    + +

    Simulates javascript key events sent to a certain element. +

    + + + + + + +
    Parameters
    text + String +
    + + + + + + +
    Returns
    Atom<Evaluation>
    -
    @@ -1610,193 +1332,33 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/webdriver/Locator.html b/docs/html/reference/android/support/test/espresso/web/webdriver/Locator.html index e9e033a6638f..5afe86d46426 100644 --- a/docs/html/reference/android/support/test/espresso/web/webdriver/Locator.html +++ b/docs/html/reference/android/support/test/espresso/web/webdriver/Locator.html @@ -1,1332 +1,1065 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Locator | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - - final - - enum -

    Locator

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.espresso.web.webdriver.Locator
    - - - - - - - -
    - - -

    Class Overview

    -

    Valid WebDriver locator types. -

    - - - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Enum Values
    Locator CLASS_NAME  -   - - - -
    Locator CSS_SELECTOR  -   - - - -
    Locator ID  -   - - - -
    Locator LINK_TEXT  -   - - - -
    Locator NAME  -   - - - -
    Locator PARTIAL_LINK_TEXT  -   - - - -
    Locator TAG_NAME  -   - - - -
    Locator XPATH  -   - - - -
    - - - - - - - - - - -
    Public Methods
    - String - - getType() -
    - static - Locator - - valueOf(String name) -
    - final - static - Locator[] - - values() -
    - - - - - - - - - - - - + + + - - - - - @@ -1336,41 +1069,51 @@ From class - @@ -1379,16 +1122,6 @@ From interface
    - [Expand] -
    Inherited Methods
    - -From class - java.lang.Enum -
    - - -
    -
    - -From class + - java.lang.Object + -
    - -
    - wait(long arg0, int arg1) -
    + + + - final + + - void - - + +

    Inherited methods

    + From +class + + + java.lang.Enum + + +
    + + +
    +
    - wait(long arg0) -
    -
    + From +class + + + java.lang.Object + + +
    + +
    - -From interface - - java.lang.Comparable + + From +interface + + + java.lang.Comparable + +
    -
    - - - - - - - - - @@ -1397,255 +1130,191 @@ From interface -

    Enum Values

    +

    Enum values

    -
    -

    - - public - static - final - Locator - - CLASS_NAME -

    -
    - +
    +

    CLASS_NAME

    +
    + + + +
    +
    +Locator CLASS_NAME
    + + + +

    -
    -
    - - - - -

    - - -
    +
    -
    -

    - - public - static - final - Locator - - CSS_SELECTOR -

    -
    - - - - -
    -
    - - +
    +

    CSS_SELECTOR

    +
    + + + +
    +
    +Locator CSS_SELECTOR
    + + -

    - + +

    -
    +
    -
    -

    - - public - static - final - Locator - - ID -

    -
    - - - +
    +

    ID

    +
    + + + -
    -
    - - - - -

    +
    +
    +Locator ID
    + + + +

    -
    +
    -
    -

    - - public - static - final - Locator - - LINK_TEXT -

    -
    - - - - -
    -
    +
    +

    LINK_TEXT

    +
    + + + +
    +
    +Locator LINK_TEXT
    + + + +

    - -

    - - -
    +
    -
    -

    - - public - static - final - Locator - - NAME -

    -
    - - - - -
    -
    - +
    +

    NAME

    +
    + + + +
    +
    +Locator NAME
    + + + +

    -

    - - -
    +
    -
    -

    - - public - static - final - Locator - - PARTIAL_LINK_TEXT -

    -
    - - +
    +

    PARTIAL_LINK_TEXT

    +
    + + + +
    +
    +Locator PARTIAL_LINK_TEXT
    + + -
    -
    - - - - -

    - + +

    -
    +
    -
    -

    - - public - static - final - Locator - - TAG_NAME -

    -
    - - - - -
    -
    - - - +
    +

    TAG_NAME

    +
    + + + -

    +
    +
    +Locator TAG_NAME
    + + + +

    -
    +
    -
    -

    - - public - static - final - Locator - - XPATH -

    -
    - - - - -
    -
    +
    +

    XPATH

    +
    + + + +
    +
    +Locator XPATH
    + + + +

    - -

    - - -
    +
    @@ -1669,103 +1338,100 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - String - - getType - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    getType

    +
    +
    + +
    +
    +String getType ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    -
    -

    - - public - static - - - - Locator - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +Locator valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    Locator
    +
    -
    -

    - - public - static - final - - - Locator[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +Locator[] values ()
    + + + + +

    + + + + + + +
    Returns
    Locator[]
    +
    @@ -1777,193 +1443,33 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/espresso/web/webdriver/package-summary.html b/docs/html/reference/android/support/test/espresso/web/webdriver/package-summary.html index 5f93e590d9bb..2938e94af9da 100644 --- a/docs/html/reference/android/support/test/espresso/web/webdriver/package-summary.html +++ b/docs/html/reference/android/support/test/espresso/web/webdriver/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,747 +92,149 @@ - - - - - - -android.support.test.espresso.web.webdriver | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.espresso.web.webdriver - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.espresso.web.webdriver

    -
    - -
    - -
    - - - +

    android.support.test.espresso.web.webdriver

    + + +

    Classes

    -
    - - + + - + - + - - + +
    DriverAtomsDriverAtoms A collection of Javascript Atoms from the WebDriver project.  - - + +
    -
    - - + +

    Enums

    -
    - - + + - + - + + + +
    LocatorLocator Valid WebDriver locator types.  - - + +
    + + + + -
    -
    - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + +
    +
    + + + +
    + diff --git a/docs/html/reference/android/support/test/filters/FlakyTest.html b/docs/html/reference/android/support/test/filters/FlakyTest.html index 498f8dd856e6..81dc26f50b1a 100644 --- a/docs/html/reference/android/support/test/filters/FlakyTest.html +++ b/docs/html/reference/android/support/test/filters/FlakyTest.html @@ -1,4 +1,3 @@ - @@ -93,483 +92,85 @@ - - - - - - -FlakyTest | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - + + -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - abstract - @interface -

    FlakyTest

    - - - - - +

    FlakyTest

    +

    + + public + + + abstract + @interface + FlakyTest + +
    + + + + + implements - + Annotation + + + + +

    - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.filters.FlakyTest
    android.support.test.filters.FlakyTest +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Designates a test as being flaky (non-deterministic). +

    Designates a test as being flaky (non-deterministic).

    Can then be used to filter tests on execution using -e annotation or -e notAnnotation as desired. @@ -663,27 +252,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -717,95 +288,122 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -814,16 +412,6 @@ From interface

    Inherited methods

    - -From interface - - java.lang.annotation.Annotation + + From +interface + + + java.lang.annotation.Annotation + +
    -
    - - - - - - - - - @@ -856,193 +444,34 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/filters/LargeTest.html b/docs/html/reference/android/support/test/filters/LargeTest.html new file mode 100644 index 000000000000..f0143c671b70 --- /dev/null +++ b/docs/html/reference/android/support/test/filters/LargeTest.html @@ -0,0 +1,491 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +LargeTest + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + +
    + +
    + + + +

    LargeTest

    +

    + + public + + + abstract + @interface + LargeTest + +
    + + + + + + implements + + Annotation + + + + + +

    + + + + + + + + +
    android.support.test.filters.LargeTest +
    + + + + +

    + + +

    Annotation to assign a large test size qualifier to a test. This annotation can be used at a + method or class level. +

    + Test size qualifiers are a great way to structure test code and are used to assign a test to a + test suite of similar run time. +

    + Execution time: >1000ms +

    + Large tests should be focused on testing integration of all application components. These tests + fully participate in the system and may make use of all resources such as databases, file systems + and network. As a rule of thumb most functional UI tests are large tests. +

    + Note: + This class replaces the deprecated Android platform size qualifier + ERROR(/android.test.suitebuilder.annotation.LargeTest) and is the recommended way to annotate + tests written with the Android Testing Support Library. +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +interface + + + java.lang.annotation.Annotation + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + + + +
    + + + + + diff --git a/docs/html/reference/android/support/test/filters/MediumTest.html b/docs/html/reference/android/support/test/filters/MediumTest.html new file mode 100644 index 000000000000..60abfe5e69f2 --- /dev/null +++ b/docs/html/reference/android/support/test/filters/MediumTest.html @@ -0,0 +1,492 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +MediumTest + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + +
    + +
    + + + +

    MediumTest

    +

    + + public + + + abstract + @interface + MediumTest + +
    + + + + + + implements + + Annotation + + + + + +

    + + + + + + + + +
    android.support.test.filters.MediumTest +
    + + + + +

    + + +

    Annotation to assign a medium test size qualifier to a test. This annotation can be used at a + method or class level. +

    + Test size qualifiers are a great way to structure test code and are used to assign a test to a + test suite of similar run time. +

    + Execution time: <1000ms +

    + Medium tests should be focused on a very limited subset of components or a single component. + Resource access to the file system through well defined interfaces like databases, + ContentProviders, or Context is permitted. Network access should be restricted, (long-running) + blocking operations should be avoided and use mock objects instead. +

    + Note: + This class replaces the deprecated Android platform size qualifier + ERROR(/android.test.suitebuilder.annotation.MediumTest) and is the recommended way to annotate + tests written with the Android Testing Support Library. +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +interface + + + java.lang.annotation.Annotation + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + + + +
    + + + + + diff --git a/docs/html/reference/android/support/test/filters/RequiresDevice.html b/docs/html/reference/android/support/test/filters/RequiresDevice.html index b88bebefe5df..1432fdcea8c9 100644 --- a/docs/html/reference/android/support/test/filters/RequiresDevice.html +++ b/docs/html/reference/android/support/test/filters/RequiresDevice.html @@ -1,4 +1,3 @@ - @@ -93,483 +92,85 @@ - - - - - - -RequiresDevice | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - + + -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - abstract - @interface -

    RequiresDevice

    - - - - - +

    RequiresDevice

    +

    + + public + + + abstract + @interface + RequiresDevice + +
    + + + + + implements - + Annotation + + + + +

    - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.filters.RequiresDevice
    android.support.test.filters.RequiresDevice +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Indicates that a specific test should not be run on emulator. +

    Indicates that a specific test should not be run on emulator.

    It will be executed only if the test is running on the physical android device.

    @@ -662,27 +251,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -716,95 +287,122 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -813,16 +411,6 @@ From interface

    Inherited methods

    - -From interface - - java.lang.annotation.Annotation + + From +interface + + + java.lang.annotation.Annotation + +
    -
    - - - - - - - - - @@ -855,193 +443,34 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/filters/SdkSuppress.html b/docs/html/reference/android/support/test/filters/SdkSuppress.html index e8661dc2c899..7e7866429551 100644 --- a/docs/html/reference/android/support/test/filters/SdkSuppress.html +++ b/docs/html/reference/android/support/test/filters/SdkSuppress.html @@ -1,4 +1,3 @@ - @@ -93,483 +92,85 @@ - - - - - - -SdkSuppress | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - + + -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - abstract - @interface -

    SdkSuppress

    - - - - - +

    SdkSuppress

    +

    + + public + + + abstract + @interface + SdkSuppress + +
    + + + + + implements - + Annotation + + + + +

    - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.filters.SdkSuppress
    android.support.test.filters.SdkSuppress +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Indicates that a specific test or class requires a minimum API Level to execute. +

    Indicates that a specific test or class requires a minimum API Level to execute.

    Test(s) will be skipped when executed on android platforms less than specified level.

    @@ -662,27 +251,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -716,95 +287,122 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -813,16 +411,6 @@ From interface

    Inherited methods

    - -From interface - - java.lang.annotation.Annotation + + From +interface + + + java.lang.annotation.Annotation + +
    -
    - - - - - - - - - @@ -855,193 +443,34 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/filters/SmallTest.html b/docs/html/reference/android/support/test/filters/SmallTest.html new file mode 100644 index 000000000000..375b619af4e0 --- /dev/null +++ b/docs/html/reference/android/support/test/filters/SmallTest.html @@ -0,0 +1,493 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +SmallTest + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + +
    + +
    + + + +

    SmallTest

    +

    + + public + + + abstract + @interface + SmallTest + +
    + + + + + + implements + + Annotation + + + + + +

    + + + + + + + + +
    android.support.test.filters.SmallTest +
    + + + + +

    + + +

    Annotation to assign a small test size qualifier to a test. This annotation can be used at a + method or class level. +

    + Test size qualifiers are a great way to structure test code and are used to assign a test to a + test suite of similar run time. +

    + Execution time: <200ms +

    + Small tests should be run very frequently. Focused on units of code to verify specific logical + conditions. These tests should runs in an isolated environment and use mock objects for external + dependencies. Resource access (such as file system, network, or databases) are not permitted. + Tests that interact with hardware, make binder calls, or that facilitate android instrumentation + should not use this annotation. +

    + Note: + This class replaces the deprecated Android platform size qualifier + ERROR(/android.test.suitebuilder.annotation.SmallTest) and is the recommended way to annotate + tests written with the Android Testing Support Library. +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +interface + + + java.lang.annotation.Annotation + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + + + +
    + + + + + diff --git a/docs/html/reference/android/support/test/filters/Suppress.html b/docs/html/reference/android/support/test/filters/Suppress.html new file mode 100644 index 000000000000..3c48abc113f4 --- /dev/null +++ b/docs/html/reference/android/support/test/filters/Suppress.html @@ -0,0 +1,483 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Suppress + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + +
    + +
    + + + +

    Suppress

    +

    + + public + + + abstract + @interface + Suppress + +
    + + + + + + implements + + Annotation + + + + + +

    + + + + + + + + +
    android.support.test.filters.Suppress +
    + + + + +

    + + +

    Use this annotation on test classes or test methods that should not be included in a test + suite. If the annotation appears on the class then no tests in that class will be included. If + the annotation appears only on a test method then only that method will be excluded. +

    + Note: + This class replaces the deprecated Android platform annotation + ERROR(/android.test.suitebuilder.annotation.Suppress) and is the recommended way to suppress + tests written with the Android Testing Support Library. +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +interface + + + java.lang.annotation.Annotation + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + + + +
    + + + + + diff --git a/docs/html/reference/android/support/test/filters/package-summary.html b/docs/html/reference/android/support/test/filters/package-summary.html index 2ccc69aa9245..c32f907c6e45 100644 --- a/docs/html/reference/android/support/test/filters/package-summary.html +++ b/docs/html/reference/android/support/test/filters/package-summary.html @@ -1,6 +1,3 @@ - - - @@ -92,745 +89,200 @@ - - - - - - - -android.support.test.filters | Android Developers - - - - - - - - - - - - - + + + + + + + - + - + + - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - + + + -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.filters

    -
    - -
    - -
    - +

    android.support.test.filters

    +

    Annotations

    -
    - - + + - + - + + + + + + + + + + + + + + + - + - - + + - + + + + + + + + + + + + + + +
    FlakyTestFlakyTest Designates a test as being flaky (non-deterministic).  - - + +
    LargeTest + Annotation to assign a large test size qualifier to a test.  + + +
    MediumTest + Annotation to assign a medium test size qualifier to a test.  + + +
    RequiresDeviceRequiresDevice Indicates that a specific test should not be run on emulator.  - - + +
    SdkSuppressSdkSuppress Indicates that a specific test or class requires a minimum API Level to execute.  - - + +
    SmallTest + Annotation to assign a small test size qualifier to a test.  + + +
    Suppress + Use this annotation on test classes or test methods that should not be included in a test + suite.  + + +
    -
    - - - - - + + + + + + - -
    - -
    - -
    - - - -
    - -
    -
    - +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/jank/GfxMonitor.html b/docs/html/reference/android/support/test/jank/GfxMonitor.html index f0b531fca6c9..c78e81c025de 100644 --- a/docs/html/reference/android/support/test/jank/GfxMonitor.html +++ b/docs/html/reference/android/support/test/jank/GfxMonitor.html @@ -1,4 +1,3 @@ - @@ -93,487 +92,85 @@ - - - - - - -GfxMonitor | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +GfxMonitor - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - abstract - @interface -

    GfxMonitor

    - - - - - +

    GfxMonitor

    +

    + + public + + + abstract + @interface + GfxMonitor + +
    + + + + + implements - + Annotation + + + + +

    - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.jank.GfxMonitor
    android.support.test.jank.GfxMonitor +
    + + +

    +

    Annotation used to configure a gfx monitor.

    -
    - - -

    Class Overview

    -

    Annotation used to configure a gfx monitor.

    - - - - - -
    - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -701,226 +268,227 @@ Summary: - - - - - - - -
    Constants
    StringKEY_AVG_FRAME_TIME_90TH_PERCENTILE - - - - + + + + + + + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - - - - - + + - - + +

    Constants

    String + KEY_AVG_FRAME_TIME_90TH_PERCENTILE +

    + + +

    StringKEY_AVG_FRAME_TIME_95TH_PERCENTILE - - - - + + +
    String + KEY_AVG_FRAME_TIME_95TH_PERCENTILE +

    + + +

    StringKEY_AVG_FRAME_TIME_99TH_PERCENTILE - - - - + + +
    String + KEY_AVG_FRAME_TIME_99TH_PERCENTILE +

    + + +

    StringKEY_AVG_HIGH_INPUT_LATENCY - - - - + + +
    String + KEY_AVG_HIGH_INPUT_LATENCY +

    + + +

    StringKEY_AVG_MISSED_VSYNC - - - - + + +
    String + KEY_AVG_MISSED_VSYNC +

    + + +

    StringKEY_AVG_NUM_JANKY - - - - + + +
    String + KEY_AVG_NUM_JANKY +

    + + +

    StringKEY_AVG_SLOW_BITMAP_UPLOADS - - - - + + +
    String + KEY_AVG_SLOW_BITMAP_UPLOADS +

    + + +

    StringKEY_AVG_SLOW_DRAW - - - - + + +
    String + KEY_AVG_SLOW_DRAW +

    + + +

    StringKEY_AVG_SLOW_UI_THREAD - - - - + + +
    String + KEY_AVG_SLOW_UI_THREAD +

    + + +

    StringKEY_MAX_FRAME_TIME_90TH_PERCENTILE - - - - + + +
    String + KEY_MAX_FRAME_TIME_90TH_PERCENTILE +

    + + +

    StringKEY_MAX_FRAME_TIME_95TH_PERCENTILE - - - - + + +
    String + KEY_MAX_FRAME_TIME_95TH_PERCENTILE +

    + + +

    StringKEY_MAX_FRAME_TIME_99TH_PERCENTILE - - - - + + +
    String + KEY_MAX_FRAME_TIME_99TH_PERCENTILE +

    + + +

    StringKEY_MAX_HIGH_INPUT_LATENCY - - - - + + +
    String + KEY_MAX_HIGH_INPUT_LATENCY +

    + + +

    StringKEY_MAX_MISSED_VSYNC - - - - + + +
    String + KEY_MAX_MISSED_VSYNC +

    + + +

    StringKEY_MAX_NUM_JANKY - - - - + + +
    String + KEY_MAX_NUM_JANKY +

    + + +

    StringKEY_MAX_SLOW_BITMAP_UPLOADS - - - - + + +
    String + KEY_MAX_SLOW_BITMAP_UPLOADS +

    + + +

    StringKEY_MAX_SLOW_DRAW - - - - + + +
    String + KEY_MAX_SLOW_DRAW +

    + + +

    StringKEY_MAX_SLOW_UI_THREAD - - - - + + +
    String + KEY_MAX_SLOW_UI_THREAD +

    + + +

    @@ -945,95 +513,122 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1042,16 +637,6 @@ From interface

    Inherited methods

    - -From interface - - java.lang.annotation.Annotation + + From +interface + + + java.lang.annotation.Annotation + +
    - - - - - - - - - - @@ -1063,727 +648,511 @@ From interface -

    Constants

    +

    Constants

    -
    -

    - - public - static - final - String - - KEY_AVG_FRAME_TIME_90TH_PERCENTILE -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-avg-frame-time-90" - - -
    +
    +

    KEY_AVG_FRAME_TIME_90TH_PERCENTILE

    +
    + + +
    +
    +String KEY_AVG_FRAME_TIME_90TH_PERCENTILE
    + + + + +

    + + +

    Constant Value: + + "gfx-avg-frame-time-90" + +

    -
    -

    - - public - static - final - String - - KEY_AVG_FRAME_TIME_95TH_PERCENTILE -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-avg-frame-time-95" - - -
    +
    +

    KEY_AVG_FRAME_TIME_95TH_PERCENTILE

    +
    + + +
    +
    +String KEY_AVG_FRAME_TIME_95TH_PERCENTILE
    + + + + +

    + + +

    Constant Value: + + "gfx-avg-frame-time-95" + +

    -
    -

    - - public - static - final - String - - KEY_AVG_FRAME_TIME_99TH_PERCENTILE -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-avg-frame-time-99" - - -
    +
    +

    KEY_AVG_FRAME_TIME_99TH_PERCENTILE

    +
    + + +
    +
    +String KEY_AVG_FRAME_TIME_99TH_PERCENTILE
    + + + + +

    + + +

    Constant Value: + + "gfx-avg-frame-time-99" + +

    -
    -

    - - public - static - final - String - - KEY_AVG_HIGH_INPUT_LATENCY -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-avg-high-input-latency" - - -
    +
    +

    KEY_AVG_HIGH_INPUT_LATENCY

    +
    + + +
    +
    +String KEY_AVG_HIGH_INPUT_LATENCY
    + + + + +

    + + +

    Constant Value: + + "gfx-avg-high-input-latency" + +

    -
    -

    - - public - static - final - String - - KEY_AVG_MISSED_VSYNC -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-avg-missed-vsync" - - -
    +
    +

    KEY_AVG_MISSED_VSYNC

    +
    + + +
    +
    +String KEY_AVG_MISSED_VSYNC
    + + + + +

    + + +

    Constant Value: + + "gfx-avg-missed-vsync" + +

    -
    -

    - - public - static - final - String - - KEY_AVG_NUM_JANKY -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-avg-jank" - - -
    +
    +

    KEY_AVG_NUM_JANKY

    +
    + + +
    +
    +String KEY_AVG_NUM_JANKY
    + + + + +

    + + +

    Constant Value: + + "gfx-avg-jank" + +

    -
    -

    - - public - static - final - String - - KEY_AVG_SLOW_BITMAP_UPLOADS -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-avg-slow-bitmap-uploads" - - -
    +
    +

    KEY_AVG_SLOW_BITMAP_UPLOADS

    +
    + + +
    +
    +String KEY_AVG_SLOW_BITMAP_UPLOADS
    + + + + +

    + + +

    Constant Value: + + "gfx-avg-slow-bitmap-uploads" + +

    -
    -

    - - public - static - final - String - - KEY_AVG_SLOW_DRAW -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-avg-slow-draw" - - -
    +
    +

    KEY_AVG_SLOW_DRAW

    +
    + + +
    +
    +String KEY_AVG_SLOW_DRAW
    + + + + +

    + + +

    Constant Value: + + "gfx-avg-slow-draw" + +

    -
    -

    - - public - static - final - String - - KEY_AVG_SLOW_UI_THREAD -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-avg-slow-ui-thread" - - -
    +
    +

    KEY_AVG_SLOW_UI_THREAD

    +
    + + +
    +
    +String KEY_AVG_SLOW_UI_THREAD
    + + + + +

    + + +

    Constant Value: + + "gfx-avg-slow-ui-thread" + +

    -
    -

    - - public - static - final - String - - KEY_MAX_FRAME_TIME_90TH_PERCENTILE -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-max-frame-time-90" - - -
    +
    +

    KEY_MAX_FRAME_TIME_90TH_PERCENTILE

    +
    + + +
    +
    +String KEY_MAX_FRAME_TIME_90TH_PERCENTILE
    + + + + +

    + + +

    Constant Value: + + "gfx-max-frame-time-90" + +

    -
    -

    - - public - static - final - String - - KEY_MAX_FRAME_TIME_95TH_PERCENTILE -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-max-frame-time-95" - - -
    +
    +

    KEY_MAX_FRAME_TIME_95TH_PERCENTILE

    +
    + + +
    +
    +String KEY_MAX_FRAME_TIME_95TH_PERCENTILE
    + + + + +

    + + +

    Constant Value: + + "gfx-max-frame-time-95" + +

    -
    -

    - - public - static - final - String - - KEY_MAX_FRAME_TIME_99TH_PERCENTILE -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-max-frame-time-99" - - -
    +
    +

    KEY_MAX_FRAME_TIME_99TH_PERCENTILE

    +
    + + +
    +
    +String KEY_MAX_FRAME_TIME_99TH_PERCENTILE
    + + + + +

    + + +

    Constant Value: + + "gfx-max-frame-time-99" + +

    -
    -

    - - public - static - final - String - - KEY_MAX_HIGH_INPUT_LATENCY -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-max-high-input-latency" - - -
    +
    +

    KEY_MAX_HIGH_INPUT_LATENCY

    +
    + + +
    +
    +String KEY_MAX_HIGH_INPUT_LATENCY
    + + + + +

    + + +

    Constant Value: + + "gfx-max-high-input-latency" + +

    -
    -

    - - public - static - final - String - - KEY_MAX_MISSED_VSYNC -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-max-missed-vsync" - - -
    +
    +

    KEY_MAX_MISSED_VSYNC

    +
    + + +
    +
    +String KEY_MAX_MISSED_VSYNC
    + + + + +

    + + +

    Constant Value: + + "gfx-max-missed-vsync" + +

    -
    -

    - - public - static - final - String - - KEY_MAX_NUM_JANKY -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-max-jank" - - -
    +
    +

    KEY_MAX_NUM_JANKY

    +
    + + +
    +
    +String KEY_MAX_NUM_JANKY
    + + + + +

    + + +

    Constant Value: + + "gfx-max-jank" + +

    -
    -

    - - public - static - final - String - - KEY_MAX_SLOW_BITMAP_UPLOADS -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-max-slow-bitmap-uploads" - - -
    +
    +

    KEY_MAX_SLOW_BITMAP_UPLOADS

    +
    + + +
    +
    +String KEY_MAX_SLOW_BITMAP_UPLOADS
    + + + + +

    + + +

    Constant Value: + + "gfx-max-slow-bitmap-uploads" + +

    -
    -

    - - public - static - final - String - - KEY_MAX_SLOW_DRAW -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-max-slow-draw" - - -
    +
    +

    KEY_MAX_SLOW_DRAW

    +
    + + +
    +
    +String KEY_MAX_SLOW_DRAW
    + + + + +

    + + +

    Constant Value: + + "gfx-max-slow-draw" + +

    -
    -

    - - public - static - final - String - - KEY_MAX_SLOW_UI_THREAD -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - "gfx-max-slow-ui-thread" - - -
    +
    +

    KEY_MAX_SLOW_UI_THREAD

    +
    + + +
    +
    +String KEY_MAX_SLOW_UI_THREAD
    + + + + +

    + + +

    Constant Value: + + "gfx-max-slow-ui-thread" + +

    @@ -1811,193 +1180,40 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/jank/IMonitor.html b/docs/html/reference/android/support/test/jank/IMonitor.html new file mode 100644 index 000000000000..c7463386b9dd --- /dev/null +++ b/docs/html/reference/android/support/test/jank/IMonitor.html @@ -0,0 +1,519 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +IMonitor + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + +
    + +
    + + + +

    IMonitor

    +

    + + public + + + + interface + IMonitor + +
    + + + + + + + + +

    + + + + + + + + +
    android.support.test.jank.IMonitor +
    + + + + +

    + + +

    An interface used to define a class that monitors test methods and collects metrics. +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + abstract + + + + + Bundle + + + getMetrics() + + +

    Get the summary results accross all iterations. + + +

    + +
    + abstract + + + + + void + + + startIteration() + + +

    Begin monitoring a test method. + + +

    + +
    + abstract + + + + + Bundle + + + stopIteration() + + +

    Stop monitoring a test method and return intermediate results for this iteration. + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    getMetrics

    +
    +
    + + + +
    +
    +Bundle getMetrics ()
    + + + + +

    Get the summary results accross all iterations. +

    + + + + + + +
    Returns
    Bundle
    + +
    + + + + +
    +

    startIteration

    +
    +
    + + + +
    +
    +void startIteration ()
    + + + + +

    Begin monitoring a test method. +

    + + + + + + +
    Throws
    Throwable
    + + +
    + + + + +
    +

    stopIteration

    +
    +
    + + + +
    +
    +Bundle stopIteration ()
    + + + + +

    Stop monitoring a test method and return intermediate results for this iteration.

    + + + + + + +
    Returns
    BundleA Bundle of test results. +
    + + + + + + +
    Throws
    Throwable
    + + +
    + + + + + + + + + + + +
    + + + +
    + + + +
    + + + + + diff --git a/docs/html/reference/android/support/test/jank/IMonitorFactory.html b/docs/html/reference/android/support/test/jank/IMonitorFactory.html new file mode 100644 index 000000000000..767d23e2fece --- /dev/null +++ b/docs/html/reference/android/support/test/jank/IMonitorFactory.html @@ -0,0 +1,416 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +IMonitorFactory + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + +
    + +
    + + + +

    IMonitorFactory

    +

    + + public + + + + interface + IMonitorFactory + +
    + + + + + + + + +

    + + + + + + + + +
    android.support.test.jank.IMonitorFactory +
    + + + + +

    + + +

    An interface used to define a class that constructs IMonitors for test methods. + Implementing classes must have a public constructor that takes an ERROR(/Instrumentation) + instance as the sole argument. +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + abstract + + + + + List<IMonitor> + + + getMonitors(Method method, Object test) + + +

    Returns a list of IMonitors that should be used to monitor the given test method. + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    getMonitors

    +
    +
    + + + +
    +
    +List<IMonitor> getMonitors (Method method, 
    +                Object test)
    + + + + +

    Returns a list of IMonitors that should be used to monitor the given test method.

    + + + + + + + + + + +
    Parameters
    method + Method: + The test method to monitor.
    test + Object: + An instance of the class to which method belongs.
    + + + + + + +
    Returns
    List<IMonitor>A list of IMonitors that should be used to monitor the given test method. +
    + +
    + + + + + + + + + + + +
    + + + +
    + + + +
    + + + + + diff --git a/docs/html/reference/android/support/test/jank/JankTest.html b/docs/html/reference/android/support/test/jank/JankTest.html index c824c13ecd75..5dcd831a62e4 100644 --- a/docs/html/reference/android/support/test/jank/JankTest.html +++ b/docs/html/reference/android/support/test/jank/JankTest.html @@ -1,4 +1,3 @@ - @@ -93,487 +92,85 @@ - - - - - - -JankTest | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    + -
    + + +
    +
    +
    + + + +
    + + + + + + -
    - - - - -
    +
    -
    - public - - - abstract - @interface -

    JankTest

    - - - - - +

    JankTest

    +

    + + public + + + abstract + @interface + JankTest + +
    + + + + + implements - + Annotation + + + + +

    - - - - - - - -
    - -
    -
    - - - - - - - + + + + +
    android.support.test.jank.JankTest
    android.support.test.jank.JankTest +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Annotation used to configure a jank test method.

    - - - - - -
    - - - - - - +

    Annotation used to configure a jank test method.

    @@ -677,13 +250,7 @@ Summary: - - - -
    - - -

    Summary

    +

    Summary

    @@ -717,95 +284,122 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -814,16 +408,6 @@ From interface

    Inherited methods

    - -From interface - - java.lang.annotation.Annotation + + From +interface + + + java.lang.annotation.Annotation + +
    -
    - - - - - - - - - @@ -856,193 +440,40 @@ From interface - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/jank/JankTestBase.html b/docs/html/reference/android/support/test/jank/JankTestBase.html index 9214f1df34a2..4321b95eac43 100644 --- a/docs/html/reference/android/support/test/jank/JankTestBase.html +++ b/docs/html/reference/android/support/test/jank/JankTestBase.html @@ -1,2270 +1,2401 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -JankTestBase | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - - - - class -

    JankTestBase

    - - - - - - - - - - - - - - - - - extends InstrumentationTestCase
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳junit.framework.Assert
        ↳junit.framework.TestCase
         ↳android.test.InstrumentationTestCase
          ↳android.support.test.jank.JankTestBase
    - - - - - - - -
    - - -

    Class Overview

    -

    Base test class for measuring Jank. - - This test class automatically monitors jank while executing each test method. Each test method is - executed several times in a loop, according to the 'iterations' command line parameter. - - To perform additional setup / tear down steps for each iteration, subclasses can optionally - override beforeLoop() and afterLoop() methods. - - Test methods must be configured with the JankTest annotation. At minimum, the type of - jank to measure and the number of expected frames must be specified. -

    - - - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Constructors
    - - - - - - - - JankTestBase() - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Methods
    - - - - - - void - - afterLoop() - -
    - Called after each iteration of the test method. - - - -
    - -
    - - - - - - void - - afterTest(Bundle metrics) - -
    - Called once after all iterations have completed. - - - -
    - -
    - - - - - - void - - beforeLoop() - -
    - Called before each iteration of the test method. - - - -
    - -
    - - - - - - void - - beforeTest() - -
    - Called once before executing a test method. - - - -
    - -
    - - - final - - - int - - getCurrentIteration() - -
    - Return the index of the currently executing iteration. - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - -
    Protected Methods
    - - - final - - - Bundle - - getArguments() - -
    - Returns a Bundle containing the command line parameters. - - - -
    - -
    - - - - - - void - - runTest() - -
    - - - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - + + + + + + + - - - - - - - - - - - - - - - - - - - @@ -2272,57 +2403,73 @@ From class - @@ -2331,16 +2478,6 @@ From interface
    - [Expand] -
    Inherited Methods
    - -From class - - android.test.InstrumentationTestCase - -
    - - -
    -
    - -From class - - junit.framework.TestCase - -
    - - -
    -
    - -From class - - junit.framework.Assert - -
    - - -
    -
    - -From class +Summary: - java.lang.Object -
    - -
    +

    +

    Base test class for measuring Jank. + This test class automatically monitors jank while executing each test method. Each test method is + executed several times in a loop, according to the 'iterations' command line parameter. + To perform additional setup / tear down steps for each iteration, subclasses can optionally + override beforeLoop() and afterLoop() methods. - void -

    - finalize() + Test methods must be configured with the JankTest annotation. At minimum, the type of + jank to measure and the number of expected frames must be specified. +

    -
    - final +

    Summary

    - Class<?>
    -
    - getClass() -
    - int - - hashCode() -
    - final - void - - notify() -
    + + + - final - void - - + + + + + - +

    Public constructors

    - notifyAll() + +
    + + JankTestBase() + + +
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - String - - +

    Public methods

    + + + + + + void + + + afterLoop() + + +

    Called after each iteration of the test method. + + +

    + +
    + + + + + + void + + + afterTest(Bundle metrics) + + +

    Called once after all iterations have completed. + + +

    + +
    + + + + + + void + + + beforeLoop() + + +

    Called before each iteration of the test method. + + +

    + +
    + + + + + + void + + + beforeTest() + + +

    Called once before executing a test method. + + +

    + +
    + + + + final + + int + + + getCurrentIteration() + + +

    Return the index of the currently executing iteration. + + +

    + +
    - toString() -
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - final +

    Protected methods

    + + + + + + IMonitorFactory + + + createMonitorFactory() + + +

    Creates an IMonitorFactory instance that should be used to construct + IMonitor(s) for the test methods in this class. + + +

    + +
    + + + + final + + Bundle + + + getArguments() + + +

    Returns a Bundle containing the command line parameters. + + +

    + +
    + + + + + + IMonitorFactory + + + getMonitorFactory() + + +

    Returns the IMonitorFactory instance that should be used to construct applicable + IMonitor(s) for a given test method. + + +

    + +
    + + + + + + List<IMonitor> + + + getMonitors(Method method) + + +

    Returns the list of IMonitors that should be applied to the given method. + + +

    + +
    + + + + + + void + + + runTest() + + +

    + + + +

    + +
    - void
    -
    - wait() -
    + + + - final + + - void - - + + - - + - void - - + +

    Inherited methods

    + From +class + + + android.test.InstrumentationTestCase + + +
    + + +
    +
    - wait(long arg0, int arg1) -
    + From +class + + + junit.framework.TestCase + + +
    + + +
    +
    - final +
    + From +class + + + junit.framework.Assert + + +
    + + +
    +
    - wait(long arg0) -
    -
    + From +class + + + java.lang.Object + + +
    + +
    - -From interface - - junit.framework.Test + + From +interface + + + junit.framework.Test + +
    -
    - - - - - - - - - @@ -2358,39 +2495,28 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - JankTestBase - () -

    -
    -
    - - - -
    -
    - - +
    +

    JankTestBase

    +
    +
    + + +
    +
    +JankTestBase ()
    + + -

    + +

    -
    @@ -2405,206 +2531,155 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - void - - afterLoop - () -

    -
    -
    - - - -
    -
    - - - +
    +

    afterLoop

    +
    +
    + + -

    Called after each iteration of the test method.

    -
    -
    Throws
    - + +
    +void afterLoop ()
    + + + + +

    Called after each iteration of the test method.

    +
    + - + +
    Throws
    Exception - Exception
    -
    + -
    -
    -

    - - public - - - - - void - - afterTest - (Bundle metrics) -

    -
    -
    - - - -
    -
    - - +
    +

    afterTest

    +
    +
    + + +
    +
    +void afterTest (Bundle metrics)
    + + -

    Called once after all iterations have completed. + +

    Called once after all iterations have completed.

    Note: default implementation reports the aggregated jank metrics via - sendStatus(int, Bundle)

    -
    -
    Parameters
    - - - +
    metrics - the aggregated jank metrics after looped execution + sendStatus(int, Bundle)

    + + + + + - -
    Parameters
    metrics + Bundle: + the aggregated jank metrics after looped execution
    - +
    -
    -
    -

    - - public - - - - - void - - beforeLoop - () -

    -
    -
    - - +
    +

    beforeLoop

    +
    +
    + + -
    -
    - - - - -

    Called before each iteration of the test method.

    -
    -
    Throws
    - + +
    +void beforeLoop ()
    + + + + +

    Called before each iteration of the test method.

    +
    + - + +
    Throws
    Exception - Exception
    -
    + -
    -
    -

    - - public - +
    +

    beforeTest

    +
    +
    + + - - - void - - beforeTest - () -

    -
    -
    - - - -
    -
    - - - - -

    Called once before executing a test method.

    -
    -
    Throws
    - + +
    +void beforeTest ()
    + + + + +

    Called once before executing a test method.

    +
    + - + +
    Throws
    Exception - Exception
    -
    + -
    -
    -

    - - public - - final - - - int - - getCurrentIteration - () -

    -
    -
    - - - -
    -
    - - - - -

    Return the index of the currently executing iteration.

    +
    +

    getCurrentIteration

    +
    +
    + +
    +
    +int getCurrentIteration ()
    + + + + +

    Return the index of the currently executing iteration.

    + + + + + + +
    Returns
    int
    +
    @@ -2613,81 +2688,163 @@ From interface -

    Protected Methods

    +

    Protected methods

    - + -
    -

    - - protected +
    +

    createMonitorFactory

    +
    +
    + + - final +
    +
    +IMonitorFactory createMonitorFactory ()
    + + + + +

    Creates an IMonitorFactory instance that should be used to construct + IMonitor(s) for the test methods in this class. +

    + + + + + + +
    Returns
    IMonitorFactory
    +
    - Bundle -
    - getArguments - () -

    -
    -
    + +
    +

    getArguments

    +
    +
    + + -
    -
    +
    +
    +Bundle getArguments ()
    + + + + +

    Returns a Bundle containing the command line parameters.

    + + + + + + +
    Returns
    Bundle
    +
    + -

    Returns a Bundle containing the command line parameters.

    +
    +

    getMonitorFactory

    +
    +
    + +
    -
    - - - +
    +IMonitorFactory getMonitorFactory ()
    + + + + +

    Returns the IMonitorFactory instance that should be used to construct applicable + IMonitor(s) for a given test method. +

    + + + + + + +
    Returns
    IMonitorFactory
    -
    -

    - - protected +

    + +
    +

    getMonitors

    +
    +
    + + - void - - runTest - () - -
    -
    +
    +
    +List<IMonitor> getMonitors (Method method)
    + + + +

    Returns the list of IMonitors that should be applied to the given method. +

    + + + + + + +
    Parameters
    method + Method +
    + + + + + + +
    Returns
    List<IMonitor>
    +
    -
    -
    + +
    +

    runTest

    +
    +
    + + +
    +
    +void runTest ()
    + + -

    -

    -
    -
    Throws
    - + +

    +

    +
    + - + +
    Throws
    Throwable - Throwable
    -
    + -
    @@ -2695,193 +2852,40 @@ From interface - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/jank/annotations/UseMonitorFactory.html b/docs/html/reference/android/support/test/jank/annotations/UseMonitorFactory.html new file mode 100644 index 000000000000..bad0ae0b37ea --- /dev/null +++ b/docs/html/reference/android/support/test/jank/annotations/UseMonitorFactory.html @@ -0,0 +1,472 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +UseMonitorFactory + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + +
    + +
    + + + +

    UseMonitorFactory

    +

    + + public + + + abstract + @interface + UseMonitorFactory + +
    + + + + + + implements + + Annotation + + + + + +

    + + + + + + + + +
    android.support.test.jank.annotations.UseMonitorFactory +
    + + + + +

    + + +

    Class annotation used to override the default IMonitorFactory implementation. + The factory should have a public constructor that takes an ERROR(/Instrumentation) instance as + the sole argument. +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +interface + + + java.lang.annotation.Annotation + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + +
    + + + +
    + + + + + diff --git a/docs/html/reference/android/support/test/jank/annotations/package-summary.html b/docs/html/reference/android/support/test/jank/annotations/package-summary.html new file mode 100644 index 000000000000..b09caa2839ab --- /dev/null +++ b/docs/html/reference/android/support/test/jank/annotations/package-summary.html @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +android.support.test.jank.annotations + + + + + + + + + + +
    + +
    +
    + + + + +
    +
    +
    + +

    android.support.test.jank.annotations

    + + + + + + + +

    Annotations

    + + + + + + + + + + +
    UseMonitorFactory + Class annotation used to override the default IMonitorFactory implementation.  + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + +
    + + + +
    + + + + + diff --git a/docs/html/reference/android/support/test/jank/package-summary.html b/docs/html/reference/android/support/test/jank/package-summary.html index 2444aa88f141..1af69a3b66f3 100644 --- a/docs/html/reference/android/support/test/jank/package-summary.html +++ b/docs/html/reference/android/support/test/jank/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,759 +92,197 @@ - - - - - - -android.support.test.jank | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.jank - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.jank

    -
    - -
    - -
    - +

    android.support.test.jank

    +

    Annotations

    -
    - - + + - + - + - - + + - + - - + +
    GfxMonitorGfxMonitor Annotation used to configure a gfx monitor.  - - + +
    JankTestJankTest Annotation used to configure a jank test method.  - - + +
    -
    + + +

    Interfaces

    + + + + + + + + + + + + + + + + +
    IMonitor + An interface used to define a class that monitors test methods and collects metrics.  + + +
    IMonitorFactory + An interface used to define a class that constructs IMonitors for test methods.  + + +
    + +

    Classes

    -
    - - + + - + - + + + +
    JankTestBaseJankTestBase Base test class for measuring Jank.  - - + +
    + -
    -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + + + + + +
    + + +
    + + + +
    + diff --git a/docs/html/reference/android/support/test/lists.js b/docs/html/reference/android/support/test/lists.js new file mode 100644 index 000000000000..67ef96349229 --- /dev/null +++ b/docs/html/reference/android/support/test/lists.js @@ -0,0 +1,232 @@ +var SUPPORT_TEST_DATA = [ + { id:0, label:"android.support.test", link:"reference/android/support/test/package-summary.html", type:"package", deprecated:"false" }, + { id:1, label:"android.support.test.InstrumentationRegistry", link:"reference/android/support/test/InstrumentationRegistry.html", type:"class", deprecated:"false" }, + { id:2, label:"android.support.test.annotation", link:"reference/android/support/test/annotation/package-summary.html", type:"package", deprecated:"false" }, + { id:3, label:"android.support.test.annotation.Beta", link:"reference/android/support/test/annotation/Beta.html", type:"class", deprecated:"false" }, + { id:4, label:"android.support.test.annotation.UiThreadTest", link:"reference/android/support/test/annotation/UiThreadTest.html", type:"class", deprecated:"false" }, + { id:5, label:"android.support.test.espresso", link:"reference/android/support/test/espresso/package-summary.html", type:"package", deprecated:"false" }, + { id:6, label:"android.support.test.espresso.AmbiguousViewMatcherException", link:"reference/android/support/test/espresso/AmbiguousViewMatcherException.html", type:"class", deprecated:"false" }, + { id:7, label:"android.support.test.espresso.AmbiguousViewMatcherException.Builder", link:"reference/android/support/test/espresso/AmbiguousViewMatcherException.Builder.html", type:"class", deprecated:"false" }, + { id:8, label:"android.support.test.espresso.AppNotIdleException", link:"reference/android/support/test/espresso/AppNotIdleException.html", type:"class", deprecated:"false" }, + { id:9, label:"android.support.test.espresso.BaseLayerComponent", link:"reference/android/support/test/espresso/BaseLayerComponent.html", type:"class", deprecated:"false" }, + { id:10, label:"android.support.test.espresso.DataInteraction", link:"reference/android/support/test/espresso/DataInteraction.html", type:"class", deprecated:"false" }, + { id:11, label:"android.support.test.espresso.Espresso", link:"reference/android/support/test/espresso/Espresso.html", type:"class", deprecated:"false" }, + { id:12, label:"android.support.test.espresso.EspressoException", link:"reference/android/support/test/espresso/EspressoException.html", type:"class", deprecated:"false" }, + { id:13, label:"android.support.test.espresso.FailureHandler", link:"reference/android/support/test/espresso/FailureHandler.html", type:"class", deprecated:"false" }, + { id:14, label:"android.support.test.espresso.GraphHolder", link:"reference/android/support/test/espresso/GraphHolder.html", type:"class", deprecated:"false" }, + { id:15, label:"android.support.test.espresso.IdlingPolicies", link:"reference/android/support/test/espresso/IdlingPolicies.html", type:"class", deprecated:"false" }, + { id:16, label:"android.support.test.espresso.IdlingPolicy", link:"reference/android/support/test/espresso/IdlingPolicy.html", type:"class", deprecated:"false" }, + { id:17, label:"android.support.test.espresso.IdlingResource", link:"reference/android/support/test/espresso/IdlingResource.html", type:"class", deprecated:"false" }, + { id:18, label:"android.support.test.espresso.IdlingResource.ResourceCallback", link:"reference/android/support/test/espresso/IdlingResource.ResourceCallback.html", type:"class", deprecated:"false" }, + { id:19, label:"android.support.test.espresso.IdlingResourceTimeoutException", link:"reference/android/support/test/espresso/IdlingResourceTimeoutException.html", type:"class", deprecated:"false" }, + { id:20, label:"android.support.test.espresso.InjectEventSecurityException", link:"reference/android/support/test/espresso/InjectEventSecurityException.html", type:"class", deprecated:"false" }, + { id:21, label:"android.support.test.espresso.NoActivityResumedException", link:"reference/android/support/test/espresso/NoActivityResumedException.html", type:"class", deprecated:"false" }, + { id:22, label:"android.support.test.espresso.NoMatchingRootException", link:"reference/android/support/test/espresso/NoMatchingRootException.html", type:"class", deprecated:"false" }, + { id:23, label:"android.support.test.espresso.NoMatchingViewException", link:"reference/android/support/test/espresso/NoMatchingViewException.html", type:"class", deprecated:"false" }, + { id:24, label:"android.support.test.espresso.NoMatchingViewException.Builder", link:"reference/android/support/test/espresso/NoMatchingViewException.Builder.html", type:"class", deprecated:"false" }, + { id:25, label:"android.support.test.espresso.PerformException", link:"reference/android/support/test/espresso/PerformException.html", type:"class", deprecated:"false" }, + { id:26, label:"android.support.test.espresso.PerformException.Builder", link:"reference/android/support/test/espresso/PerformException.Builder.html", type:"class", deprecated:"false" }, + { id:27, label:"android.support.test.espresso.Root", link:"reference/android/support/test/espresso/Root.html", type:"class", deprecated:"false" }, + { id:28, label:"android.support.test.espresso.Root.Builder", link:"reference/android/support/test/espresso/Root.Builder.html", type:"class", deprecated:"false" }, + { id:29, label:"android.support.test.espresso.UiController", link:"reference/android/support/test/espresso/UiController.html", type:"class", deprecated:"false" }, + { id:30, label:"android.support.test.espresso.ViewAction", link:"reference/android/support/test/espresso/ViewAction.html", type:"class", deprecated:"false" }, + { id:31, label:"android.support.test.espresso.ViewAssertion", link:"reference/android/support/test/espresso/ViewAssertion.html", type:"class", deprecated:"false" }, + { id:32, label:"android.support.test.espresso.ViewFinder", link:"reference/android/support/test/espresso/ViewFinder.html", type:"class", deprecated:"false" }, + { id:33, label:"android.support.test.espresso.ViewInteraction", link:"reference/android/support/test/espresso/ViewInteraction.html", type:"class", deprecated:"false" }, + { id:34, label:"android.support.test.espresso.ViewInteractionComponent", link:"reference/android/support/test/espresso/ViewInteractionComponent.html", type:"class", deprecated:"false" }, + { id:35, label:"android.support.test.espresso.action", link:"reference/android/support/test/espresso/action/package-summary.html", type:"package", deprecated:"false" }, + { id:36, label:"android.support.test.espresso.action.AdapterDataLoaderAction", link:"reference/android/support/test/espresso/action/AdapterDataLoaderAction.html", type:"class", deprecated:"false" }, + { id:37, label:"android.support.test.espresso.action.AdapterViewProtocol", link:"reference/android/support/test/espresso/action/AdapterViewProtocol.html", type:"class", deprecated:"false" }, + { id:38, label:"android.support.test.espresso.action.AdapterViewProtocol.AdaptedData", link:"reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.html", type:"class", deprecated:"false" }, + { id:39, label:"android.support.test.espresso.action.AdapterViewProtocol.AdaptedData.Builder", link:"reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.Builder.html", type:"class", deprecated:"false" }, + { id:40, label:"android.support.test.espresso.action.AdapterViewProtocol.DataFunction", link:"reference/android/support/test/espresso/action/AdapterViewProtocol.DataFunction.html", type:"class", deprecated:"false" }, + { id:41, label:"android.support.test.espresso.action.AdapterViewProtocols", link:"reference/android/support/test/espresso/action/AdapterViewProtocols.html", type:"class", deprecated:"false" }, + { id:42, label:"android.support.test.espresso.action.CloseKeyboardAction", link:"reference/android/support/test/espresso/action/CloseKeyboardAction.html", type:"class", deprecated:"false" }, + { id:43, label:"android.support.test.espresso.action.CoordinatesProvider", link:"reference/android/support/test/espresso/action/CoordinatesProvider.html", type:"class", deprecated:"false" }, + { id:44, label:"android.support.test.espresso.action.EditorAction", link:"reference/android/support/test/espresso/action/EditorAction.html", type:"class", deprecated:"false" }, + { id:45, label:"android.support.test.espresso.action.EspressoKey", link:"reference/android/support/test/espresso/action/EspressoKey.html", type:"class", deprecated:"false" }, + { id:46, label:"android.support.test.espresso.action.EspressoKey.Builder", link:"reference/android/support/test/espresso/action/EspressoKey.Builder.html", type:"class", deprecated:"false" }, + { id:47, label:"android.support.test.espresso.action.GeneralClickAction", link:"reference/android/support/test/espresso/action/GeneralClickAction.html", type:"class", deprecated:"false" }, + { id:48, label:"android.support.test.espresso.action.GeneralLocation", link:"reference/android/support/test/espresso/action/GeneralLocation.html", type:"class", deprecated:"false" }, + { id:49, label:"android.support.test.espresso.action.GeneralSwipeAction", link:"reference/android/support/test/espresso/action/GeneralSwipeAction.html", type:"class", deprecated:"false" }, + { id:50, label:"android.support.test.espresso.action.KeyEventAction", link:"reference/android/support/test/espresso/action/KeyEventAction.html", type:"class", deprecated:"false" }, + { id:51, label:"android.support.test.espresso.action.MotionEvents", link:"reference/android/support/test/espresso/action/MotionEvents.html", type:"class", deprecated:"false" }, + { id:52, label:"android.support.test.espresso.action.MotionEvents.DownResultHolder", link:"reference/android/support/test/espresso/action/MotionEvents.DownResultHolder.html", type:"class", deprecated:"false" }, + { id:53, label:"android.support.test.espresso.action.OpenLinkAction", link:"reference/android/support/test/espresso/action/OpenLinkAction.html", type:"class", deprecated:"false" }, + { id:54, label:"android.support.test.espresso.action.PrecisionDescriber", link:"reference/android/support/test/espresso/action/PrecisionDescriber.html", type:"class", deprecated:"false" }, + { id:55, label:"android.support.test.espresso.action.Press", link:"reference/android/support/test/espresso/action/Press.html", type:"class", deprecated:"false" }, + { id:56, label:"android.support.test.espresso.action.ReplaceTextAction", link:"reference/android/support/test/espresso/action/ReplaceTextAction.html", type:"class", deprecated:"false" }, + { id:57, label:"android.support.test.espresso.action.ScrollToAction", link:"reference/android/support/test/espresso/action/ScrollToAction.html", type:"class", deprecated:"false" }, + { id:58, label:"android.support.test.espresso.action.Swipe", link:"reference/android/support/test/espresso/action/Swipe.html", type:"class", deprecated:"false" }, + { id:59, label:"android.support.test.espresso.action.Swiper", link:"reference/android/support/test/espresso/action/Swiper.html", type:"class", deprecated:"false" }, + { id:60, label:"android.support.test.espresso.action.Swiper.Status", link:"reference/android/support/test/espresso/action/Swiper.Status.html", type:"class", deprecated:"false" }, + { id:61, label:"android.support.test.espresso.action.Tap", link:"reference/android/support/test/espresso/action/Tap.html", type:"class", deprecated:"false" }, + { id:62, label:"android.support.test.espresso.action.Tapper", link:"reference/android/support/test/espresso/action/Tapper.html", type:"class", deprecated:"false" }, + { id:63, label:"android.support.test.espresso.action.Tapper.Status", link:"reference/android/support/test/espresso/action/Tapper.Status.html", type:"class", deprecated:"false" }, + { id:64, label:"android.support.test.espresso.action.TypeTextAction", link:"reference/android/support/test/espresso/action/TypeTextAction.html", type:"class", deprecated:"false" }, + { id:65, label:"android.support.test.espresso.action.ViewActions", link:"reference/android/support/test/espresso/action/ViewActions.html", type:"class", deprecated:"false" }, + { id:66, label:"android.support.test.espresso.assertion", link:"reference/android/support/test/espresso/assertion/package-summary.html", type:"package", deprecated:"false" }, + { id:67, label:"android.support.test.espresso.assertion.LayoutAssertions", link:"reference/android/support/test/espresso/assertion/LayoutAssertions.html", type:"class", deprecated:"false" }, + { id:68, label:"android.support.test.espresso.assertion.PositionAssertions", link:"reference/android/support/test/espresso/assertion/PositionAssertions.html", type:"class", deprecated:"false" }, + { id:69, label:"android.support.test.espresso.assertion.ViewAssertions", link:"reference/android/support/test/espresso/assertion/ViewAssertions.html", type:"class", deprecated:"false" }, + { id:70, label:"android.support.test.espresso.base", link:"reference/android/support/test/espresso/base/package-summary.html", type:"package", deprecated:"false" }, + { id:71, label:"android.support.test.espresso.base.ActiveRootLister", link:"reference/android/support/test/espresso/base/ActiveRootLister.html", type:"class", deprecated:"false" }, + { id:72, label:"android.support.test.espresso.base.BaseLayerModule", link:"reference/android/support/test/espresso/base/BaseLayerModule.html", type:"class", deprecated:"false" }, + { id:73, label:"android.support.test.espresso.base.BaseLayerModule.FailureHandlerHolder", link:"reference/android/support/test/espresso/base/BaseLayerModule.FailureHandlerHolder.html", type:"class", deprecated:"false" }, + { id:74, label:"android.support.test.espresso.base.Default", link:"reference/android/support/test/espresso/base/Default.html", type:"class", deprecated:"false" }, + { id:75, label:"android.support.test.espresso.base.DefaultFailureHandler", link:"reference/android/support/test/espresso/base/DefaultFailureHandler.html", type:"class", deprecated:"false" }, + { id:76, label:"android.support.test.espresso.base.IdlingResourceRegistry", link:"reference/android/support/test/espresso/base/IdlingResourceRegistry.html", type:"class", deprecated:"false" }, + { id:77, label:"android.support.test.espresso.base.MainThread", link:"reference/android/support/test/espresso/base/MainThread.html", type:"class", deprecated:"false" }, + { id:78, label:"android.support.test.espresso.base.RootViewPicker", link:"reference/android/support/test/espresso/base/RootViewPicker.html", type:"class", deprecated:"false" }, + { id:79, label:"android.support.test.espresso.base.UiControllerModule", link:"reference/android/support/test/espresso/base/UiControllerModule.html", type:"class", deprecated:"false" }, + { id:80, label:"android.support.test.espresso.base.ViewFinderImpl", link:"reference/android/support/test/espresso/base/ViewFinderImpl.html", type:"class", deprecated:"false" }, + { id:81, label:"android.support.test.espresso.contrib", link:"reference/android/support/test/espresso/contrib/package-summary.html", type:"package", deprecated:"false" }, + { id:82, label:"android.support.test.espresso.contrib.AccessibilityChecks", link:"reference/android/support/test/espresso/contrib/AccessibilityChecks.html", type:"class", deprecated:"false" }, + { id:83, label:"android.support.test.espresso.contrib.CountingIdlingResource", link:"reference/android/support/test/espresso/contrib/CountingIdlingResource.html", type:"class", deprecated:"true" }, + { id:84, label:"android.support.test.espresso.contrib.DrawerActions", link:"reference/android/support/test/espresso/contrib/DrawerActions.html", type:"class", deprecated:"false" }, + { id:85, label:"android.support.test.espresso.contrib.DrawerMatchers", link:"reference/android/support/test/espresso/contrib/DrawerMatchers.html", type:"class", deprecated:"false" }, + { id:86, label:"android.support.test.espresso.contrib.NavigationViewActions", link:"reference/android/support/test/espresso/contrib/NavigationViewActions.html", type:"class", deprecated:"false" }, + { id:87, label:"android.support.test.espresso.contrib.PickerActions", link:"reference/android/support/test/espresso/contrib/PickerActions.html", type:"class", deprecated:"false" }, + { id:88, label:"android.support.test.espresso.contrib.RecyclerViewActions", link:"reference/android/support/test/espresso/contrib/RecyclerViewActions.html", type:"class", deprecated:"false" }, + { id:89, label:"android.support.test.espresso.contrib.RecyclerViewActions.PositionableRecyclerViewAction", link:"reference/android/support/test/espresso/contrib/RecyclerViewActions.PositionableRecyclerViewAction.html", type:"class", deprecated:"false" }, + { id:90, label:"android.support.test.espresso.idling", link:"reference/android/support/test/espresso/idling/package-summary.html", type:"package", deprecated:"false" }, + { id:91, label:"android.support.test.espresso.idling.CountingIdlingResource", link:"reference/android/support/test/espresso/idling/CountingIdlingResource.html", type:"class", deprecated:"false" }, + { id:92, label:"android.support.test.espresso.intent", link:"reference/android/support/test/espresso/intent/package-summary.html", type:"package", deprecated:"false" }, + { id:93, label:"android.support.test.espresso.intent.Checks", link:"reference/android/support/test/espresso/intent/Checks.html", type:"class", deprecated:"false" }, + { id:94, label:"android.support.test.espresso.intent.Intents", link:"reference/android/support/test/espresso/intent/Intents.html", type:"class", deprecated:"false" }, + { id:95, label:"android.support.test.espresso.intent.OngoingStubbing", link:"reference/android/support/test/espresso/intent/OngoingStubbing.html", type:"class", deprecated:"false" }, + { id:96, label:"android.support.test.espresso.intent.ResettingStubber", link:"reference/android/support/test/espresso/intent/ResettingStubber.html", type:"class", deprecated:"false" }, + { id:97, label:"android.support.test.espresso.intent.ResettingStubberImpl", link:"reference/android/support/test/espresso/intent/ResettingStubberImpl.html", type:"class", deprecated:"false" }, + { id:98, label:"android.support.test.espresso.intent.ResolvedIntent", link:"reference/android/support/test/espresso/intent/ResolvedIntent.html", type:"class", deprecated:"false" }, + { id:99, label:"android.support.test.espresso.intent.VerifiableIntent", link:"reference/android/support/test/espresso/intent/VerifiableIntent.html", type:"class", deprecated:"false" }, + { id:100, label:"android.support.test.espresso.intent.VerificationMode", link:"reference/android/support/test/espresso/intent/VerificationMode.html", type:"class", deprecated:"false" }, + { id:101, label:"android.support.test.espresso.intent.VerificationModes", link:"reference/android/support/test/espresso/intent/VerificationModes.html", type:"class", deprecated:"false" }, + { id:102, label:"android.support.test.espresso.intent.matcher", link:"reference/android/support/test/espresso/intent/matcher/package-summary.html", type:"package", deprecated:"false" }, + { id:103, label:"android.support.test.espresso.intent.matcher.BundleMatchers", link:"reference/android/support/test/espresso/intent/matcher/BundleMatchers.html", type:"class", deprecated:"false" }, + { id:104, label:"android.support.test.espresso.intent.matcher.ComponentNameMatchers", link:"reference/android/support/test/espresso/intent/matcher/ComponentNameMatchers.html", type:"class", deprecated:"false" }, + { id:105, label:"android.support.test.espresso.intent.matcher.IntentMatchers", link:"reference/android/support/test/espresso/intent/matcher/IntentMatchers.html", type:"class", deprecated:"false" }, + { id:106, label:"android.support.test.espresso.intent.matcher.UriMatchers", link:"reference/android/support/test/espresso/intent/matcher/UriMatchers.html", type:"class", deprecated:"false" }, + { id:107, label:"android.support.test.espresso.intent.rule", link:"reference/android/support/test/espresso/intent/rule/package-summary.html", type:"package", deprecated:"false" }, + { id:108, label:"android.support.test.espresso.intent.rule.IntentsTestRule", link:"reference/android/support/test/espresso/intent/rule/IntentsTestRule.html", type:"class", deprecated:"false" }, + { id:109, label:"android.support.test.espresso.matcher", link:"reference/android/support/test/espresso/matcher/package-summary.html", type:"package", deprecated:"false" }, + { id:110, label:"android.support.test.espresso.matcher.BoundedMatcher", link:"reference/android/support/test/espresso/matcher/BoundedMatcher.html", type:"class", deprecated:"false" }, + { id:111, label:"android.support.test.espresso.matcher.CursorMatchers", link:"reference/android/support/test/espresso/matcher/CursorMatchers.html", type:"class", deprecated:"false" }, + { id:112, label:"android.support.test.espresso.matcher.CursorMatchers.CursorMatcher", link:"reference/android/support/test/espresso/matcher/CursorMatchers.CursorMatcher.html", type:"class", deprecated:"false" }, + { id:113, label:"android.support.test.espresso.matcher.LayoutMatchers", link:"reference/android/support/test/espresso/matcher/LayoutMatchers.html", type:"class", deprecated:"false" }, + { id:114, label:"android.support.test.espresso.matcher.PreferenceMatchers", link:"reference/android/support/test/espresso/matcher/PreferenceMatchers.html", type:"class", deprecated:"false" }, + { id:115, label:"android.support.test.espresso.matcher.RootMatchers", link:"reference/android/support/test/espresso/matcher/RootMatchers.html", type:"class", deprecated:"false" }, + { id:116, label:"android.support.test.espresso.matcher.ViewMatchers", link:"reference/android/support/test/espresso/matcher/ViewMatchers.html", type:"class", deprecated:"false" }, + { id:117, label:"android.support.test.espresso.matcher.ViewMatchers.Visibility", link:"reference/android/support/test/espresso/matcher/ViewMatchers.Visibility.html", type:"class", deprecated:"false" }, + { id:118, label:"android.support.test.espresso.util", link:"reference/android/support/test/espresso/util/package-summary.html", type:"package", deprecated:"false" }, + { id:119, label:"android.support.test.espresso.util.ActivityLifecycles", link:"reference/android/support/test/espresso/util/ActivityLifecycles.html", type:"class", deprecated:"false" }, + { id:120, label:"android.support.test.espresso.util.HumanReadables", link:"reference/android/support/test/espresso/util/HumanReadables.html", type:"class", deprecated:"false" }, + { id:121, label:"android.support.test.espresso.util.TreeIterables", link:"reference/android/support/test/espresso/util/TreeIterables.html", type:"class", deprecated:"false" }, + { id:122, label:"android.support.test.espresso.util.TreeIterables.ViewAndDistance", link:"reference/android/support/test/espresso/util/TreeIterables.ViewAndDistance.html", type:"class", deprecated:"false" }, + { id:123, label:"android.support.test.espresso.web.action", link:"reference/android/support/test/espresso/web/action/package-summary.html", type:"package", deprecated:"false" }, + { id:124, label:"android.support.test.espresso.web.action.AtomAction", link:"reference/android/support/test/espresso/web/action/AtomAction.html", type:"class", deprecated:"false" }, + { id:125, label:"android.support.test.espresso.web.action.EnableJavascriptAction", link:"reference/android/support/test/espresso/web/action/EnableJavascriptAction.html", type:"class", deprecated:"false" }, + { id:126, label:"android.support.test.espresso.web.assertion", link:"reference/android/support/test/espresso/web/assertion/package-summary.html", type:"package", deprecated:"false" }, + { id:127, label:"android.support.test.espresso.web.assertion.TagSoupDocumentParser", link:"reference/android/support/test/espresso/web/assertion/TagSoupDocumentParser.html", type:"class", deprecated:"false" }, + { id:128, label:"android.support.test.espresso.web.assertion.WebAssertion", link:"reference/android/support/test/espresso/web/assertion/WebAssertion.html", type:"class", deprecated:"false" }, + { id:129, label:"android.support.test.espresso.web.assertion.WebViewAssertions", link:"reference/android/support/test/espresso/web/assertion/WebViewAssertions.html", type:"class", deprecated:"false" }, + { id:130, label:"android.support.test.espresso.web.assertion.WebViewAssertions.ResultDescriber", link:"reference/android/support/test/espresso/web/assertion/WebViewAssertions.ResultDescriber.html", type:"class", deprecated:"false" }, + { id:131, label:"android.support.test.espresso.web.bridge", link:"reference/android/support/test/espresso/web/bridge/package-summary.html", type:"package", deprecated:"false" }, + { id:132, label:"android.support.test.espresso.web.bridge.Conduit", link:"reference/android/support/test/espresso/web/bridge/Conduit.html", type:"class", deprecated:"false" }, + { id:133, label:"android.support.test.espresso.web.bridge.JavaScriptBridge", link:"reference/android/support/test/espresso/web/bridge/JavaScriptBridge.html", type:"class", deprecated:"false" }, + { id:134, label:"android.support.test.espresso.web.matcher", link:"reference/android/support/test/espresso/web/matcher/package-summary.html", type:"package", deprecated:"false" }, + { id:135, label:"android.support.test.espresso.web.matcher.AmbiguousElementMatcherException", link:"reference/android/support/test/espresso/web/matcher/AmbiguousElementMatcherException.html", type:"class", deprecated:"false" }, + { id:136, label:"android.support.test.espresso.web.matcher.DomMatchers", link:"reference/android/support/test/espresso/web/matcher/DomMatchers.html", type:"class", deprecated:"false" }, + { id:137, label:"android.support.test.espresso.web.model", link:"reference/android/support/test/espresso/web/model/package-summary.html", type:"package", deprecated:"false" }, + { id:138, label:"android.support.test.espresso.web.model.Atom", link:"reference/android/support/test/espresso/web/model/Atom.html", type:"class", deprecated:"false" }, + { id:139, label:"android.support.test.espresso.web.model.Atoms", link:"reference/android/support/test/espresso/web/model/Atoms.html", type:"class", deprecated:"false" }, + { id:140, label:"android.support.test.espresso.web.model.ElementReference", link:"reference/android/support/test/espresso/web/model/ElementReference.html", type:"class", deprecated:"false" }, + { id:141, label:"android.support.test.espresso.web.model.Evaluation", link:"reference/android/support/test/espresso/web/model/Evaluation.html", type:"class", deprecated:"false" }, + { id:142, label:"android.support.test.espresso.web.model.JSONAble", link:"reference/android/support/test/espresso/web/model/JSONAble.html", type:"class", deprecated:"false" }, + { id:143, label:"android.support.test.espresso.web.model.JSONAble.DeJSONFactory", link:"reference/android/support/test/espresso/web/model/JSONAble.DeJSONFactory.html", type:"class", deprecated:"false" }, + { id:144, label:"android.support.test.espresso.web.model.ModelCodec", link:"reference/android/support/test/espresso/web/model/ModelCodec.html", type:"class", deprecated:"false" }, + { id:145, label:"android.support.test.espresso.web.model.SimpleAtom", link:"reference/android/support/test/espresso/web/model/SimpleAtom.html", type:"class", deprecated:"false" }, + { id:146, label:"android.support.test.espresso.web.model.SimpleAtom.ElementReferencePlacement", link:"reference/android/support/test/espresso/web/model/SimpleAtom.ElementReferencePlacement.html", type:"class", deprecated:"false" }, + { id:147, label:"android.support.test.espresso.web.model.TransformingAtom", link:"reference/android/support/test/espresso/web/model/TransformingAtom.html", type:"class", deprecated:"false" }, + { id:148, label:"android.support.test.espresso.web.model.TransformingAtom.Transformer", link:"reference/android/support/test/espresso/web/model/TransformingAtom.Transformer.html", type:"class", deprecated:"false" }, + { id:149, label:"android.support.test.espresso.web.model.WindowReference", link:"reference/android/support/test/espresso/web/model/WindowReference.html", type:"class", deprecated:"false" }, + { id:150, label:"android.support.test.espresso.web.sugar", link:"reference/android/support/test/espresso/web/sugar/package-summary.html", type:"package", deprecated:"false" }, + { id:151, label:"android.support.test.espresso.web.sugar.Web", link:"reference/android/support/test/espresso/web/sugar/Web.html", type:"class", deprecated:"false" }, + { id:152, label:"android.support.test.espresso.web.sugar.Web.WebInteraction", link:"reference/android/support/test/espresso/web/sugar/Web.WebInteraction.html", type:"class", deprecated:"false" }, + { id:153, label:"android.support.test.espresso.web.webdriver", link:"reference/android/support/test/espresso/web/webdriver/package-summary.html", type:"package", deprecated:"false" }, + { id:154, label:"android.support.test.espresso.web.webdriver.DriverAtoms", link:"reference/android/support/test/espresso/web/webdriver/DriverAtoms.html", type:"class", deprecated:"false" }, + { id:155, label:"android.support.test.espresso.web.webdriver.Locator", link:"reference/android/support/test/espresso/web/webdriver/Locator.html", type:"class", deprecated:"false" }, + { id:156, label:"android.support.test.filters", link:"reference/android/support/test/filters/package-summary.html", type:"package", deprecated:"false" }, + { id:157, label:"android.support.test.filters.FlakyTest", link:"reference/android/support/test/filters/FlakyTest.html", type:"class", deprecated:"false" }, + { id:158, label:"android.support.test.filters.LargeTest", link:"reference/android/support/test/filters/LargeTest.html", type:"class", deprecated:"false" }, + { id:159, label:"android.support.test.filters.MediumTest", link:"reference/android/support/test/filters/MediumTest.html", type:"class", deprecated:"false" }, + { id:160, label:"android.support.test.filters.RequiresDevice", link:"reference/android/support/test/filters/RequiresDevice.html", type:"class", deprecated:"false" }, + { id:161, label:"android.support.test.filters.SdkSuppress", link:"reference/android/support/test/filters/SdkSuppress.html", type:"class", deprecated:"false" }, + { id:162, label:"android.support.test.filters.SmallTest", link:"reference/android/support/test/filters/SmallTest.html", type:"class", deprecated:"false" }, + { id:163, label:"android.support.test.filters.Suppress", link:"reference/android/support/test/filters/Suppress.html", type:"class", deprecated:"false" }, + { id:164, label:"android.support.test.jank", link:"reference/android/support/test/jank/package-summary.html", type:"package", deprecated:"false" }, + { id:165, label:"android.support.test.jank.GfxMonitor", link:"reference/android/support/test/jank/GfxMonitor.html", type:"class", deprecated:"false" }, + { id:166, label:"android.support.test.jank.IMonitor", link:"reference/android/support/test/jank/IMonitor.html", type:"class", deprecated:"false" }, + { id:167, label:"android.support.test.jank.IMonitorFactory", link:"reference/android/support/test/jank/IMonitorFactory.html", type:"class", deprecated:"false" }, + { id:168, label:"android.support.test.jank.JankTest", link:"reference/android/support/test/jank/JankTest.html", type:"class", deprecated:"false" }, + { id:169, label:"android.support.test.jank.JankTestBase", link:"reference/android/support/test/jank/JankTestBase.html", type:"class", deprecated:"false" }, + { id:170, label:"android.support.test.jank.annotations", link:"reference/android/support/test/jank/annotations/package-summary.html", type:"package", deprecated:"false" }, + { id:171, label:"android.support.test.jank.annotations.UseMonitorFactory", link:"reference/android/support/test/jank/annotations/UseMonitorFactory.html", type:"class", deprecated:"false" }, + { id:172, label:"android.support.test.rule", link:"reference/android/support/test/rule/package-summary.html", type:"package", deprecated:"false" }, + { id:173, label:"android.support.test.rule.ActivityTestRule", link:"reference/android/support/test/rule/ActivityTestRule.html", type:"class", deprecated:"false" }, + { id:174, label:"android.support.test.rule.DisableOnAndroidDebug", link:"reference/android/support/test/rule/DisableOnAndroidDebug.html", type:"class", deprecated:"false" }, + { id:175, label:"android.support.test.rule.ServiceTestRule", link:"reference/android/support/test/rule/ServiceTestRule.html", type:"class", deprecated:"false" }, + { id:176, label:"android.support.test.rule.UiThreadTestRule", link:"reference/android/support/test/rule/UiThreadTestRule.html", type:"class", deprecated:"false" }, + { id:177, label:"android.support.test.rule.logging", link:"reference/android/support/test/rule/logging/package-summary.html", type:"package", deprecated:"false" }, + { id:178, label:"android.support.test.rule.logging.AtraceLogger", link:"reference/android/support/test/rule/logging/AtraceLogger.html", type:"class", deprecated:"false" }, + { id:179, label:"android.support.test.rule.logging.EnableTestTracingRule", link:"reference/android/support/test/rule/logging/EnableTestTracingRule.html", type:"class", deprecated:"false" }, + { id:180, label:"android.support.test.rule.logging.LogBatteryInformationRule", link:"reference/android/support/test/rule/logging/LogBatteryInformationRule.html", type:"class", deprecated:"false" }, + { id:181, label:"android.support.test.rule.logging.LogDeviceGetPropInfoRule", link:"reference/android/support/test/rule/logging/LogDeviceGetPropInfoRule.html", type:"class", deprecated:"false" }, + { id:182, label:"android.support.test.rule.logging.LogGraphicsStatsRule", link:"reference/android/support/test/rule/logging/LogGraphicsStatsRule.html", type:"class", deprecated:"false" }, + { id:183, label:"android.support.test.rule.logging.LogLogcatRule", link:"reference/android/support/test/rule/logging/LogLogcatRule.html", type:"class", deprecated:"false" }, + { id:184, label:"android.support.test.rule.logging.LogNetStatsRule", link:"reference/android/support/test/rule/logging/LogNetStatsRule.html", type:"class", deprecated:"false" }, + { id:185, label:"android.support.test.rule.logging.LoggingBaseRule", link:"reference/android/support/test/rule/logging/LoggingBaseRule.html", type:"class", deprecated:"false" }, + { id:186, label:"android.support.test.rule.logging.RuleLoggingUtils", link:"reference/android/support/test/rule/logging/RuleLoggingUtils.html", type:"class", deprecated:"false" }, + { id:187, label:"android.support.test.runner", link:"reference/android/support/test/runner/package-summary.html", type:"package", deprecated:"false" }, + { id:188, label:"android.support.test.runner.AndroidJUnit4", link:"reference/android/support/test/runner/AndroidJUnit4.html", type:"class", deprecated:"false" }, + { id:189, label:"android.support.test.runner.AndroidJUnitRunner", link:"reference/android/support/test/runner/AndroidJUnitRunner.html", type:"class", deprecated:"false" }, + { id:190, label:"android.support.test.runner.MonitoringInstrumentation", link:"reference/android/support/test/runner/MonitoringInstrumentation.html", type:"class", deprecated:"false" }, + { id:191, label:"android.support.test.runner.MonitoringInstrumentation.ActivityFinisher", link:"reference/android/support/test/runner/MonitoringInstrumentation.ActivityFinisher.html", type:"class", deprecated:"false" }, + { id:192, label:"android.support.test.runner.UsageTrackerFacilitator", link:"reference/android/support/test/runner/UsageTrackerFacilitator.html", type:"class", deprecated:"false" }, + { id:193, label:"android.support.test.runner.intent", link:"reference/android/support/test/runner/intent/package-summary.html", type:"package", deprecated:"false" }, + { id:194, label:"android.support.test.runner.intent.IntentCallback", link:"reference/android/support/test/runner/intent/IntentCallback.html", type:"class", deprecated:"false" }, + { id:195, label:"android.support.test.runner.intent.IntentMonitor", link:"reference/android/support/test/runner/intent/IntentMonitor.html", type:"class", deprecated:"false" }, + { id:196, label:"android.support.test.runner.intent.IntentMonitorRegistry", link:"reference/android/support/test/runner/intent/IntentMonitorRegistry.html", type:"class", deprecated:"false" }, + { id:197, label:"android.support.test.runner.intent.IntentStubber", link:"reference/android/support/test/runner/intent/IntentStubber.html", type:"class", deprecated:"false" }, + { id:198, label:"android.support.test.runner.intent.IntentStubberRegistry", link:"reference/android/support/test/runner/intent/IntentStubberRegistry.html", type:"class", deprecated:"false" }, + { id:199, label:"android.support.test.runner.lifecycle", link:"reference/android/support/test/runner/lifecycle/package-summary.html", type:"package", deprecated:"false" }, + { id:200, label:"android.support.test.runner.lifecycle.ActivityLifecycleCallback", link:"reference/android/support/test/runner/lifecycle/ActivityLifecycleCallback.html", type:"class", deprecated:"false" }, + { id:201, label:"android.support.test.runner.lifecycle.ActivityLifecycleMonitor", link:"reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitor.html", type:"class", deprecated:"false" }, + { id:202, label:"android.support.test.runner.lifecycle.ActivityLifecycleMonitorRegistry", link:"reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitorRegistry.html", type:"class", deprecated:"false" }, + { id:203, label:"android.support.test.runner.lifecycle.ApplicationLifecycleCallback", link:"reference/android/support/test/runner/lifecycle/ApplicationLifecycleCallback.html", type:"class", deprecated:"false" }, + { id:204, label:"android.support.test.runner.lifecycle.ApplicationLifecycleMonitor", link:"reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitor.html", type:"class", deprecated:"false" }, + { id:205, label:"android.support.test.runner.lifecycle.ApplicationLifecycleMonitorRegistry", link:"reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitorRegistry.html", type:"class", deprecated:"false" }, + { id:206, label:"android.support.test.runner.lifecycle.ApplicationStage", link:"reference/android/support/test/runner/lifecycle/ApplicationStage.html", type:"class", deprecated:"false" }, + { id:207, label:"android.support.test.runner.lifecycle.Stage", link:"reference/android/support/test/runner/lifecycle/Stage.html", type:"class", deprecated:"false" }, + { id:208, label:"android.support.test.uiautomator", link:"reference/android/support/test/uiautomator/package-summary.html", type:"package", deprecated:"false" }, + { id:209, label:"android.support.test.uiautomator.By", link:"reference/android/support/test/uiautomator/By.html", type:"class", deprecated:"false" }, + { id:210, label:"android.support.test.uiautomator.BySelector", link:"reference/android/support/test/uiautomator/BySelector.html", type:"class", deprecated:"false" }, + { id:211, label:"android.support.test.uiautomator.Configurator", link:"reference/android/support/test/uiautomator/Configurator.html", type:"class", deprecated:"false" }, + { id:212, label:"android.support.test.uiautomator.Direction", link:"reference/android/support/test/uiautomator/Direction.html", type:"class", deprecated:"false" }, + { id:213, label:"android.support.test.uiautomator.EventCondition", link:"reference/android/support/test/uiautomator/EventCondition.html", type:"class", deprecated:"false" }, + { id:214, label:"android.support.test.uiautomator.IAutomationSupport", link:"reference/android/support/test/uiautomator/IAutomationSupport.html", type:"class", deprecated:"false" }, + { id:215, label:"android.support.test.uiautomator.SearchCondition", link:"reference/android/support/test/uiautomator/SearchCondition.html", type:"class", deprecated:"false" }, + { id:216, label:"android.support.test.uiautomator.StaleObjectException", link:"reference/android/support/test/uiautomator/StaleObjectException.html", type:"class", deprecated:"false" }, + { id:217, label:"android.support.test.uiautomator.UiAutomatorInstrumentationTestRunner", link:"reference/android/support/test/uiautomator/UiAutomatorInstrumentationTestRunner.html", type:"class", deprecated:"false" }, + { id:218, label:"android.support.test.uiautomator.UiAutomatorTestCase", link:"reference/android/support/test/uiautomator/UiAutomatorTestCase.html", type:"class", deprecated:"true" }, + { id:219, label:"android.support.test.uiautomator.UiCollection", link:"reference/android/support/test/uiautomator/UiCollection.html", type:"class", deprecated:"false" }, + { id:220, label:"android.support.test.uiautomator.UiDevice", link:"reference/android/support/test/uiautomator/UiDevice.html", type:"class", deprecated:"false" }, + { id:221, label:"android.support.test.uiautomator.UiObject", link:"reference/android/support/test/uiautomator/UiObject.html", type:"class", deprecated:"false" }, + { id:222, label:"android.support.test.uiautomator.UiObject2", link:"reference/android/support/test/uiautomator/UiObject2.html", type:"class", deprecated:"false" }, + { id:223, label:"android.support.test.uiautomator.UiObject2Condition", link:"reference/android/support/test/uiautomator/UiObject2Condition.html", type:"class", deprecated:"false" }, + { id:224, label:"android.support.test.uiautomator.UiObjectNotFoundException", link:"reference/android/support/test/uiautomator/UiObjectNotFoundException.html", type:"class", deprecated:"false" }, + { id:225, label:"android.support.test.uiautomator.UiScrollable", link:"reference/android/support/test/uiautomator/UiScrollable.html", type:"class", deprecated:"false" }, + { id:226, label:"android.support.test.uiautomator.UiSelector", link:"reference/android/support/test/uiautomator/UiSelector.html", type:"class", deprecated:"false" }, + { id:227, label:"android.support.test.uiautomator.UiWatcher", link:"reference/android/support/test/uiautomator/UiWatcher.html", type:"class", deprecated:"false" }, + { id:228, label:"android.support.test.uiautomator.Until", link:"reference/android/support/test/uiautomator/Until.html", type:"class", deprecated:"false" } + + ]; diff --git a/docs/html/reference/android/support/test/navtree_data.js b/docs/html/reference/android/support/test/navtree_data.js new file mode 100644 index 000000000000..7ac853258246 --- /dev/null +++ b/docs/html/reference/android/support/test/navtree_data.js @@ -0,0 +1,84 @@ +var NAVTREE_DATA = +[ [ "android.support.test", "reference/android/support/test/package-summary.html", [ [ "Classes", null, [ [ "InstrumentationRegistry", "reference/android/support/test/InstrumentationRegistry.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.annotation", "reference/android/support/test/annotation/package-summary.html", [ [ "Annotations", null, [ [ "Beta", "reference/android/support/test/annotation/Beta.html", null, null ], [ "UiThreadTest", "reference/android/support/test/annotation/UiThreadTest.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso", "reference/android/support/test/espresso/package-summary.html", [ [ "Interfaces", null, [ [ "BaseLayerComponent", "reference/android/support/test/espresso/BaseLayerComponent.html", null, null ], [ "EspressoException", "reference/android/support/test/espresso/EspressoException.html", null, null ], [ "FailureHandler", "reference/android/support/test/espresso/FailureHandler.html", null, null ], [ "IdlingResource", "reference/android/support/test/espresso/IdlingResource.html", null, null ], [ "IdlingResource.ResourceCallback", "reference/android/support/test/espresso/IdlingResource.ResourceCallback.html", null, null ], [ "UiController", "reference/android/support/test/espresso/UiController.html", null, null ], [ "ViewAction", "reference/android/support/test/espresso/ViewAction.html", null, null ], [ "ViewAssertion", "reference/android/support/test/espresso/ViewAssertion.html", null, null ], [ "ViewFinder", "reference/android/support/test/espresso/ViewFinder.html", null, null ], [ "ViewInteractionComponent", "reference/android/support/test/espresso/ViewInteractionComponent.html", null, null ] ] +, null ], [ "Classes", null, [ [ "AmbiguousViewMatcherException.Builder", "reference/android/support/test/espresso/AmbiguousViewMatcherException.Builder.html", null, null ], [ "DataInteraction", "reference/android/support/test/espresso/DataInteraction.html", null, null ], [ "Espresso", "reference/android/support/test/espresso/Espresso.html", null, null ], [ "GraphHolder", "reference/android/support/test/espresso/GraphHolder.html", null, null ], [ "IdlingPolicies", "reference/android/support/test/espresso/IdlingPolicies.html", null, null ], [ "IdlingPolicy", "reference/android/support/test/espresso/IdlingPolicy.html", null, null ], [ "NoMatchingViewException.Builder", "reference/android/support/test/espresso/NoMatchingViewException.Builder.html", null, null ], [ "PerformException.Builder", "reference/android/support/test/espresso/PerformException.Builder.html", null, null ], [ "Root", "reference/android/support/test/espresso/Root.html", null, null ], [ "Root.Builder", "reference/android/support/test/espresso/Root.Builder.html", null, null ], [ "ViewInteraction", "reference/android/support/test/espresso/ViewInteraction.html", null, null ] ] +, null ], [ "Exceptions", null, [ [ "AmbiguousViewMatcherException", "reference/android/support/test/espresso/AmbiguousViewMatcherException.html", null, null ], [ "AppNotIdleException", "reference/android/support/test/espresso/AppNotIdleException.html", null, null ], [ "IdlingResourceTimeoutException", "reference/android/support/test/espresso/IdlingResourceTimeoutException.html", null, null ], [ "InjectEventSecurityException", "reference/android/support/test/espresso/InjectEventSecurityException.html", null, null ], [ "NoActivityResumedException", "reference/android/support/test/espresso/NoActivityResumedException.html", null, null ], [ "NoMatchingRootException", "reference/android/support/test/espresso/NoMatchingRootException.html", null, null ], [ "NoMatchingViewException", "reference/android/support/test/espresso/NoMatchingViewException.html", null, null ], [ "PerformException", "reference/android/support/test/espresso/PerformException.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.action", "reference/android/support/test/espresso/action/package-summary.html", [ [ "Interfaces", null, [ [ "AdapterViewProtocol", "reference/android/support/test/espresso/action/AdapterViewProtocol.html", null, null ], [ "AdapterViewProtocol.DataFunction", "reference/android/support/test/espresso/action/AdapterViewProtocol.DataFunction.html", null, null ], [ "CoordinatesProvider", "reference/android/support/test/espresso/action/CoordinatesProvider.html", null, null ], [ "PrecisionDescriber", "reference/android/support/test/espresso/action/PrecisionDescriber.html", null, null ], [ "Swiper", "reference/android/support/test/espresso/action/Swiper.html", null, null ], [ "Tapper", "reference/android/support/test/espresso/action/Tapper.html", null, null ] ] +, null ], [ "Classes", null, [ [ "AdapterDataLoaderAction", "reference/android/support/test/espresso/action/AdapterDataLoaderAction.html", null, null ], [ "AdapterViewProtocol.AdaptedData", "reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.html", null, null ], [ "AdapterViewProtocol.AdaptedData.Builder", "reference/android/support/test/espresso/action/AdapterViewProtocol.AdaptedData.Builder.html", null, null ], [ "AdapterViewProtocols", "reference/android/support/test/espresso/action/AdapterViewProtocols.html", null, null ], [ "CloseKeyboardAction", "reference/android/support/test/espresso/action/CloseKeyboardAction.html", null, null ], [ "EditorAction", "reference/android/support/test/espresso/action/EditorAction.html", null, null ], [ "EspressoKey", "reference/android/support/test/espresso/action/EspressoKey.html", null, null ], [ "EspressoKey.Builder", "reference/android/support/test/espresso/action/EspressoKey.Builder.html", null, null ], [ "GeneralClickAction", "reference/android/support/test/espresso/action/GeneralClickAction.html", null, null ], [ "GeneralSwipeAction", "reference/android/support/test/espresso/action/GeneralSwipeAction.html", null, null ], [ "KeyEventAction", "reference/android/support/test/espresso/action/KeyEventAction.html", null, null ], [ "MotionEvents", "reference/android/support/test/espresso/action/MotionEvents.html", null, null ], [ "MotionEvents.DownResultHolder", "reference/android/support/test/espresso/action/MotionEvents.DownResultHolder.html", null, null ], [ "OpenLinkAction", "reference/android/support/test/espresso/action/OpenLinkAction.html", null, null ], [ "ReplaceTextAction", "reference/android/support/test/espresso/action/ReplaceTextAction.html", null, null ], [ "ScrollToAction", "reference/android/support/test/espresso/action/ScrollToAction.html", null, null ], [ "TypeTextAction", "reference/android/support/test/espresso/action/TypeTextAction.html", null, null ], [ "ViewActions", "reference/android/support/test/espresso/action/ViewActions.html", null, null ] ] +, null ], [ "Enums", null, [ [ "GeneralLocation", "reference/android/support/test/espresso/action/GeneralLocation.html", null, null ], [ "Press", "reference/android/support/test/espresso/action/Press.html", null, null ], [ "Swipe", "reference/android/support/test/espresso/action/Swipe.html", null, null ], [ "Swiper.Status", "reference/android/support/test/espresso/action/Swiper.Status.html", null, null ], [ "Tap", "reference/android/support/test/espresso/action/Tap.html", null, null ], [ "Tapper.Status", "reference/android/support/test/espresso/action/Tapper.Status.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.assertion", "reference/android/support/test/espresso/assertion/package-summary.html", [ [ "Classes", null, [ [ "LayoutAssertions", "reference/android/support/test/espresso/assertion/LayoutAssertions.html", null, null ], [ "PositionAssertions", "reference/android/support/test/espresso/assertion/PositionAssertions.html", null, null ], [ "ViewAssertions", "reference/android/support/test/espresso/assertion/ViewAssertions.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.base", "reference/android/support/test/espresso/base/package-summary.html", [ [ "Annotations", null, [ [ "Default", "reference/android/support/test/espresso/base/Default.html", null, null ], [ "MainThread", "reference/android/support/test/espresso/base/MainThread.html", null, null ] ] +, null ], [ "Interfaces", null, [ [ "ActiveRootLister", "reference/android/support/test/espresso/base/ActiveRootLister.html", null, null ] ] +, null ], [ "Classes", null, [ [ "BaseLayerModule", "reference/android/support/test/espresso/base/BaseLayerModule.html", null, null ], [ "BaseLayerModule.FailureHandlerHolder", "reference/android/support/test/espresso/base/BaseLayerModule.FailureHandlerHolder.html", null, null ], [ "DefaultFailureHandler", "reference/android/support/test/espresso/base/DefaultFailureHandler.html", null, null ], [ "IdlingResourceRegistry", "reference/android/support/test/espresso/base/IdlingResourceRegistry.html", null, null ], [ "RootViewPicker", "reference/android/support/test/espresso/base/RootViewPicker.html", null, null ], [ "UiControllerModule", "reference/android/support/test/espresso/base/UiControllerModule.html", null, null ], [ "ViewFinderImpl", "reference/android/support/test/espresso/base/ViewFinderImpl.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.contrib", "reference/android/support/test/espresso/contrib/package-summary.html", [ [ "Interfaces", null, [ [ "RecyclerViewActions.PositionableRecyclerViewAction", "reference/android/support/test/espresso/contrib/RecyclerViewActions.PositionableRecyclerViewAction.html", null, null ] ] +, null ], [ "Classes", null, [ [ "AccessibilityChecks", "reference/android/support/test/espresso/contrib/AccessibilityChecks.html", null, null ], [ "CountingIdlingResource", "reference/android/support/test/espresso/contrib/CountingIdlingResource.html", null, null ], [ "DrawerActions", "reference/android/support/test/espresso/contrib/DrawerActions.html", null, null ], [ "DrawerMatchers", "reference/android/support/test/espresso/contrib/DrawerMatchers.html", null, null ], [ "NavigationViewActions", "reference/android/support/test/espresso/contrib/NavigationViewActions.html", null, null ], [ "PickerActions", "reference/android/support/test/espresso/contrib/PickerActions.html", null, null ], [ "RecyclerViewActions", "reference/android/support/test/espresso/contrib/RecyclerViewActions.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.idling", "reference/android/support/test/espresso/idling/package-summary.html", [ [ "Classes", null, [ [ "CountingIdlingResource", "reference/android/support/test/espresso/idling/CountingIdlingResource.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.intent", "reference/android/support/test/espresso/intent/package-summary.html", [ [ "Interfaces", null, [ [ "ResettingStubber", "reference/android/support/test/espresso/intent/ResettingStubber.html", null, null ], [ "ResolvedIntent", "reference/android/support/test/espresso/intent/ResolvedIntent.html", null, null ], [ "VerifiableIntent", "reference/android/support/test/espresso/intent/VerifiableIntent.html", null, null ], [ "VerificationMode", "reference/android/support/test/espresso/intent/VerificationMode.html", null, null ] ] +, null ], [ "Classes", null, [ [ "Checks", "reference/android/support/test/espresso/intent/Checks.html", null, null ], [ "Intents", "reference/android/support/test/espresso/intent/Intents.html", null, null ], [ "OngoingStubbing", "reference/android/support/test/espresso/intent/OngoingStubbing.html", null, null ], [ "ResettingStubberImpl", "reference/android/support/test/espresso/intent/ResettingStubberImpl.html", null, null ], [ "VerificationModes", "reference/android/support/test/espresso/intent/VerificationModes.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.intent.matcher", "reference/android/support/test/espresso/intent/matcher/package-summary.html", [ [ "Classes", null, [ [ "BundleMatchers", "reference/android/support/test/espresso/intent/matcher/BundleMatchers.html", null, null ], [ "ComponentNameMatchers", "reference/android/support/test/espresso/intent/matcher/ComponentNameMatchers.html", null, null ], [ "IntentMatchers", "reference/android/support/test/espresso/intent/matcher/IntentMatchers.html", null, null ], [ "UriMatchers", "reference/android/support/test/espresso/intent/matcher/UriMatchers.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.intent.rule", "reference/android/support/test/espresso/intent/rule/package-summary.html", [ [ "Classes", null, [ [ "IntentsTestRule", "reference/android/support/test/espresso/intent/rule/IntentsTestRule.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.matcher", "reference/android/support/test/espresso/matcher/package-summary.html", [ [ "Classes", null, [ [ "BoundedMatcher", "reference/android/support/test/espresso/matcher/BoundedMatcher.html", null, null ], [ "CursorMatchers", "reference/android/support/test/espresso/matcher/CursorMatchers.html", null, null ], [ "CursorMatchers.CursorMatcher", "reference/android/support/test/espresso/matcher/CursorMatchers.CursorMatcher.html", null, null ], [ "LayoutMatchers", "reference/android/support/test/espresso/matcher/LayoutMatchers.html", null, null ], [ "PreferenceMatchers", "reference/android/support/test/espresso/matcher/PreferenceMatchers.html", null, null ], [ "RootMatchers", "reference/android/support/test/espresso/matcher/RootMatchers.html", null, null ], [ "ViewMatchers", "reference/android/support/test/espresso/matcher/ViewMatchers.html", null, null ] ] +, null ], [ "Enums", null, [ [ "ViewMatchers.Visibility", "reference/android/support/test/espresso/matcher/ViewMatchers.Visibility.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.util", "reference/android/support/test/espresso/util/package-summary.html", [ [ "Classes", null, [ [ "ActivityLifecycles", "reference/android/support/test/espresso/util/ActivityLifecycles.html", null, null ], [ "HumanReadables", "reference/android/support/test/espresso/util/HumanReadables.html", null, null ], [ "TreeIterables", "reference/android/support/test/espresso/util/TreeIterables.html", null, null ], [ "TreeIterables.ViewAndDistance", "reference/android/support/test/espresso/util/TreeIterables.ViewAndDistance.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.web.action", "reference/android/support/test/espresso/web/action/package-summary.html", [ [ "Classes", null, [ [ "AtomAction", "reference/android/support/test/espresso/web/action/AtomAction.html", null, null ], [ "EnableJavascriptAction", "reference/android/support/test/espresso/web/action/EnableJavascriptAction.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.web.assertion", "reference/android/support/test/espresso/web/assertion/package-summary.html", [ [ "Interfaces", null, [ [ "WebViewAssertions.ResultDescriber", "reference/android/support/test/espresso/web/assertion/WebViewAssertions.ResultDescriber.html", null, null ] ] +, null ], [ "Classes", null, [ [ "TagSoupDocumentParser", "reference/android/support/test/espresso/web/assertion/TagSoupDocumentParser.html", null, null ], [ "WebAssertion", "reference/android/support/test/espresso/web/assertion/WebAssertion.html", null, null ], [ "WebViewAssertions", "reference/android/support/test/espresso/web/assertion/WebViewAssertions.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.web.bridge", "reference/android/support/test/espresso/web/bridge/package-summary.html", [ [ "Classes", null, [ [ "Conduit", "reference/android/support/test/espresso/web/bridge/Conduit.html", null, null ], [ "JavaScriptBridge", "reference/android/support/test/espresso/web/bridge/JavaScriptBridge.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.web.matcher", "reference/android/support/test/espresso/web/matcher/package-summary.html", [ [ "Classes", null, [ [ "DomMatchers", "reference/android/support/test/espresso/web/matcher/DomMatchers.html", null, null ] ] +, null ], [ "Exceptions", null, [ [ "AmbiguousElementMatcherException", "reference/android/support/test/espresso/web/matcher/AmbiguousElementMatcherException.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.web.model", "reference/android/support/test/espresso/web/model/package-summary.html", [ [ "Interfaces", null, [ [ "Atom", "reference/android/support/test/espresso/web/model/Atom.html", null, null ], [ "JSONAble", "reference/android/support/test/espresso/web/model/JSONAble.html", null, null ], [ "JSONAble.DeJSONFactory", "reference/android/support/test/espresso/web/model/JSONAble.DeJSONFactory.html", null, null ], [ "TransformingAtom.Transformer", "reference/android/support/test/espresso/web/model/TransformingAtom.Transformer.html", null, null ] ] +, null ], [ "Classes", null, [ [ "Atoms", "reference/android/support/test/espresso/web/model/Atoms.html", null, null ], [ "ElementReference", "reference/android/support/test/espresso/web/model/ElementReference.html", null, null ], [ "Evaluation", "reference/android/support/test/espresso/web/model/Evaluation.html", null, null ], [ "ModelCodec", "reference/android/support/test/espresso/web/model/ModelCodec.html", null, null ], [ "SimpleAtom", "reference/android/support/test/espresso/web/model/SimpleAtom.html", null, null ], [ "TransformingAtom", "reference/android/support/test/espresso/web/model/TransformingAtom.html", null, null ], [ "WindowReference", "reference/android/support/test/espresso/web/model/WindowReference.html", null, null ] ] +, null ], [ "Enums", null, [ [ "SimpleAtom.ElementReferencePlacement", "reference/android/support/test/espresso/web/model/SimpleAtom.ElementReferencePlacement.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.web.sugar", "reference/android/support/test/espresso/web/sugar/package-summary.html", [ [ "Classes", null, [ [ "Web", "reference/android/support/test/espresso/web/sugar/Web.html", null, null ], [ "Web.WebInteraction", "reference/android/support/test/espresso/web/sugar/Web.WebInteraction.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.espresso.web.webdriver", "reference/android/support/test/espresso/web/webdriver/package-summary.html", [ [ "Classes", null, [ [ "DriverAtoms", "reference/android/support/test/espresso/web/webdriver/DriverAtoms.html", null, null ] ] +, null ], [ "Enums", null, [ [ "Locator", "reference/android/support/test/espresso/web/webdriver/Locator.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.filters", "reference/android/support/test/filters/package-summary.html", [ [ "Annotations", null, [ [ "FlakyTest", "reference/android/support/test/filters/FlakyTest.html", null, null ], [ "LargeTest", "reference/android/support/test/filters/LargeTest.html", null, null ], [ "MediumTest", "reference/android/support/test/filters/MediumTest.html", null, null ], [ "RequiresDevice", "reference/android/support/test/filters/RequiresDevice.html", null, null ], [ "SdkSuppress", "reference/android/support/test/filters/SdkSuppress.html", null, null ], [ "SmallTest", "reference/android/support/test/filters/SmallTest.html", null, null ], [ "Suppress", "reference/android/support/test/filters/Suppress.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.jank", "reference/android/support/test/jank/package-summary.html", [ [ "Annotations", null, [ [ "GfxMonitor", "reference/android/support/test/jank/GfxMonitor.html", null, null ], [ "JankTest", "reference/android/support/test/jank/JankTest.html", null, null ] ] +, null ], [ "Interfaces", null, [ [ "IMonitor", "reference/android/support/test/jank/IMonitor.html", null, null ], [ "IMonitorFactory", "reference/android/support/test/jank/IMonitorFactory.html", null, null ] ] +, null ], [ "Classes", null, [ [ "JankTestBase", "reference/android/support/test/jank/JankTestBase.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.jank.annotations", "reference/android/support/test/jank/annotations/package-summary.html", [ [ "Annotations", null, [ [ "UseMonitorFactory", "reference/android/support/test/jank/annotations/UseMonitorFactory.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.rule", "reference/android/support/test/rule/package-summary.html", [ [ "Classes", null, [ [ "ActivityTestRule", "reference/android/support/test/rule/ActivityTestRule.html", null, null ], [ "DisableOnAndroidDebug", "reference/android/support/test/rule/DisableOnAndroidDebug.html", null, null ], [ "ServiceTestRule", "reference/android/support/test/rule/ServiceTestRule.html", null, null ], [ "UiThreadTestRule", "reference/android/support/test/rule/UiThreadTestRule.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.rule.logging", "reference/android/support/test/rule/logging/package-summary.html", [ [ "Classes", null, [ [ "AtraceLogger", "reference/android/support/test/rule/logging/AtraceLogger.html", null, null ], [ "EnableTestTracingRule", "reference/android/support/test/rule/logging/EnableTestTracingRule.html", null, null ], [ "LogBatteryInformationRule", "reference/android/support/test/rule/logging/LogBatteryInformationRule.html", null, null ], [ "LogDeviceGetPropInfoRule", "reference/android/support/test/rule/logging/LogDeviceGetPropInfoRule.html", null, null ], [ "LoggingBaseRule", "reference/android/support/test/rule/logging/LoggingBaseRule.html", null, null ], [ "LogGraphicsStatsRule", "reference/android/support/test/rule/logging/LogGraphicsStatsRule.html", null, null ], [ "LogLogcatRule", "reference/android/support/test/rule/logging/LogLogcatRule.html", null, null ], [ "LogNetStatsRule", "reference/android/support/test/rule/logging/LogNetStatsRule.html", null, null ], [ "RuleLoggingUtils", "reference/android/support/test/rule/logging/RuleLoggingUtils.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.runner", "reference/android/support/test/runner/package-summary.html", [ [ "Classes", null, [ [ "AndroidJUnit4", "reference/android/support/test/runner/AndroidJUnit4.html", null, null ], [ "AndroidJUnitRunner", "reference/android/support/test/runner/AndroidJUnitRunner.html", null, null ], [ "MonitoringInstrumentation", "reference/android/support/test/runner/MonitoringInstrumentation.html", null, null ], [ "MonitoringInstrumentation.ActivityFinisher", "reference/android/support/test/runner/MonitoringInstrumentation.ActivityFinisher.html", null, null ], [ "UsageTrackerFacilitator", "reference/android/support/test/runner/UsageTrackerFacilitator.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.runner.intent", "reference/android/support/test/runner/intent/package-summary.html", [ [ "Interfaces", null, [ [ "IntentCallback", "reference/android/support/test/runner/intent/IntentCallback.html", null, null ], [ "IntentMonitor", "reference/android/support/test/runner/intent/IntentMonitor.html", null, null ], [ "IntentStubber", "reference/android/support/test/runner/intent/IntentStubber.html", null, null ] ] +, null ], [ "Classes", null, [ [ "IntentMonitorRegistry", "reference/android/support/test/runner/intent/IntentMonitorRegistry.html", null, null ], [ "IntentStubberRegistry", "reference/android/support/test/runner/intent/IntentStubberRegistry.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.runner.lifecycle", "reference/android/support/test/runner/lifecycle/package-summary.html", [ [ "Interfaces", null, [ [ "ActivityLifecycleCallback", "reference/android/support/test/runner/lifecycle/ActivityLifecycleCallback.html", null, null ], [ "ActivityLifecycleMonitor", "reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitor.html", null, null ], [ "ApplicationLifecycleCallback", "reference/android/support/test/runner/lifecycle/ApplicationLifecycleCallback.html", null, null ], [ "ApplicationLifecycleMonitor", "reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitor.html", null, null ] ] +, null ], [ "Classes", null, [ [ "ActivityLifecycleMonitorRegistry", "reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitorRegistry.html", null, null ], [ "ApplicationLifecycleMonitorRegistry", "reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitorRegistry.html", null, null ] ] +, null ], [ "Enums", null, [ [ "ApplicationStage", "reference/android/support/test/runner/lifecycle/ApplicationStage.html", null, null ], [ "Stage", "reference/android/support/test/runner/lifecycle/Stage.html", null, null ] ] +, null ] ] +, null ], [ "android.support.test.uiautomator", "reference/android/support/test/uiautomator/package-summary.html", [ [ "Interfaces", null, [ [ "IAutomationSupport", "reference/android/support/test/uiautomator/IAutomationSupport.html", null, null ], [ "UiWatcher", "reference/android/support/test/uiautomator/UiWatcher.html", null, null ] ] +, null ], [ "Classes", null, [ [ "By", "reference/android/support/test/uiautomator/By.html", null, null ], [ "BySelector", "reference/android/support/test/uiautomator/BySelector.html", null, null ], [ "Configurator", "reference/android/support/test/uiautomator/Configurator.html", null, null ], [ "EventCondition", "reference/android/support/test/uiautomator/EventCondition.html", null, null ], [ "SearchCondition", "reference/android/support/test/uiautomator/SearchCondition.html", null, null ], [ "UiAutomatorInstrumentationTestRunner", "reference/android/support/test/uiautomator/UiAutomatorInstrumentationTestRunner.html", null, null ], [ "UiAutomatorTestCase", "reference/android/support/test/uiautomator/UiAutomatorTestCase.html", null, null ], [ "UiCollection", "reference/android/support/test/uiautomator/UiCollection.html", null, null ], [ "UiDevice", "reference/android/support/test/uiautomator/UiDevice.html", null, null ], [ "UiObject", "reference/android/support/test/uiautomator/UiObject.html", null, null ], [ "UiObject2", "reference/android/support/test/uiautomator/UiObject2.html", null, null ], [ "UiObject2Condition", "reference/android/support/test/uiautomator/UiObject2Condition.html", null, null ], [ "UiScrollable", "reference/android/support/test/uiautomator/UiScrollable.html", null, null ], [ "UiSelector", "reference/android/support/test/uiautomator/UiSelector.html", null, null ], [ "Until", "reference/android/support/test/uiautomator/Until.html", null, null ] ] +, null ], [ "Enums", null, [ [ "Direction", "reference/android/support/test/uiautomator/Direction.html", null, null ] ] +, null ], [ "Exceptions", null, [ [ "StaleObjectException", "reference/android/support/test/uiautomator/StaleObjectException.html", null, null ], [ "UiObjectNotFoundException", "reference/android/support/test/uiautomator/UiObjectNotFoundException.html", null, null ] ] +, null ] ] +, null ] ] + +; diff --git a/docs/html/reference/android/support/test/package-summary.html b/docs/html/reference/android/support/test/package-summary.html index 8b6154178cb0..7d72242a92f2 100644 --- a/docs/html/reference/android/support/test/package-summary.html +++ b/docs/html/reference/android/support/test/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,722 +92,126 @@ - - - - - - -android.support.test | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test

    -
    - -
    - -
    - - - +

    android.support.test

    + + +

    Classes

    -
    - - + + - + - + + + +
    InstrumentationRegistryInstrumentationRegistry An exposed registry instance that holds a reference to the instrumentation running in the process and it's arguments.  - - + +
    + -
    -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + + + + + +
    + + +
    + + + +
    + diff --git a/docs/html/reference/android/support/test/rule/ActivityTestRule.html b/docs/html/reference/android/support/test/rule/ActivityTestRule.html index f34e3e9b20f1..77a6ca1c195d 100644 --- a/docs/html/reference/android/support/test/rule/ActivityTestRule.html +++ b/docs/html/reference/android/support/test/rule/ActivityTestRule.html @@ -1,5 +1,3 @@ - - @@ -92,499 +90,101 @@ - - - - - - - -ActivityTestRule | Android Developers - - - - - - - - - - - - - - - - - - - -
    - + - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    ActivityTestRule

    - - - - - - - - - extends UiThreadTestRule
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - +

    ActivityTestRule

    +

    + + public + + + + class + ActivityTestRule + +
    + + + + + + + + + + + extends UiThreadTestRule + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.rule.UiThreadTestRule
        ↳android.support.test.rule.ActivityTestRule<T extends android.app.Activity>
    + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.rule.UiThreadTestRule +
        ↳android.support.test.rule.ActivityTestRule<T extends android.app.Activity> +
    - - - - - +
    - + +
    + Known Direct Subclasses - +
    -
    - - +
    + + + -
    +

    -

    Class Overview

    -

    This rule provides functional testing of a single activity. The activity under test will be +

    This rule provides functional testing of a single activity. The activity under test will be launched before each test annotated with Test and before methods annotated with @@ -754,13 +350,9 @@ Summary: -

    - - - - +

    Summary

    @@ -771,15 +363,6 @@ Summary: -
    - - -

    Summary

    - - - - - @@ -793,911 +376,985 @@ Summary: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + ActivityTestRule(Class<T> activityClass) + + +

    Similar to ActivityTestRule(Class, boolean, boolean) but with "touch mode" disabled. + + +

    + +
    + + ActivityTestRule(Class<T> activityClass, boolean initialTouchMode) + + +

    Similar to ActivityTestRule(Class, boolean, boolean) but defaults to launch the + activity under test once per + Test method. + + +

    + +
    + + ActivityTestRule(Class<T> activityClass, boolean initialTouchMode, boolean launchActivity) + + +

    Creates an ActivityTestRule for the Activity under test. + + +

    + +
    - - + +
    Public Constructors
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -

    Public methods

    + + + + + + Statement + + + apply(Statement base, Description description) + + +
    + + + + + + T + + + getActivity() + + +
    + + + + + + T + + + launchActivity(Intent startIntent) + + +

    Launches the Activity under test. + + +

    + +
    +
    - -
    - ActivityTestRule(Class<T> activityClass) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -
    - Similar to ActivityTestRule(Class, boolean, boolean) but with "touch mode" disabled. +

    Protected methods

    + + + + + + void + + + afterActivityFinished() + + +

    Override this method to execute any code that should run after your Activity is + finished. + + +

    + +
    + + + + + + void + + + afterActivityLaunched() + + +

    Override this method to execute any code that should run after your Activity is + launched, but before any test code is run including any method annotated with + Before. + + +

    + +
    + + + + + + void + + + beforeActivityLaunched() + + +

    Override this method to execute any code that should run before your Activity is + created and launched. + + +

    + +
    + + + + + + Intent + + + getActivityIntent() + + +

    Override this method to set up Intent as if supplied to + startActivity(Intent). + + +

    + +
    - -
    + - - + - - - + - + + + From +interface + + + org.junit.rules.TestRule + + +
    + +

    Inherited methods

    +
    + From +class + + + android.support.test.rule.UiThreadTestRule + + +
    + + +
    +
    - ActivityTestRule(Class<T> activityClass, boolean initialTouchMode) +
    -
    - Similar to ActivityTestRule(Class, boolean, boolean) but defaults to launch the - activity under test once per - Test method. + From +class + + + java.lang.Object + + +
    + + +
    +
    -
    + + + + + + + + + + + + + + +
    + abstract + + + + + Statement + + + apply(Statement arg0, Description arg1) + + +
    +
    +
    +
    -
    + + - - - ActivityTestRule(Class<T> activityClass, boolean initialTouchMode, boolean launchActivity) -
    - Creates an ActivityTestRule for the Activity under test. + + -
    -
    + +
    +

    ActivityTestRule

    +
    +
    + + +
    +
    +ActivityTestRule (Class<T> activityClass)
    + + + + +

    Similar to ActivityTestRule(Class, boolean, boolean) but with "touch mode" disabled.

    + + + + + + +
    Parameters
    activityClass + Class: + The activity under test. This must be a class in the instrumentation + targetPackage specified in the AndroidManifest.xml
    + +
    - - + +
    +

    ActivityTestRule

    +
    +
    + + +
    +
    +ActivityTestRule (Class<T> activityClass, 
    +                boolean initialTouchMode)
    + + + + +

    Similar to ActivityTestRule(Class, boolean, boolean) but defaults to launch the + activity under test once per + Test method. + It is launched before the first + Before + method, and terminated after the last + After + method.

    +
    Public Methods
    + + + + + + + + + +
    Parameters
    activityClass + Class: + The activity under test. This must be a class in the instrumentation + targetPackage specified in the AndroidManifest.xml
    initialTouchMode + boolean: + true if the Activity should be placed into "touch mode" when started
    + -
    + + +
    +

    ActivityTestRule

    +
    +
    + + +
    +
    +ActivityTestRule (Class<T> activityClass, 
    +                boolean initialTouchMode, 
    +                boolean launchActivity)
    + + + + +

    Creates an ActivityTestRule for the Activity under test.

    + + + + + + + + + + + + + + +
    Parameters
    activityClass + Class: + The activity under test. This must be a class in the instrumentation + targetPackage specified in the AndroidManifest.xml
    initialTouchMode + boolean: + true if the Activity should be placed into "touch mode" when started
    launchActivity + boolean: + true if the Activity should be launched once per + + Test method. It will be launched before the first + + Before method, and terminated after the last + + After method. +
    - Statement
    -
    - apply(Statement base, Description description) + -
    + + + + - T - - getActivity() +

    Public methods

    -
    +
    +

    apply

    +
    +
    + + +
    +
    +Statement apply (Statement base, 
    +                Description description)
    + + + + +

    + + + + + + + + + + +
    Parameters
    base + Statement +
    description + Description +
    + + + + + + +
    Returns
    Statement
    +
    + - T
    -
    - launchActivity(Intent startIntent) +
    +

    getActivity

    +
    +
    + + -
    - Launches the Activity under test. +
    +
    +T getActivity ()
    + + + + +

    + + + + + + +
    Returns
    TThe activity under test. +
    +
    -
    + -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Protected Methods
    - - - - - - void - - afterActivityFinished() - -
    - Override this method to execute any code that should run after your Activity is - finished. - - - -
    - -
    - - - - - - void - - afterActivityLaunched() - -
    - Override this method to execute any code that should run after your Activity is - launched, but before any test code is run including any method annotated with - Before. - - - -
    - -
    - - - - - - void - - beforeActivityLaunched() - -
    - Override this method to execute any code that should run before your Activity is - created and launched. - - - -
    - -
    - - - - - - Intent - - getActivityIntent() - -
    - Override this method to set up Intent as if supplied to - startActivity(Intent). - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - android.support.test.rule.UiThreadTestRule - -
    - - -
    -
    - -From class - - java.lang.Object - -
    - - -
    -
    - -From interface - - org.junit.rules.TestRule - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Constructors

    - - - - - -
    -

    - - public - - - - - - - ActivityTestRule - (Class<T> activityClass) -

    -
    -
    - - - -
    -
    - - - - -

    Similar to ActivityTestRule(Class, boolean, boolean) but with "touch mode" disabled.

    -
    -
    Parameters
    - - - - -
    activityClass - The activity under test. This must be a class in the instrumentation - targetPackage specified in the AndroidManifest.xml
    -
    - - -
    -
    - - - - -
    -

    - - public - - - - - - - ActivityTestRule - (Class<T> activityClass, boolean initialTouchMode) -

    -
    -
    - - - -
    -
    - - - - -

    Similar to ActivityTestRule(Class, boolean, boolean) but defaults to launch the - activity under test once per - Test method. - It is launched before the first - Before - method, and terminated after the last - After - method.

    -
    -
    Parameters
    - - - - - - - -
    activityClass - The activity under test. This must be a class in the instrumentation - targetPackage specified in the AndroidManifest.xml
    initialTouchMode - true if the Activity should be placed into "touch mode" when started
    -
    - - -
    -
    - - - - -
    -

    - - public - - - - - - - ActivityTestRule - (Class<T> activityClass, boolean initialTouchMode, boolean launchActivity) -

    -
    -
    - - - -
    -
    - - - - -

    Creates an ActivityTestRule for the Activity under test.

    -
    -
    Parameters
    - - - - - - - - - - -
    activityClass - The activity under test. This must be a class in the instrumentation - targetPackage specified in the AndroidManifest.xml
    initialTouchMode - true if the Activity should be placed into "touch mode" when started
    launchActivity - true if the Activity should be launched once per - - Test method. It will be launched before the first - - Before method, and terminated after the last - - After method. -
    -
    - -
    -
    - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - - - - - Statement - - apply - (Statement base, Description description) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - T - - getActivity - () -

    -
    -
    - - - -
    -
    - - - - -

    -
    -
    Returns
    -
    • The activity under test. -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - T - - launchActivity - (Intent startIntent) -

    -
    -
    - - - -
    -
    - - - - -

    Launches the Activity under test. + +

    Launches the Activity under test.

    - Don't call this method directly, unless you explicitly requested not to launch the Activity - manually using the launchActivity flag in - ActivityTestRule(Class, boolean, boolean). + Don't call this method directly, unless you explicitly requested not to lazily launch the + Activity manually using the launchActivity flag in + ActivityTestRule(Class, boolean, boolean).

    Usage:

    @@ -1706,29 +1363,31 @@ From interface
             Intent intent = new Intent(Intent.ACTION_PICK);
             mActivity = mActivityRule.launchActivity(intent);
         }
    - 

    -
    -
    Parameters
    - - - + +
    startIntent - The Intent that will be used to start the Activity under test. If +

    + + + + + - -
    Parameters
    startIntent + Intent: + The Intent that will be used to start the Activity under test. If startIntent is null, the Intent returned by - getActivityIntent() is used.
    - -
    -
    Returns
    -
    • the Activity launched by this rule.
    -
    -
    -
    See Also
    -
    + + + + + + +
    Returns
    Tthe Activity launched by this rule.
    +
    +

    See also:

    +
    -
    @@ -1737,73 +1396,52 @@ From interface -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - - - void - - afterActivityFinished - () -

    -
    -
    - - - -
    -
    - - +
    +

    afterActivityFinished

    +
    +
    + + +
    +
    +void afterActivityFinished ()
    + + -

    Override this method to execute any code that should run after your Activity is + +

    Override this method to execute any code that should run after your Activity is finished. This method is called after each test method, including any method annotated with After. -

    +

    -
    -
    -

    - - protected - - - - - void - - afterActivityLaunched - () -

    -
    -
    - - - -
    -
    - - +
    +

    afterActivityLaunched

    +
    +
    + + +
    +
    +void afterActivityLaunched ()
    + + -

    Override this method to execute any code that should run after your Activity is + +

    Override this method to execute any code that should run after your Activity is launched, but before any test code is run including any method annotated with Before.

    @@ -1812,88 +1450,68 @@ From interface over this method. This method should usually not be overwritten directly in tests and only be used by subclasses of ActivityTestRule to get notified when the activity is created and visible but test runs. -

    +

    -
    -
    -

    - - protected - - - - - void - - beforeActivityLaunched - () -

    -
    -
    - - - -
    -
    - - +
    +

    beforeActivityLaunched

    +
    +
    + + +
    +
    +void beforeActivityLaunched ()
    + + -

    Override this method to execute any code that should run before your Activity is + +

    Override this method to execute any code that should run before your Activity is created and launched. This method is called before each test method, including any method annotated with Before. -

    +

    -
    -
    -

    - - protected - - - - - Intent - - getActivityIntent - () -

    -
    -
    - - +
    +

    getActivityIntent

    +
    +
    + + -
    -
    - - - - -

    Override this method to set up Intent as if supplied to - startActivity(Intent). +

    +
    +Intent getActivityIntent ()
    + + + + +

    Override this method to set up Intent as if supplied to + startActivity(Intent).

    The default Intent (if this method returns null or is not overwritten) is: - action = ACTION_MAIN - flags = FLAG_ACTIVITY_NEW_TASK - All other intent fields are null or empty.

    -
    -
    Returns
    - -
    + action = ACTION_MAIN + flags = FLAG_ACTIVITY_NEW_TASK + All other intent fields are null or empty.

    + + + + + + +
    Returns
    IntentThe Intent as if supplied to startActivity(Intent). +
    -
    @@ -1901,193 +1519,31 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/rule/DisableOnAndroidDebug.html b/docs/html/reference/android/support/test/rule/DisableOnAndroidDebug.html index a981fe91a257..ff4f10df8714 100644 --- a/docs/html/reference/android/support/test/rule/DisableOnAndroidDebug.html +++ b/docs/html/reference/android/support/test/rule/DisableOnAndroidDebug.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,92 @@ - - - - - - -DisableOnAndroidDebug | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +DisableOnAndroidDebug - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    DisableOnAndroidDebug

    - - - - - extends Object
    - - - - - - +

    DisableOnAndroidDebug

    +

    + + public + + + + class + DisableOnAndroidDebug + +
    + + + + + extends Object + + + + + + + + implements - + TestRule - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + + + + +

    java.lang.Object
       ↳android.support.test.rule.DisableOnAndroidDebug
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.rule.DisableOnAndroidDebug +
    + + +

    - - - -
    - - -

    Class Overview

    -

    The DisableOnAndroidDebug Rule allows you to label certain rules to be +

    The DisableOnAndroidDebug Rule allows you to label certain rules to be disabled when debugging.

    The most illustrative use case is for tests that make use of the - Timeout rule, when ran in debug mode the test may terminate on + Timeout + rule, when ran in debug mode the test may terminate on timeout abruptly during debugging. Developers may disable the timeout, or increase the timeout by making a code change on tests that need debugging and - remember revert the change afterwards or rules such as Timeout that + remember revert the change afterwards or rules such as + Timeout that may be disabled during debugging may be wrapped in a DisableOnDebug.

    The important benefit of this feature is that you can disable such rules @@ -719,27 +312,9 @@ Summary: -

    - - - - - - - - - - - - - - - - -
    -

    Summary

    +

    Summary

    @@ -764,32 +339,28 @@ Summary: - - - - - - - - - +
    Public Constructors
    - - - - - - - - DisableOnAndroidDebug(TestRule rule) - -
    - Wrap another TestRule and conditionally disable it when a debugger is attached. - - - -
    - -
    + + + + + + + + + + +

    Public constructors

    + + DisableOnAndroidDebug(TestRule rule) + + +

    Wrap another TestRule and conditionally disable it when a debugger is attached. + + +

    + +
    @@ -800,56 +371,65 @@ Summary: - - - - - - - - - - - + +
    Public Methods
    + + - final - - - Statement - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - apply(Statement base, Description description) - -
    - - - - - -
    - -
    - - - - - - boolean - - isDebugging() - -
    - Returns true if the VM has a debugger connected. - - - -
    - -
    + + + + final + + Statement + + + apply(Statement base, Description description) + + +

    + + + +

    + +
    + + + + + + boolean + + + isDebugging() + + +

    Returns true if the VM has a debugger connected. + + +

    + +
    @@ -861,207 +441,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1069,41 +718,51 @@ From class - @@ -1112,16 +771,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - org.junit.rules.TestRule + + From +interface + + + org.junit.rules.TestRule + +
    - - - - - - - - - - @@ -1139,49 +788,38 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - DisableOnAndroidDebug - (TestRule rule) -

    -
    -
    - - - -
    -
    - - +
    +

    DisableOnAndroidDebug

    +
    +
    + + - -

    Wrap another TestRule and conditionally disable it when a debugger is attached.

    -
    -
    Parameters
    - - - +
    rule - to disable during debugging + +
    +DisableOnAndroidDebug (TestRule rule)
    + + + + +

    Wrap another TestRule and conditionally disable it when a debugger is attached.

    + + + + + - -
    Parameters
    rule + TestRule: + to disable during debugging
    - +
    -
    @@ -1196,79 +834,83 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - final - - - Statement - - apply - (Statement base, Description description) -

    -
    -
    - - - -
    -
    - - - - -

    -

    +
    +

    apply

    +
    +
    + +
    +
    +Statement apply (Statement base, 
    +                Description description)
    + + + + +

    +

    + + + + + + + + + + +
    Parameters
    base + Statement +
    description + Description +
    + + + + + + +
    Returns
    Statement
    +
    -
    -

    - - public - - - - - boolean - - isDebugging - () -

    -
    -
    - - - -
    -
    - - +
    +

    isDebugging

    +
    +
    + + +
    +
    +boolean isDebugging ()
    + + -

    Returns true if the VM has a debugger connected. This method may be used by test + +

    Returns true if the VM has a debugger connected. This method may be used by test classes to take additional action to disable code paths that interfere with debugging if - required.

    -
    -
    Returns
    -
    • true if a debugger is connected, false otherwise -
    -
    + required.

    + + + + + + +
    Returns
    booleantrue if a debugger is connected, false otherwise +
    -
    @@ -1280,193 +922,31 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/rule/ServiceTestRule.html b/docs/html/reference/android/support/test/rule/ServiceTestRule.html index bbe0c8dda9c5..7e53ae171bfb 100644 --- a/docs/html/reference/android/support/test/rule/ServiceTestRule.html +++ b/docs/html/reference/android/support/test/rule/ServiceTestRule.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,92 @@ - - - - - - -ServiceTestRule | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ServiceTestRule - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    ServiceTestRule

    - - - - - extends Object
    - - - - - - +

    ServiceTestRule

    +

    + + public + + + + class + ServiceTestRule + +
    + + + + + extends Object + + + + + + + + implements - + TestRule - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + + + + +

    java.lang.Object
       ↳android.support.test.rule.ServiceTestRule
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.rule.ServiceTestRule +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A JUnit rule that provides a simplified mechanism to start and shutdown your service before +

    A JUnit rule that provides a simplified mechanism to start and shutdown your service before and after the duration of your test. It also guarantees that the service is successfully connected when starting (or binding to) a service. The service can be started (or bound) using one of the helper methods. It will automatically be stopped (or unbound) after @@ -692,8 +283,8 @@ Summary: After are finished.

    - Note: This rule doesn't support IntentService because it's automatically - destroyed when onHandleIntent(android.content.Intent) finishes + Note: This rule doesn't support IntentService because it's automatically + destroyed when onHandleIntent(android.content.Intent) finishes all outstanding commands. So there is no guarantee to establish a successful connection in a timely manner. @@ -725,27 +316,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -770,33 +343,29 @@ Summary: - - +
    Public Constructors
    + - - - + + + + + + +

    Public constructors

    - - - - - - - - ServiceTestRule() - -
    - Creates a ServiceTestRule with a default timeout of 5 seconds - - - - -
    - -
    + + ServiceTestRule() + + +

    Creates a ServiceTestRule with a default timeout of 5 seconds + + +

    + +
    @@ -807,123 +376,146 @@ Summary: - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -2017,41 +1939,51 @@ From interface - @@ -2059,41 +1991,103 @@ From interface - @@ -2102,16 +2096,6 @@ From interface
    Public Methods
    - - - - - - Statement - - apply(Statement base, Description description) - -
    - - - - - - IBinder - - bindService(Intent intent, ServiceConnection connection, int flags) - -
    - Starts the service under test, in the same way as if it were started by - Context.bindService(Intent, ServiceConnection, flags) with an - Intent that identifies a service. - - - -
    - -
    - - - - - - IBinder - - bindService(Intent intent) - -
    - Works just like - bindService(android.content.Intent, android.content.ServiceConnection, int) except - uses an internal ServiceConnection to guarantee successful bound. - - - -
    - -
    - - - - - - void - - startService(Intent intent) - -
    - Starts the service under test and blocks until the service is connected, in the same way as - if it were started by Context.startService(Intent) with an Intent that identifies a + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - + + +

    + + + + + + + + + + + + + +

    Public methods

    + + + + + + Statement + + + apply(Statement base, Description description) + + +
    + + + + + + IBinder + + + bindService(Intent intent) + + +

    Works just like + bindService(android.content.Intent, android.content.ServiceConnection, int) except + uses an internal ServiceConnection to guarantee successful bound. + + +

    + +
    + + + + + + IBinder + + + bindService(Intent intent, ServiceConnection connection, int flags) + + +

    Starts the service under test, in the same way as if it were started by + Context.bindService(Intent, ServiceConnection, flags) with an + Intent that identifies a service. + + +

    + +
    + + + + + + void + + + startService(Intent intent) + + +

    Starts the service under test and blocks until the service is connected, in the same way as + if it were started by Context.startService(Intent) with an Intent that identifies a service. - - - - - -

    - - - - static - - ServiceTestRule - - withTimeout(long timeout, TimeUnit timeUnit) - -
    - Factory method to create a ServiceTestRule with a custom timeout - - - -
    - -
    + + + static + + + ServiceTestRule + + + withTimeout(long timeout, TimeUnit timeUnit) + + +

    Factory method to create a ServiceTestRule with a custom timeout + + +

    + +
    @@ -932,56 +524,65 @@ Summary: - - - - - - - - - - - - - - - - @@ -1975,41 +1079,859 @@ From class - - - + - Description - - + +
    Protected Methods
    - - - - - - void - - afterService() - -
    - Override this method to do your own service specific clean up after the service is shutdown. - - - -
    - -
    - - - - - - void - - beforeService() - -
    - Override this method to do your own service specific initialization before starting or + + + + + + + + + + + + + + + + + + + + + + - + + +

    + + + +

    Protected methods

    + + + + + + void + + + afterService() + + +

    Override this method to do your own service specific clean up after the service is shutdown. + + +

    + +
    + + + + + + void + + + beforeService() + + +

    Override this method to do your own service specific initialization before starting or binding to the service. - - - - - -

    @@ -991,207 +592,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1199,41 +869,51 @@ From class - @@ -1242,16 +922,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - org.junit.rules.TestRule + + From +interface + + + org.junit.rules.TestRule + +
    -
    - - - - - - - - - @@ -1269,40 +939,29 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - ServiceTestRule - () -

    -
    -
    - - - -
    -
    - - +
    +

    ServiceTestRule

    +
    +
    + + +
    +
    +ServiceTestRule ()
    + + -

    Creates a ServiceTestRule with a default timeout of 5 seconds -

    + +

    Creates a ServiceTestRule with a default timeout of 5 seconds +

    -
    @@ -1317,284 +976,280 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Statement - - apply - (Statement base, Description description) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    apply

    +
    +
    + +
    -
    - +
    +Statement apply (Statement base, 
    +                Description description)
    + + + + +

    + + + + + + + + + + +
    Parameters
    base + Statement +
    description + Description +
    + + + + + + +
    Returns
    Statement
    - - -
    -

    - - public - - - - - IBinder - - bindService - (Intent intent, ServiceConnection connection, int flags) -

    -
    -
    - - - -
    -
    +
    + +
    +

    bindService

    +
    +
    + + -

    Starts the service under test, in the same way as if it were started by - Context.bindService(Intent, ServiceConnection, flags) with an - Intent that identifies a service. However, it waits for - onServiceConnected(android.content.ComponentName, android.os.IBinder) to be called before returning.

    -
    -
    Parameters
    - - - - - - - - - - -
    intent - Identifies the service to connect to. The Intent may - specify either an explicit component name, or a logical - description (action, category, etc) to match an - IntentFilter published by a service.
    connection - Receives information as the service is started and stopped. - This must be a valid ServiceConnection object; it must not be null.
    flags - Operation options for the binding. May be 0, - BIND_AUTO_CREATE, - BIND_DEBUG_UNBIND, - BIND_NOT_FOREGROUND, - BIND_ABOVE_CLIENT, - BIND_ALLOW_OOM_MANAGEMENT, or - BIND_WAIVE_PRIORITY.
    -
    -
    -
    Returns
    -
    • An object whose type is a subclass of IBinder, for making further calls into - the service.
    -
    -
    -
    Throws
    - - - - + +
    +IBinder bindService (Intent intent)
    + + + + +

    Works just like + bindService(android.content.Intent, android.content.ServiceConnection, int) except + uses an internal ServiceConnection to guarantee successful bound. + The operation option flag defaults to BIND_AUTO_CREATE

    +
    SecurityException - if the called doesn't have permission to bind to the given service.
    + + + + + +
    Parameters
    intent + Intent +
    + + + + + + +
    Returns
    IBinder
    + + - + +
    Throws
    TimeoutException - if timed out waiting for a successful connection with the service.TimeoutException
    -
    -
    - - -
    -

    - - public - - - - - IBinder - - bindService - (Intent intent) -

    -
    -
    - - - -
    -
    - - + +
    +

    bindService

    +
    +
    + + -

    Works just like - bindService(android.content.Intent, android.content.ServiceConnection, int) except - uses an internal ServiceConnection to guarantee successful bound. - The operation option flag defaults to BIND_AUTO_CREATE

    -
    -
    Throws
    - + +
    +IBinder bindService (Intent intent, 
    +                ServiceConnection connection, 
    +                int flags)
    + + + + +

    Starts the service under test, in the same way as if it were started by + Context.bindService(Intent, ServiceConnection, flags) with an + Intent that identifies a service. However, it waits for + onServiceConnected(android.content.ComponentName, android.os.IBinder) to be called before returning.

    +
    + + + + + + + + + + + + + +
    Parameters
    intent + Intent: + Identifies the service to connect to. The Intent may + specify either an explicit component name, or a logical + description (action, category, etc) to match an + IntentFilter published by a service.
    connection + ServiceConnection: + Receives information as the service is started and stopped. + This must be a valid ServiceConnection object; it must not be null.
    flags + int: + Operation options for the binding. May be 0, + BIND_AUTO_CREATE, + BIND_DEBUG_UNBIND, + BIND_NOT_FOREGROUND, + BIND_ABOVE_CLIENT, + BIND_ALLOW_OOM_MANAGEMENT, or + BIND_WAIVE_PRIORITY.
    + + + + + + +
    Returns
    IBinderAn object whose type is a subclass of IBinder, for making further calls into + the service.
    + + + + + + - + +
    Throws
    SecurityExceptionif the called doesn't have permission to bind to the given service.
    TimeoutException - TimeoutExceptionif timed out waiting for a successful connection with the service.
    -
    -
    -
    -

    - - public - - - - - void - - startService - (Intent intent) -

    -
    -
    - +
    +

    startService

    +
    +
    + + - -
    -
    - - - - -

    Starts the service under test and blocks until the service is connected, in the same way as - if it were started by Context.startService(Intent) with an Intent that identifies a +

    +
    +void startService (Intent intent)
    + + + + +

    Starts the service under test and blocks until the service is connected, in the same way as + if it were started by Context.startService(Intent) with an Intent that identifies a service. If you use this method to start the service, it is automatically stopped at the end of the test run. However, it also binds to the service and waits for - onServiceConnected(android.content.ComponentName, android.os.IBinder) to be called to ensure successful connection.

    -
    -
    Parameters
    - - -
    intent - An Intent that identifies a service, of the same form as the Intent passed to - Context.startService + onServiceConnected(android.content.ComponentName, android.os.IBinder) to be called to ensure successful connection.

    + + + + + - -
    Parameters
    intent + Intent: + An Intent that identifies a service, of the same form as the Intent passed to + Context.startService (Intent).
    - -
    -
    Throws
    - + +
    + + - + + - +
    Throws
    SecurityException - if you do not have permission to bind to the given service.SecurityExceptionif you do not have permission to bind to the given service.
    TimeoutException - if timed out waiting for a successful connection with the service. + TimeoutExceptionif timed out waiting for a successful connection with the service.
    -
    + - -
    -

    - - public - static - - - - ServiceTestRule - - withTimeout - (long timeout, TimeUnit timeUnit) -

    -
    -
    - - - -
    -
    - - - - -

    Factory method to create a ServiceTestRule with a custom timeout

    -
    -
    Parameters
    - - - - - - - -
    timeout - the amount of time to wait for a service to connect.
    timeUnit - the time unit representing how the timeout parameter should be interpreted
    -
    -
    -
    Returns
    - -
    +
    +

    withTimeout

    +
    +
    + +
    +
    +ServiceTestRule withTimeout (long timeout, 
    +                TimeUnit timeUnit)
    + + + + +

    Factory method to create a ServiceTestRule with a custom timeout

    + + + + + + + + + + +
    Parameters
    timeout + long: + the amount of time to wait for a service to connect.
    timeUnit + TimeUnit: + the time unit representing how the timeout parameter should be interpreted
    + + + + + + +
    Returns
    ServiceTestRulea ServiceTestRule with the desired timeout +
    +
    @@ -1603,80 +1258,58 @@ From interface -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - - - void - - afterService - () -

    -
    -
    - - - -
    -
    - - +
    +

    afterService

    +
    +
    + + +
    +
    +void afterService ()
    + + -

    Override this method to do your own service specific clean up after the service is shutdown. + +

    Override this method to do your own service specific clean up after the service is shutdown. The method is called after each test method is executed including any method annotated with After and after necessary calls to stop (or unbind) the service under test were called. -

    +

    -
    -
    -

    - - protected - - - - - void - - beforeService - () -

    -
    -
    - - - -
    -
    - - +
    +

    beforeService

    +
    +
    + + +
    +
    +void beforeService ()
    + + -

    Override this method to do your own service specific initialization before starting or + +

    Override this method to do your own service specific initialization before starting or binding to the service. The method is called before each test method is executed including any method annotated with Before. Do not start or bind to a service from here! -

    +

    -
    @@ -1684,193 +1317,31 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/rule/UiThreadTestRule.html b/docs/html/reference/android/support/test/rule/UiThreadTestRule.html index e58ef8f7240d..49fdeab91c41 100644 --- a/docs/html/reference/android/support/test/rule/UiThreadTestRule.html +++ b/docs/html/reference/android/support/test/rule/UiThreadTestRule.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,92 @@ - - - - - - -UiThreadTestRule | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +UiThreadTestRule - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    UiThreadTestRule

    - - - - - extends Object
    - - - - - - +

    UiThreadTestRule

    +

    + + public + + + + class + UiThreadTestRule + +
    + + + + + extends Object + + + + + + + + implements - + TestRule - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + + + + +

    java.lang.Object
       ↳android.support.test.rule.UiThreadTestRule
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.rule.UiThreadTestRule +
    - - - - -
    - + +
    + Known Direct Subclasses - +
    -
    - - - - +
    - +
    + + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    This rule allows the test method annotated with UiThreadTest to execute on the +

    This rule allows the test method annotated with UiThreadTest to execute on the application's main thread (or UI thread).

    Note, methods annotated with @@ -776,34 +368,16 @@ Summary: -

    -
    See Also
    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -828,25 +402,23 @@ Summary: - - +
    Public Constructors
    + - - - - + + + + + + +

    Public constructors

    - - - - - - - - UiThreadTestRule() - -
    + + UiThreadTestRule() + + +
    @@ -857,48 +429,59 @@ Summary: - - - - - - - - - - - - - - - +
    Public Methods
    - - - - - - Statement - - apply(Statement base, Description description) - -
    - - - - - - void - - runOnUiThread(Runnable runnable) - -
    - Helper for running portions of a test on the UI thread. - - - -
    - -
    + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + Statement + + + apply(Statement base, Description description) + + +
    + + + + + + void + + + runOnUiThread(Runnable runnable) + + +

    Helper for running portions of a test on the UI thread. + + +

    + +
    @@ -907,25 +490,32 @@ Summary: - - - - - - - - - +
    Protected Methods
    - - - - - - boolean - - shouldRunOnUiThread(Description description) - -
    + + + + + + + + + + + + +

    Protected methods

    + + + + + + boolean + + + shouldRunOnUiThread(Description description) + + +
    @@ -935,207 +525,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1143,41 +802,51 @@ From class - @@ -1186,16 +855,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - org.junit.rules.TestRule + + From +interface + + + org.junit.rules.TestRule + +
    -
    - - - - - - - - - @@ -1213,39 +872,28 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - UiThreadTestRule - () -

    -
    -
    - - - -
    -
    - - +
    +

    UiThreadTestRule

    +
    +
    + + +
    +
    +UiThreadTestRule ()
    + + -

    + +

    -
    @@ -1260,102 +908,102 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - Statement - - apply - (Statement base, Description description) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    apply

    +
    +
    + +
    +
    +Statement apply (Statement base, 
    +                Description description)
    + + + + +

    + + + + + + + + + + +
    Parameters
    base + Statement +
    description + Description +
    + + + + + + +
    Returns
    Statement
    +
    -
    -

    - - public - - - - - void - - runOnUiThread - (Runnable runnable) -

    -
    -
    - - - -
    -
    - - +
    +

    runOnUiThread

    +
    +
    + + +
    +
    +void runOnUiThread (Runnable runnable)
    + + -

    Helper for running portions of a test on the UI thread. + +

    Helper for running portions of a test on the UI thread.

    Note, in most cases it is simpler to annotate the test method with - UiThreadTest, which will run the entire test method including methods annotated with + UiThreadTest, which will run the entire test method including methods annotated with Before and After on the UI thread.

    - Use this method if you need to switch in and out of the UI thread to perform your test.

    -
    -
    Parameters
    - - - - -
    runnable - runnable containing test code in the run() method
    -
    -
    -
    Throws
    - + Use this method if you need to switch in and out of the UI thread to perform your test.

    +
    + + + + + +
    Parameters
    runnable + Runnable: + runnable containing test code in the run() method
    + + - + +
    Throws
    Throwable - Throwable
    -
    -
    -
    See Also
    -
    @@ -1364,39 +1012,44 @@ From interface -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - - - boolean - - shouldRunOnUiThread - (Description description) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    shouldRunOnUiThread

    +
    +
    + +
    +
    +boolean shouldRunOnUiThread (Description description)
    + + + + +

    + + + + + + +
    Parameters
    description + Description +
    + + + + + + +
    Returns
    boolean
    +
    @@ -1404,193 +1057,31 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/rule/logging/AtraceLogger.html b/docs/html/reference/android/support/test/rule/logging/AtraceLogger.html new file mode 100644 index 000000000000..17891699755d --- /dev/null +++ b/docs/html/reference/android/support/test/rule/logging/AtraceLogger.html @@ -0,0 +1,892 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +AtraceLogger + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + +
    + +
    + + + +

    AtraceLogger

    +

    + + public + + + + class + AtraceLogger + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.rule.logging.AtraceLogger +
    + + + + +

    + + +

    Class contains helper methods to dump atrace info asynchronously while running the test case +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + atraceStart(Set<String> traceCategoriesSet, int atraceBufferSize, int dumpIntervalSecs, File destDirectory, String traceFileName) + + +

    Method to start atrace and dump the data at regular interval. + + +

    + +
    + + + + + + void + + + atraceStop() + + +

    Method to stop the atrace and write the atrace data cached in byte array list to file. + + +

    + +
    + + + static + + + AtraceLogger + + + getAtraceLoggerInstance(Instrumentation instrumentation) + + +

    To make sure only one instance of atrace logger is created. + + +

    + +
    + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    atraceStart

    +
    +
    + + + +
    +
    +void atraceStart (Set<String> traceCategoriesSet, 
    +                int atraceBufferSize, 
    +                int dumpIntervalSecs, 
    +                File destDirectory, 
    +                String traceFileName)
    + + + + +

    Method to start atrace and dump the data at regular interval. + Note : Trace info will not be captured during the dumping if there are multiple + dumps between the atraceStart and atraceStop

    + + + + + + + + + + + + + + + + + + + + + + +
    Parameters
    traceCategoriesSet + Set: + Set of atrace categories (i.e atrace --list_categories)
    atraceBufferSize + int: + Size of the circular buffer in kb
    dumpIntervalSecs + int: + Periodic interval to dump data from circular buffer
    destDirectory + File: + Directory under which atrace logs are stored
    traceFileName + String: + is optional parameter.Atrace files are dumped under destDirectory. + traceFileName will be indexed based on number of dumps between atraceStart and + atraceStop under destDirectory. + If traceFileName is null or empty "atrace" name will be used for indexing the files + and stored under destDirectory
    + + + + + + +
    Throws
    IOException
    + + +
    + + + + +
    +

    atraceStop

    +
    +
    + + + +
    +
    +void atraceStop ()
    + + + + +

    Method to stop the atrace and write the atrace data cached in byte array list to file.

    + + + + + + + + + + + + + + +
    Throws
    IOException
    InterruptedException
    IOException
    + + +
    + + + + +
    +

    getAtraceLoggerInstance

    +
    +
    + + + +
    +
    +AtraceLogger getAtraceLoggerInstance (Instrumentation instrumentation)
    + + + + +

    To make sure only one instance of atrace logger is created. + Note : Supported only for minsdk version 23 and above because of UiAutomation + executeShellCommand limitation.

    + + + + + + +
    Parameters
    instrumentation + Instrumentation: + Used to execute atrace shell commands
    + + + + + + +
    Returns
    AtraceLoggerinstance of the AtraceLogger +
    + +
    + + + + + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/rule/logging/EnableTestTracingRule.html b/docs/html/reference/android/support/test/rule/logging/EnableTestTracingRule.html new file mode 100644 index 000000000000..ebc2e7c7ce00 --- /dev/null +++ b/docs/html/reference/android/support/test/rule/logging/EnableTestTracingRule.html @@ -0,0 +1,1276 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +EnableTestTracingRule + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +

    EnableTestTracingRule

    +

    + + public + + + + class + EnableTestTracingRule + +
    + + + + + + + + + + + + + + + + + extends LoggingBaseRule + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳org.junit.rules.ExternalResource +
        ↳android.support.test.rule.logging.LoggingBaseRule +
         ↳android.support.test.rule.logging.EnableTestTracingRule +
    + + + + +

    + + +

    When applied to a test class this TestRule calls + Trace.beginSection() before test method execution. The TestRule then calls + Trace.endSection() after test method execution. The TestRule enables Systrace/Atrace + output to have discrete information about when/which test methods were run (which helps during + performance test debugging). +

    + If the API level is less than 18 (Jelly Bean) this rule will do nothing since Trace isn't + supported. +

    + Usage: + + \@Rule + public EnableTestTracingRule mEnableTestTracing = new EnableTestTracingRule(); + +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + EnableTestTracingRule() + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + afterTest() + + +
    + + + + + + void + + + beforeTest() + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + android.support.test.rule.logging.LoggingBaseRule + + +
    + + +
    +
    + + From +class + + + org.junit.rules.ExternalResource + + +
    + + +
    +
    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + From +interface + + + org.junit.rules.TestRule + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + + + + +
    +

    EnableTestTracingRule

    +
    +
    + + + +
    +
    +EnableTestTracingRule ()
    + + + + +

    + +
    + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    afterTest

    +
    +
    + + + +
    +
    +void afterTest ()
    + + + + +

    + +
    + + + + +
    +

    beforeTest

    +
    +
    + + + +
    +
    +void beforeTest ()
    + + + + +

    + +
    + + + + + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/rule/logging/LogBatteryInformationRule.html b/docs/html/reference/android/support/test/rule/logging/LogBatteryInformationRule.html new file mode 100644 index 000000000000..08a9278b3905 --- /dev/null +++ b/docs/html/reference/android/support/test/rule/logging/LogBatteryInformationRule.html @@ -0,0 +1,1402 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +LogBatteryInformationRule + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +

    LogBatteryInformationRule

    +

    + + public + + + + class + LogBatteryInformationRule + +
    + + + + + + + + + + + + + + + + + extends LoggingBaseRule + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳org.junit.rules.ExternalResource +
        ↳android.support.test.rule.logging.LoggingBaseRule +
         ↳android.support.test.rule.logging.LogBatteryInformationRule +
    + + + + +

    + + +

    When applied to a test class this Rule resets battery information ("stats") before + test method execution. The Rule then collects battery information after test + method execution and logs it to a file on external storage. The default file location is + maintained at getTestDir(String, String, int). The Rule performs + these actions through the execution of a dumpsys on the batterystats service. +

    + If the API level is less than 21 (Lollipop) this rule will do nothing since this dumpsys command + isn't supported. This TestRule has limited use for short running tests and is meant for very long + running tests. +

    + The Rule's before() and after() methods can also be used for logging + battery information across a test suite by manually invoking the methods in a + RunListener. +

    + Usage: + + \@Rule + public LogBatteryInformationRule mLogBatteryInformationRule = new LogBatteryInformationRule(); + +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + LogBatteryInformationRule() + + +

    + + + +

    + +
    + + LogBatteryInformationRule(File logFileOutputDirectory, String fileName) + + +

    + + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + afterTest() + + +
    + + + + + + void + + + beforeTest() + + +
    + + + + + + String + + + getDefaultLogFileName() + + +

    Return the default log file name for this rule class. + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + android.support.test.rule.logging.LoggingBaseRule + + +
    + + +
    +
    + + From +class + + + org.junit.rules.ExternalResource + + +
    + + +
    +
    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + From +interface + + + org.junit.rules.TestRule + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + + + + +
    +

    LogBatteryInformationRule

    +
    +
    + + + +
    +
    +LogBatteryInformationRule ()
    + + + + +

    +

    + +
    + + + + +
    +

    LogBatteryInformationRule

    +
    +
    + + + +
    +
    +LogBatteryInformationRule (File logFileOutputDirectory, 
    +                String fileName)
    + + + + +

    +

    + + + + + + + + + + +
    Parameters
    logFileOutputDirectory + File +
    fileName + String +
    + +
    + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    afterTest

    +
    +
    + + + +
    +
    +void afterTest ()
    + + + + +

    + +
    + + + + +
    +

    beforeTest

    +
    +
    + + + +
    +
    +void beforeTest ()
    + + + + +

    + +
    + + + + +
    +

    getDefaultLogFileName

    +
    +
    + + + +
    +
    +String getDefaultLogFileName ()
    + + + + +

    Return the default log file name for this rule class. A null return value indicates the rule + doesn't log to a file. +

    + + + + + + +
    Returns
    String
    + +
    + + + + + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/rule/logging/LogDeviceGetPropInfoRule.html b/docs/html/reference/android/support/test/rule/logging/LogDeviceGetPropInfoRule.html new file mode 100644 index 000000000000..14df92eabaa4 --- /dev/null +++ b/docs/html/reference/android/support/test/rule/logging/LogDeviceGetPropInfoRule.html @@ -0,0 +1,1343 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +LogDeviceGetPropInfoRule + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +

    LogDeviceGetPropInfoRule

    +

    + + public + + + + class + LogDeviceGetPropInfoRule + +
    + + + + + + + + + + + + + + + + + extends LoggingBaseRule + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳org.junit.rules.ExternalResource +
        ↳android.support.test.rule.logging.LoggingBaseRule +
         ↳android.support.test.rule.logging.LogDeviceGetPropInfoRule +
    + + + + +

    + + +

    When applied to a test class this Rule executes the "getprop" device command after + test method execution and logs it to a file on external storage. The default file location is + retrieved via getTestDir(String, String, int). +

    + The Rule logs the runtime build number, device name, build type, lcd density, cpu + type, among many other device state attributes. When used in conjunction with a device lab it + might assist in identifying trends in test failures for a subset of Android devices. +

    + The pertinent information output by this rule typically doesn't change between tests, therefore, + it is typically used manually by using the before() and after() methods in a + RunListener. +

    + Usage: + + \@Rule + public LogDeviceGetPropInfoRule mLogDeviceGetPropInfoRule = new LogDeviceGetPropInfoRule(); + +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + LogDeviceGetPropInfoRule() + + +

    + + + +

    + +
    + + LogDeviceGetPropInfoRule(File logFileOutputDirectory, String fileName) + + +

    + + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + afterTest() + + +
    + + + + + + void + + + beforeTest() + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + android.support.test.rule.logging.LoggingBaseRule + + +
    + + +
    +
    + + From +class + + + org.junit.rules.ExternalResource + + +
    + + +
    +
    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + From +interface + + + org.junit.rules.TestRule + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + + + + +
    +

    LogDeviceGetPropInfoRule

    +
    +
    + + + +
    +
    +LogDeviceGetPropInfoRule ()
    + + + + +

    +

    + +
    + + + + +
    +

    LogDeviceGetPropInfoRule

    +
    +
    + + + +
    +
    +LogDeviceGetPropInfoRule (File logFileOutputDirectory, 
    +                String fileName)
    + + + + +

    +

    + + + + + + + + + + +
    Parameters
    logFileOutputDirectory + File +
    fileName + String +
    + +
    + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    afterTest

    +
    +
    + + + +
    +
    +void afterTest ()
    + + + + +

    + +
    + + + + +
    +

    beforeTest

    +
    +
    + + + +
    +
    +void beforeTest ()
    + + + + +

    + +
    + + + + + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/rule/logging/LogGraphicsStatsRule.html b/docs/html/reference/android/support/test/rule/logging/LogGraphicsStatsRule.html new file mode 100644 index 000000000000..a1bdb5aca2a7 --- /dev/null +++ b/docs/html/reference/android/support/test/rule/logging/LogGraphicsStatsRule.html @@ -0,0 +1,1342 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +LogGraphicsStatsRule + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +

    LogGraphicsStatsRule

    +

    + + public + + + + class + LogGraphicsStatsRule + +
    + + + + + + + + + + + + + + + + + extends LoggingBaseRule + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳org.junit.rules.ExternalResource +
        ↳android.support.test.rule.logging.LoggingBaseRule +
         ↳android.support.test.rule.logging.LogGraphicsStatsRule +
    + + + + +

    + + +

    When applied to a test class this Rule performs a graphics system information reset + before test method execution. The Rule then collects graphics system + information after test method execution and logs it to a file on external storage. The default + file location is maintained at getTestDir(String, String, int). + The Rule performs these actions through the execution of a dumpsys on the gfxinfo + service. +

    + The Rule's before() and after() methods can also be used for logging + battery information across a test suite by manually invoking the methods in a + RunListener. +

    + Usage: + + \@Rule + public LogGraphicsStatsRule mLogGraphicsStatsRule = new LogGraphicsStatsRule(); + +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + LogGraphicsStatsRule() + + +

    + + + +

    + +
    + + LogGraphicsStatsRule(File logFileOutputDirectory, String fileName) + + +

    + + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + afterTest() + + +
    + + + + + + void + + + beforeTest() + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + android.support.test.rule.logging.LoggingBaseRule + + +
    + + +
    +
    + + From +class + + + org.junit.rules.ExternalResource + + +
    + + +
    +
    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + From +interface + + + org.junit.rules.TestRule + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + + + + +
    +

    LogGraphicsStatsRule

    +
    +
    + + + +
    +
    +LogGraphicsStatsRule ()
    + + + + +

    +

    + +
    + + + + +
    +

    LogGraphicsStatsRule

    +
    +
    + + + +
    +
    +LogGraphicsStatsRule (File logFileOutputDirectory, 
    +                String fileName)
    + + + + +

    +

    + + + + + + + + + + +
    Parameters
    logFileOutputDirectory + File +
    fileName + String +
    + +
    + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    afterTest

    +
    +
    + + + +
    +
    +void afterTest ()
    + + + + +

    + +
    + + + + +
    +

    beforeTest

    +
    +
    + + + +
    +
    +void beforeTest ()
    + + + + +

    + +
    + + + + + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/rule/logging/LogLogcatRule.html b/docs/html/reference/android/support/test/rule/logging/LogLogcatRule.html new file mode 100644 index 000000000000..c8ff4818b438 --- /dev/null +++ b/docs/html/reference/android/support/test/rule/logging/LogLogcatRule.html @@ -0,0 +1,1525 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +LogLogcatRule + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +

    LogLogcatRule

    +

    + + public + + + + class + LogLogcatRule + +
    + + + + + + + + + + + + + + + + + extends LoggingBaseRule + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳org.junit.rules.ExternalResource +
        ↳android.support.test.rule.logging.LoggingBaseRule +
         ↳android.support.test.rule.logging.LogLogcatRule +
    + + + + +

    + + +

    When applied to a test class this Rule attempts to clear the Logcat buffer on the device + before test method execution. The Rule then collects everything in the + Logcat buffer after test method execution and logs it to a file on external storage. The default + file location is maintained at getTestDir(String, String, int). The + TestRule performs these actions through calling the device's logcat command. +

    + Test methods can perform additional clearing and capturing of the Logcat buffer through the + clearLogcat() and dumpLogcat(String) methods. +

    + Usage: + + \@Rule + public LogLogcatRule mLogLogcatRule = new LogLogcatRule(); + +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + LogLogcatRule() + + +

    + + + +

    + +
    + + LogLogcatRule(File logFileOutputDirectory, String fileName) + + +

    + + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + afterTest() + + +

    Extract logcat buffer to a file after test run. + + +

    + +
    + + + + + + void + + + beforeTest() + + +

    Clear logcat buffer prior to test run. + + +

    + +
    + + + static + + + void + + + clearLogcat() + + +

    Clear the current logcat buffer. + + +

    + +
    + + + + + + File + + + dumpLogcat(String logFileName) + + +

    Dump the current state of the logcat buffer to a file in the test method's logging directory. + + +

    + +
    + + + + + + String + + + getDefaultLogFileName() + + +

    Return the default log file name for this rule class. + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + android.support.test.rule.logging.LoggingBaseRule + + +
    + + +
    +
    + + From +class + + + org.junit.rules.ExternalResource + + +
    + + +
    +
    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + From +interface + + + org.junit.rules.TestRule + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + + + + +
    +

    LogLogcatRule

    +
    +
    + + + +
    +
    +LogLogcatRule ()
    + + + + +

    +

    + +
    + + + + +
    +

    LogLogcatRule

    +
    +
    + + + +
    +
    +LogLogcatRule (File logFileOutputDirectory, 
    +                String fileName)
    + + + + +

    +

    + + + + + + + + + + +
    Parameters
    logFileOutputDirectory + File +
    fileName + String +
    + +
    + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    afterTest

    +
    +
    + + + +
    +
    +void afterTest ()
    + + + + +

    Extract logcat buffer to a file after test run. +

    + +
    + + + + +
    +

    beforeTest

    +
    +
    + + + +
    +
    +void beforeTest ()
    + + + + +

    Clear logcat buffer prior to test run. +

    + +
    + + + + +
    +

    clearLogcat

    +
    +
    + + + +
    +
    +void clearLogcat ()
    + + + + +

    Clear the current logcat buffer. This can be called from test method code, but will alter the + results of the Rule's final log of the buffer at the end of the test method. +

    + +
    + + + + +
    +

    dumpLogcat

    +
    +
    + + + +
    +
    +File dumpLogcat (String logFileName)
    + + + + +

    Dump the current state of the logcat buffer to a file in the test method's logging directory. + This method can be used when writing tests to record logcat at different points in time.

    + + + + + + +
    Parameters
    logFileName + String: + where Logcat output is sent
    + + + + + + +
    Returns
    Filethe File where output was logged +
    + +
    + + + + +
    +

    getDefaultLogFileName

    +
    +
    + + + +
    +
    +String getDefaultLogFileName ()
    + + + + +

    Return the default log file name for this rule class. A null return value indicates the rule + doesn't log to a file. +

    + + + + + + +
    Returns
    String
    + +
    + + + + + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/rule/logging/LogNetStatsRule.html b/docs/html/reference/android/support/test/rule/logging/LogNetStatsRule.html new file mode 100644 index 000000000000..0fbd53fdeb5f --- /dev/null +++ b/docs/html/reference/android/support/test/rule/logging/LogNetStatsRule.html @@ -0,0 +1,1328 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +LogNetStatsRule + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +

    LogNetStatsRule

    +

    + + public + + + + class + LogNetStatsRule + +
    + + + + + + + + + + + + + + + + + extends LoggingBaseRule + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳org.junit.rules.ExternalResource +
        ↳android.support.test.rule.logging.LoggingBaseRule +
         ↳android.support.test.rule.logging.LogNetStatsRule +
    + + + + +

    + + +

    When applied to a test class this Rule performs a network system information reset + before test method execution. The Rule then collects network system + information after test method execution and logs it to a file on external storage. The default + file location is maintained at getTestDir(String, String, int). + The Rule performs these actions through the execution of a dumpsys on the netstats + service. +

    + The Rule's before() and after() methods can also be used for logging + battery information across a test suite by manually invoking the methods in a + RunListener. +

    + Usage: + + \@Rule + public LogNetStatsRule mLogNetStatsRule = new LogNetStatsRule(); + +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + LogNetStatsRule() + + +
    + + LogNetStatsRule(File logFileOutputDirectory, String fileName) + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + afterTest() + + +
    + + + + + + void + + + beforeTest() + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + android.support.test.rule.logging.LoggingBaseRule + + +
    + + +
    +
    + + From +class + + + org.junit.rules.ExternalResource + + +
    + + +
    +
    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + From +interface + + + org.junit.rules.TestRule + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + + + + +
    +

    LogNetStatsRule

    +
    +
    + + + +
    +
    +LogNetStatsRule ()
    + + + + +

    + +
    + + + + +
    +

    LogNetStatsRule

    +
    +
    + + + +
    +
    +LogNetStatsRule (File logFileOutputDirectory, 
    +                String fileName)
    + + + + +

    + + + + + + + + + + +
    Parameters
    logFileOutputDirectory + File +
    fileName + String +
    + +
    + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    afterTest

    +
    +
    + + + +
    +
    +void afterTest ()
    + + + + +

    + +
    + + + + +
    +

    beforeTest

    +
    +
    + + + +
    +
    +void beforeTest ()
    + + + + +

    + +
    + + + + + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/rule/logging/LoggingBaseRule.html b/docs/html/reference/android/support/test/rule/logging/LoggingBaseRule.html new file mode 100644 index 000000000000..9322e44c3e7f --- /dev/null +++ b/docs/html/reference/android/support/test/rule/logging/LoggingBaseRule.html @@ -0,0 +1,1600 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +LoggingBaseRule + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +

    LoggingBaseRule

    +

    + + public + + + abstract + class + LoggingBaseRule + +
    + + + + + + + + + + + extends ExternalResource + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳org.junit.rules.ExternalResource +
        ↳android.support.test.rule.logging.LoggingBaseRule +
    + + +
    + + Known Direct Subclasses + +
    + + +
    +
    + + + + + +

    + + +

    Base class for logging rules to remove boiler-plate instance variables used by most logging + rules. +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + LoggingBaseRule() + + +
    + + LoggingBaseRule(File logFileOutputDirectory, String fileName) + + +

    Request the log be written to a specific location. + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + final + + void + + + after() + + +
    + + + + final + + Statement + + + apply(Statement base, Description description) + + +
    + + + + final + + void + + + before() + + +
    + + + + + + void + + + setTestRunNumber(int testRunNumber) + + +

    Indicate to the Rule that this is the testRunNumberth time the test method + is being called in a test instrumentation. + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Protected methods

    + + + + + + String + + + getLogFileName() + + +
    + + + + + + File + + + getLogFileOutputDirectory() + + +
    + + + + + + String + + + getPackageNameUnderTest() + + +
    + + + + + + String + + + getTestClass() + + +
    + + + + + + String + + + getTestName() + + +
    + + + + + + int + + + getTestRunNumber() + + +
    + + + + + + + + + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + org.junit.rules.ExternalResource + + +
    + + +
    +
    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + From +interface + + + org.junit.rules.TestRule + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + + + + +
    +

    LoggingBaseRule

    +
    +
    + + + +
    +
    +LoggingBaseRule ()
    + + + + +

    + +
    + + + + +
    +

    LoggingBaseRule

    +
    +
    + + + +
    +
    +LoggingBaseRule (File logFileOutputDirectory, 
    +                String fileName)
    + + + + +

    Request the log be written to a specific location. +

    + File logFileOutputDirectory directory to log output to + String fileName to override the default file name, if desired +

    + + + + + + + + + + +
    Parameters
    logFileOutputDirectory + File +
    fileName + String +
    + +
    + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    after

    +
    +
    + + + +
    +
    +void after ()
    + + + + +

    + +
    + + + + +
    +

    apply

    +
    +
    + + + +
    +
    +Statement apply (Statement base, 
    +                Description description)
    + + + + +

    + + + + + + + + + + +
    Parameters
    base + Statement +
    description + Description +
    + + + + + + +
    Returns
    Statement
    + +
    + + + + +
    +

    before

    +
    +
    + + + +
    +
    +void before ()
    + + + + +

    + +
    + + + + +
    +

    setTestRunNumber

    +
    +
    + + + +
    +
    +void setTestRunNumber (int testRunNumber)
    + + + + +

    Indicate to the Rule that this is the testRunNumberth time the test method + is being called in a test instrumentation. This method only needs to be called when a test + method is being called multiple times in a test instrumentation.

    + + + + + + +
    Parameters
    testRunNumber + int: + indicates the nth run for the test method in zero-index form +
    + +
    + + + + + + + +

    Protected methods

    + + + + + +
    +

    getLogFileName

    +
    +
    + + + +
    +
    +String getLogFileName ()
    + + + + +

    + + + + + + +
    Returns
    String
    + +
    + + + + +
    +

    getLogFileOutputDirectory

    +
    +
    + + + +
    +
    +File getLogFileOutputDirectory ()
    + + + + +

    + + + + + + +
    Returns
    File
    + +
    + + + + +
    +

    getPackageNameUnderTest

    +
    +
    + + + +
    +
    +String getPackageNameUnderTest ()
    + + + + +

    + + + + + + +
    Returns
    String
    + +
    + + + + +
    +

    getTestClass

    +
    +
    + + + +
    +
    +String getTestClass ()
    + + + + +

    + + + + + + +
    Returns
    String
    + +
    + + + + +
    +

    getTestName

    +
    +
    + + + +
    +
    +String getTestName ()
    + + + + +

    + + + + + + +
    Returns
    String
    + +
    + + + + +
    +

    getTestRunNumber

    +
    +
    + + + +
    +
    +int getTestRunNumber ()
    + + + + +

    + + + + + + +
    Returns
    int
    + +
    + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/rule/logging/RuleLoggingUtils.html b/docs/html/reference/android/support/test/rule/logging/RuleLoggingUtils.html new file mode 100644 index 000000000000..d0d8db4433fe --- /dev/null +++ b/docs/html/reference/android/support/test/rule/logging/RuleLoggingUtils.html @@ -0,0 +1,1927 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +RuleLoggingUtils + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + +
    + +
    + + + +

    RuleLoggingUtils

    +

    + + public + + + + class + RuleLoggingUtils + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.rule.logging.RuleLoggingUtils +
    + + + + +

    + + +

    Convenience methods to ensure logging rules perform certain actions in the same manner. +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Constants

    String + LOGGING_SUB_DIR_NAME +

    + + +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + RuleLoggingUtils() + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + static + + + void + + + assertEmptyFile(String message, File file) + + +

    Test utility method to check if a file is empty. + + +

    + +
    + + + static + + + void + + + assertFileContentContains(String message, File file, String contentString) + + +

    Test utility method to check if a file contains the specified content. + + +

    + +
    + + + static + + + void + + + assertFileContentDoesNotContain(String message, File file, String contentString) + + +

    Test utility method to check if a file doesn't contain the specified content. + + +

    + +
    + + + static + + + void + + + assertFileContentStartsWith(String message, File file, String contentString) + + +

    Test utility method to quickly check if a file begins with the specified content. + + +

    + +
    + + + static + + + File + + + getTestDir(String className, String testName, int testRunNumber) + + +

    Retrieve the directory where logging rules logs should be written to. + + +

    + +
    + + + static + + + File + + + getTestFile(String className, String testName, String filename, int testRunNumber) + + +

    Retrieve a file handle that is within the testing directory where tests should be written to. + + +

    + +
    + + + static + + + File + + + getTestRunDir() + + +

    Retrieve the test run directory where tests should be written to. + + +

    + +
    + + + static + + + File + + + getTestRunFile(String filename) + + +

    Retrieve a file handle within the testing directory where test data can be written for the + complete test run. + + +

    + +
    + + + static + + + void + + + printFileToLogcat(File logFile, String logcatTag) + + +

    Utility method to print file to logcat for debugging purposes. + + +

    + +
    + + + static + + + void + + + startCmdAndLogOutputPostL(String[] commandParts, File logFile) + + +

    Start a Process on the system using a process compatible with all Android runtimes. + + +

    + +
    + + + static + + + Process + + + startProcess(String[] commandParts) + + +

    Start a Process with the command and arguments specified in commandParts. + + +

    + +
    + + + static + + + void + + + startProcessAndLogToFile(String[] commandParts, File logFile, int androidVersion) + + +

    Start a Process on the system using either + startCmdAndLogOutputPostL(String[], File) or + startProcessAndWriteOutputToFilePreL(String[], File) according to the Android + version number passed in. + + +

    + +
    + + + static + + + void + + + startProcessAndWriteOutputToFilePreL(String[] commandParts, File logFile) + + +

    Start a Process on the system using a process compatible with all Android runtimes. + + +

    + +
    + + + static + + + void + + + writeErrorToFileAndLogcat(File file, String logTag, String errorMessage, Exception exception) + + +

    Utility method to write an error message to a file and logcat as an error. + + +

    + +
    + + + static + + + void + + + writeProcessOutputToFile(Process process, File logFile) + + +

    Utility method to read a Process's output and write it to a file. + + +

    + +
    + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + + + + + + + + + + + + +

    Constants

    + + + + + + +
    +

    LOGGING_SUB_DIR_NAME

    +
    + + + + +
    +
    +String LOGGING_SUB_DIR_NAME
    + + + + +

    + + +

    Constant Value: + + "testdata" + + +

    + + + + + + + + + + + +

    Public constructors

    + + + + + +
    +

    RuleLoggingUtils

    +
    +
    + + + +
    +
    +RuleLoggingUtils ()
    + + + + +

    + +
    + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    assertEmptyFile

    +
    +
    + + + +
    +
    +void assertEmptyFile (String message, 
    +                File file)
    + + + + +

    Test utility method to check if a file is empty.

    + + + + + + + + + + +
    Parameters
    message + String: + to be used when throwing an Assertion error if the content is not empty
    file + File: + to inspect
    + + + + + + + + + + +
    Throws
    AssertionErroris thrown when the file isn't empty
    IOExceptionwhen the there are issues accessing the file parameter +
    + + +
    + + + + +
    +

    assertFileContentContains

    +
    +
    + + + +
    +
    +void assertFileContentContains (String message, 
    +                File file, 
    +                String contentString)
    + + + + +

    Test utility method to check if a file contains the specified content.

    + + + + + + + + + + + + + + +
    Parameters
    message + String: + to be used when throwing an Assertion error if the content does not + match
    file + File: + to inspect
    contentString + String: + to compare against the content of the file
    + + + + + + + + + + +
    Throws
    AssertionErroris thrown when the content is not found
    IOExceptionwhen the there are issues accessing the file parameter +
    + + +
    + + + + +
    +

    assertFileContentDoesNotContain

    +
    +
    + + + +
    +
    +void assertFileContentDoesNotContain (String message, 
    +                File file, 
    +                String contentString)
    + + + + +

    Test utility method to check if a file doesn't contain the specified content.

    + + + + + + + + + + + + + + +
    Parameters
    message + String: + to be used when throwing an Assertion error if the content does not + match
    file + File: + to inspect
    contentString + String: + to compare against the content of the file
    + + + + + + + + + + +
    Throws
    AssertionErroris thrown when the content is not found
    IOExceptionwhen the there are issues accessing the file parameter +
    + + +
    + + + + +
    +

    assertFileContentStartsWith

    +
    +
    + + + +
    +
    +void assertFileContentStartsWith (String message, 
    +                File file, 
    +                String contentString)
    + + + + +

    Test utility method to quickly check if a file begins with the specified content.

    + + + + + + + + + + + + + + +
    Parameters
    message + String: + to be used if the content does not match
    file + File: + to inspect
    contentString + String: + to compare against the content of the file
    + + + + + + + + + + +
    Throws
    AssertionErroris thrown when the content is not found
    IOExceptionwhen the there are issues accessing the file parameter +
    + + +
    + + + + +
    +

    getTestDir

    +
    +
    + + + +
    +
    +File getTestDir (String className, 
    +                String testName, 
    +                int testRunNumber)
    + + + + +

    Retrieve the directory where logging rules logs should be written to. + This directory is on external storage so it is not removed when the app is uninstalled. This + allows the files to be retrieved despite fatal (think OutOfMemory) exceptions. + testRunNumber should be set whenever a test method is run more than one time in a + single test run to indicate which iteration the logging is for. Use zero as a default. +

    + + + + + + + + + + + + + + +
    Parameters
    className + String +
    testName + String +
    testRunNumber + int +
    + + + + + + +
    Returns
    File
    + +
    + + + + +
    +

    getTestFile

    +
    +
    + + + +
    +
    +File getTestFile (String className, 
    +                String testName, 
    +                String filename, 
    +                int testRunNumber)
    + + + + +

    Retrieve a file handle that is within the testing directory where tests should be written to. +

    + + + + + + + + + + + + + + + + + + +
    Parameters
    className + String +
    testName + String +
    filename + String +
    testRunNumber + int +
    + + + + + + +
    Returns
    File
    + +
    + + + + +
    +

    getTestRunDir

    +
    +
    + + + +
    +
    +File getTestRunDir ()
    + + + + +

    Retrieve the test run directory where tests should be written to. +

    + + + + + + +
    Returns
    File
    + +
    + + + + +
    +

    getTestRunFile

    +
    +
    + + + +
    +
    +File getTestRunFile (String filename)
    + + + + +

    Retrieve a file handle within the testing directory where test data can be written for the + complete test run. +

    + + + + + + +
    Parameters
    filename + String +
    + + + + + + +
    Returns
    File
    + +
    + + + + +
    +

    printFileToLogcat

    +
    +
    + + + +
    +
    +void printFileToLogcat (File logFile, 
    +                String logcatTag)
    + + + + +

    Utility method to print file to logcat for debugging purposes. +

    + + + + + + + + + + +
    Parameters
    logFile + File +
    logcatTag + String +
    + + + + + + +
    Throws
    IOException
    + + +
    + + + + +
    +

    startCmdAndLogOutputPostL

    +
    +
    + + + +
    +
    +void startCmdAndLogOutputPostL (String[] commandParts, 
    +                File logFile)
    + + + + +

    Start a Process on the system using a process compatible with all Android runtimes. + Standard and error output is redirected to the specified file. +

    + This command runs within the testing instrumentation and has some development permissions + already granted.

    + + + + + + + + + + +
    Parameters
    commandParts + String: + the command and parameters to execute on the system
    logFile + File: + where comamnd output is written, or in the case of an error, the + exception output is written +
    + +
    + + + + +
    +

    startProcess

    +
    +
    + + + +
    +
    +Process startProcess (String[] commandParts)
    + + + + +

    Start a Process with the command and arguments specified in commandParts. +

    + You must call Process.destroy() on the object returned. +

    + + + + + + +
    Parameters
    commandParts + String +
    + + + + + + +
    Returns
    Process
    + + + + + + +
    Throws
    IOException
    + + +
    + + + + +
    +

    startProcessAndLogToFile

    +
    +
    + + + +
    +
    +void startProcessAndLogToFile (String[] commandParts, 
    +                File logFile, 
    +                int androidVersion)
    + + + + +

    Start a Process on the system using either + startCmdAndLogOutputPostL(String[], File) or + startProcessAndWriteOutputToFilePreL(String[], File) according to the Android + version number passed in. +

    + This utility method eliminates the need to grant your app some system permissions when + running on Android Lollipop or above by using the test instrumentation to run the specified + command. If you are testing on pre-Lollipop devices you will need to ensure your test APK + has been granted any permissions needed to execute the commands passed in.

    + + + + + + + + + + + + + + +
    Parameters
    commandParts + String: + the command and parameters to execute on the system
    logFile + File: + where comamnd output is written, or in the case of an error, where the + exception output is written
    androidVersion + int: + overrides the system Android version which is used to decide the best + method to invoke the command with. This is useful for code that needs + to write Android version specific tests. +
    + +
    + + + + +
    +

    startProcessAndWriteOutputToFilePreL

    +
    +
    + + + +
    +
    +void startProcessAndWriteOutputToFilePreL (String[] commandParts, 
    +                File logFile)
    + + + + +

    Start a Process on the system using a process compatible with all Android runtimes. + Standard and error output is redirected to the specified file. +

    + This command runs as the current user and requires appropriate permissions be granted to the + App/Test APK. If the runtime is Android M or greater use + startCmdAndLogOutputPostL(String[], File) instead to run as with instrumentation + permissions.

    + + + + + + + + + + +
    Parameters
    commandParts + String: + the command and parameters to execute on the system
    logFile + File: + where comamnd output is written, or in the case of an error, the + exception output is written +
    + +
    + + + + +
    +

    writeErrorToFileAndLogcat

    +
    +
    + + + +
    +
    +void writeErrorToFileAndLogcat (File file, 
    +                String logTag, 
    +                String errorMessage, 
    +                Exception exception)
    + + + + +

    Utility method to write an error message to a file and logcat as an error. +

    + + + + + + + + + + + + + + + + + + +
    Parameters
    file + File +
    logTag + String +
    errorMessage + String +
    exception + Exception +
    + +
    + + + + +
    +

    writeProcessOutputToFile

    +
    +
    + + + +
    +
    +void writeProcessOutputToFile (Process process, 
    +                File logFile)
    + + + + +

    Utility method to read a Process's output and write it to a file. +

    + + + + + + + + + + +
    Parameters
    process + Process +
    logFile + File +
    + + + + + + +
    Throws
    IOException
    + + +
    + + + + + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/rule/logging/package-summary.html b/docs/html/reference/android/support/test/rule/logging/package-summary.html new file mode 100644 index 000000000000..cee41f62dd0a --- /dev/null +++ b/docs/html/reference/android/support/test/rule/logging/package-summary.html @@ -0,0 +1,321 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +android.support.test.rule.logging + + + + + + + + + + +
    + +
    +
    + + + + +
    +
    +
    + +

    android.support.test.rule.logging

    + + + + + + + + + + + + + +

    Classes

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AtraceLogger + Class contains helper methods to dump atrace info asynchronously while running the test case +  + + + +
    EnableTestTracingRule + When applied to a test class this TestRule calls + Trace.beginSection() before test method execution.  + + + +
    LogBatteryInformationRule + When applied to a test class this Rule resets battery information ("stats") before + test method execution.  + + + +
    LogDeviceGetPropInfoRule + When applied to a test class this Rule executes the "getprop" device command after + test method execution and logs it to a file on external storage.  + + + +
    LoggingBaseRule + Base class for logging rules to remove boiler-plate instance variables used by most logging + rules.  + + + +
    LogGraphicsStatsRule + When applied to a test class this Rule performs a graphics system information reset + before test method execution.  + + + +
    LogLogcatRule + When applied to a test class this Rule attempts to clear the Logcat buffer on the device + before test method execution.  + + + +
    LogNetStatsRule + When applied to a test class this Rule performs a network system information reset + before test method execution.  + + + +
    RuleLoggingUtils + Convenience methods to ensure logging rules perform certain actions in the same manner.  + + + +
    + + + + + + + + + + + + + +
    + + + + + + + + diff --git a/docs/html/reference/android/support/test/rule/package-summary.html b/docs/html/reference/android/support/test/rule/package-summary.html index c0b52a2bfc93..723590769e03 100644 --- a/docs/html/reference/android/support/test/rule/package-summary.html +++ b/docs/html/reference/android/support/test/rule/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,760 +92,164 @@ - - - - - - -android.support.test.rule | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.rule - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.rule

    -
    - -
    - -
    - - - +

    android.support.test.rule

    + + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + + + +
    ActivityTestRule<T extends Activity>ActivityTestRule<T extends Activity> This rule provides functional testing of a single activity.  - - + +
    DisableOnAndroidDebugDisableOnAndroidDebug The DisableOnAndroidDebug Rule allows you to label certain rules to be disabled when debugging.  - - + +
    ServiceTestRuleServiceTestRule A JUnit rule that provides a simplified mechanism to start and shutdown your service before and after the duration of your test.  - - + +
    UiThreadTestRuleUiThreadTestRule - This rule allows the test method annotated with UiThreadTest to execute on the + This rule allows the test method annotated with UiThreadTest to execute on the application's main thread (or UI thread).  - - + +
    + + + + + + + -
    -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + +
    +
    + + + +
    + diff --git a/docs/html/reference/android/support/test/runner/AndroidJUnit4.html b/docs/html/reference/android/support/test/runner/AndroidJUnit4.html index 79c3c9a811c6..cf85d15b71be 100644 --- a/docs/html/reference/android/support/test/runner/AndroidJUnit4.html +++ b/docs/html/reference/android/support/test/runner/AndroidJUnit4.html @@ -1,1973 +1,1077 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -AndroidJUnit4 | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - - final - - class -

    AndroidJUnit4

    - - - - - - - - - - - - - - - - - extends BlockJUnit4ClassRunner
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳org.junit.runner.Runner
        ↳org.junit.runners.ParentRunner<T>
         ↳org.junit.runners.BlockJUnit4ClassRunner
          ↳android.support.test.runner.AndroidJUnit4
    - - - - - - - -
    - - -

    Class Overview

    -

    Aliases the current default Android JUnit 4 class runner, for future-proofing. If - future versions of JUnit change the default Runner class, they will also - change the definition of this class. Developers wanting to explicitly tag a - class as an Android JUnit 4 class should use @RunWith(AndroidJUnit4.class) -

    - - - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Constructors
    - - - - - - - - AndroidJUnit4(Class<?> klass, AndroidRunnerParams runnerParams) - -
    - Constructs a new instance of the default runner - - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - -
    Protected Methods
    - - - - - - Statement - - withPotentialTimeout(FrameworkMethod method, Object test, Statement next) - -
    - Default to - Test level timeout if set. - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    - [Expand] -
    Inherited Methods
    - -From class - - org.junit.runners.BlockJUnit4ClassRunner - -
    - - -
    -
    - -From class - - org.junit.runners.ParentRunner - -
    - -
    -
    - -From class - - org.junit.runner.Runner - -
    - - -
    -
    - -From class - - java.lang.Object - -
    - -
    - final - void - - wait(long arg0, int arg1) -
    + + + + + + + + + + + + + +

    Protected methods

    + + + + + + Statement + + + withPotentialTimeout(FrameworkMethod method, Object test, Statement next) + + +

    Default to + Test level timeout if set. + + +

    + +
    -
    - final - void - - wait(long arg0) + + + - + +

    Inherited methods

    -
    + From +class + + + org.junit.runners.BlockJUnit4ClassRunner + + +
    + +
    - -From interface - - org.junit.runner.Describable + -
    -
    From +class + + + org.junit.runners.ParentRunner + + +
    + - +
    +
    - abstract +
    + From +class + + + org.junit.runner.Runner + + +
    + + +
    +
    - getDescription() -
    -
    + From +class + + + java.lang.Object + + +
    + +
    - -From interface - - org.junit.runner.manipulation.Filterable + + From +interface + + + org.junit.runner.manipulation.Filterable + +
    - -From interface - - org.junit.runner.manipulation.Sortable + + From +interface + + + org.junit.runner.manipulation.Sortable + +
    -
    - - - - - - - - - @@ -2129,49 +2113,53 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - AndroidJUnit4 - (Class<?> klass, AndroidRunnerParams runnerParams) -

    -
    -
    - - +
    +

    AndroidJUnit4

    +
    +
    + + -
    -
    - - - - -

    Constructs a new instance of the default runner -

    -
    -
    Throws
    - + +
    +AndroidJUnit4 (Class<?> klass, 
    +                AndroidRunnerParams runnerParams)
    + + + + +

    Constructs a new instance of the default runner +

    +
    + + + + + + + + + +
    Parameters
    klass + Class +
    runnerParams + AndroidRunnerParams +
    + + - + +
    Throws
    InitializationError - InitializationError
    -
    + -
    @@ -2190,42 +2178,61 @@ From interface -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - - - Statement - - withPotentialTimeout - (FrameworkMethod method, Object test, Statement next) -

    -
    -
    - - - -
    -
    - +
    +

    withPotentialTimeout

    +
    +
    + + - - -

    Default to +

    +
    +Statement withPotentialTimeout (FrameworkMethod method, 
    +                Object test, 
    +                Statement next)
    + + + + +

    Default to Test level timeout if set. Otherwise, set the timeout that was passed to the instrumentation via argument -

    +

    + + + + + + + + + + + + + + +
    Parameters
    method + FrameworkMethod +
    test + Object +
    next + Statement +
    + + + + + + +
    Returns
    Statement
    -
    @@ -2233,193 +2240,32 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/runner/AndroidJUnitRunner.html b/docs/html/reference/android/support/test/runner/AndroidJUnitRunner.html index f7f4fd319d9c..84093cf8acbb 100644 --- a/docs/html/reference/android/support/test/runner/AndroidJUnitRunner.html +++ b/docs/html/reference/android/support/test/runner/AndroidJUnitRunner.html @@ -1,4 +1,3 @@ - @@ -93,500 +92,101 @@ - - - - - - -AndroidJUnitRunner | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +AndroidJUnitRunner - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    AndroidJUnitRunner

    - - - - - - - - - - - - - extends MonitoringInstrumentation
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

    AndroidJUnitRunner

    +

    + + public + + + + class + AndroidJUnitRunner + +
    + + + + + + + + + + + + + + + + + extends MonitoringInstrumentation + + + + + + + + + + + +

    java.lang.Object
       ↳android.app.Instrumentation
        ↳android.support.test.runner.MonitoringInstrumentation
         ↳android.support.test.runner.AndroidJUnitRunner
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.app.Instrumentation +
        ↳android.support.test.runner.MonitoringInstrumentation +
         ↳android.support.test.runner.AndroidJUnitRunner +
    + + +

    - - - -
    - - -

    Class Overview

    -

    An Instrumentation that runs JUnit3 and JUnit4 tests against +

    An Instrumentation that runs JUnit3 and JUnit4 tests against an Android package (application).

    - Based on and replacement for InstrumentationTestRunner. Supports a superset - of InstrumentationTestRunner features, + Based on and replacement for InstrumentationTestRunner. Supports a superset + of InstrumentationTestRunner features, while maintaining command/output format compatibility with that class.

    Typical Usage

    - Write JUnit3 style TestCases and/or JUnit4 style + Write JUnit3 style TestCases and/or JUnit4 style Tests that perform tests against the classes in your package. - Make use of the InstrumentationRegistry if needed. + Make use of the InstrumentationRegistry if needed.

    In an appropriate AndroidManifest.xml, define an instrumentation with android:name set to - AndroidJUnitRunner and the appropriate android:targetPackage + AndroidJUnitRunner and the appropriate android:targetPackage set.

    Execution options: @@ -773,13 +370,12 @@ Summary: Running all tests except a particular package: adb shell am instrument -w -e notPackage com.android.foo.bar com.android.foo/android.support.test.runner.AndroidJUnitRunner +

    To debug your tests, set a break point in your code and pass: -e debug true

    - Running a specific test size i.e. annotated with - SmallTest or - MediumTest or - LargeTest: + Running a specific test size i.e. annotated with SmallTest or MediumTest or + LargeTest: adb shell am instrument -w -e size [small|medium|large] com.android.foo/android.support.test.runner.AndroidJUnitRunner

    @@ -790,7 +386,7 @@ Summary: If used with other options, the resulting test run will contain the intersection of the two options. e.g. "-e size large -e annotation com.android.foo.MyAnnotation" will run only tests with both - the LargeTest and "com.android.foo.MyAnnotation" annotations. + the LargeTest and "com.android.foo.MyAnnotation" annotations.

    Filter test run to tests without given annotation: adb shell am instrument -w -e notAnnotation com.android.foo.MyAnnotation @@ -799,7 +395,7 @@ Summary: As above, if used with other options, the resulting test run will contain the intersection of the two options. e.g. "-e size large -e notAnnotation com.android.foo.MyAnnotation" will run tests with - the LargeTest annotation that do NOT have the "com.android.foo.MyAnnotation" annotations. + the LargeTest annotation that do NOT have the "com.android.foo.MyAnnotation" annotations.

    Filter test run to tests without any of a list of annotations: adb shell am instrument -w -e notAnnotation com.android.foo.MyAnnotation,com.android.foo.AnotherAnnotation @@ -864,9 +460,9 @@ Summary: -

    +

    Summary

    @@ -881,18 +477,68 @@ Summary: -
    -

    Summary

    + + + + + +

    Inherited constants

    + + From + class + + android.app.Instrumentation + +
    + + +
    +
    @@ -901,2292 +547,2652 @@ Summary: - - + +
    - [Expand] -
    Inherited Constants
    + - - + + + + + - From class -android.app.Instrumentation -
    - -

    Public constructors

    + +
    + + AndroidJUnitRunner() + + +
    +
    -
    StringREPORT_KEY_IDENTIFIER -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - -

    Public methods

    + + + + + + void + + + finish(int resultCode, Bundle results) + + +

    Ensures all activities launched in this instrumentation are finished before the + instrumentation exits. + + +

    + +
    + + + + + + void + + + onCreate(Bundle arguments) + + +

    Sets up lifecycle monitoring, and argument registry. + + +

    + +
    + + + + + + boolean + + + onException(Object obj, Throwable e) + + +
    + + + + + + void + + + onStart() + + +

    This implementation of onStart() will guarantee that the Application's onCreate method + has completed when it returns. + + +

    + +
    StringREPORT_KEY_STREAMRESULT +
    -
    -
    -
    -
    + + +

    Inherited methods

    -
    + From +class + + + android.support.test.runner.MonitoringInstrumentation + + +
    + + +
    +
    + From +class + + + android.app.Instrumentation + + +
    + + +
    +
    + + +
    Public Constructors
    + From +class + + + java.lang.Object + + +
    + + +
    +
    -
    + + - - - AndroidJUnitRunner() -
    + + +

    Public constructors

    - - + +
    +

    AndroidJUnitRunner

    +
    +
    + + +
    +
    +AndroidJUnitRunner ()
    + + + +

    -
    - - + - - - + +
    +

    onException

    +
    +
    + + +
    +
    +boolean onException (Object obj, 
    +                Throwable e)
    + + + + +

    +
    Public Methods
    + - void - - finish(int resultCode, Bundle results) + + -
    - Ensures all activities launched in this instrumentation are finished before the - instrumentation exits. + + -
    +

    Public methods

    -
    +
    +

    finish

    +
    +
    + + +
    +
    +void finish (int resultCode, 
    +                Bundle results)
    + + + + +

    Ensures all activities launched in this instrumentation are finished before the + instrumentation exits. +

    + Subclasses who override this method should do their finish processing and then call + super.finish to invoke this logic. Not waiting for all activities to finish() before exiting + can cause device wide instability. +

    +

    + + + + + + + + + + +
    Parameters
    resultCode + int +
    results + Bundle +
    +
    + - void
    -
    - onCreate(Bundle arguments) +
    +

    onCreate

    +
    +
    + + -
    - Sets up lifecycle monitoring, and argument registry. +
    +
    +void onCreate (Bundle arguments)
    + + + +

    Sets up lifecycle monitoring, and argument registry. +

    + Subclasses must call up to onCreate(). This onCreate method does not call start() + it is the subclasses responsibility to call start if it desires. +

    +

    + + + + + + +
    Parameters
    arguments + Bundle +
    +
    -
    -
    + + + + + + + + + +
    Parameters
    obj + Object +
    e + Throwable +
    + + + + + + +
    Returns
    boolean
    -
    + + +
    +

    onStart

    +
    +
    + + +
    +
    +void onStart ()
    + + - boolean
    -
    - onException(Object obj, Throwable e) + +

    This implementation of onStart() will guarantee that the Application's onCreate method + has completed when it returns. +

    + Subclasses should call super.onStart() before executing any code that touches the application + and it's state. +

    +

    -
    + - void - - onStart() + -
    - This implementation of onStart() will guarantee that the Application's onCreate method - has completed when it returns. +
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - android.support.test.runner.MonitoringInstrumentation - -
    - - -
    -
    - -From class - - android.app.Instrumentation - -
    - - -
    -
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Constructors

    - - - - - -
    -

    - - public - - - - - - - AndroidJUnitRunner - () -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - - - - - void - - finish - (int resultCode, Bundle results) -

    -
    -
    - - - -
    -
    - - - - -

    Ensures all activities launched in this instrumentation are finished before the - instrumentation exits. -

    - Subclasses who override this method should do their finish processing and then call - super.finish to invoke this logic. Not waiting for all activities to finish() before exiting - can cause device wide instability. -

    -

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - onCreate - (Bundle arguments) -

    -
    -
    - - - -
    -
    - - - - -

    Sets up lifecycle monitoring, and argument registry. -

    - Subclasses must call up to onCreate(). This onCreate method does not call start() - it is the subclasses responsibility to call start if it desires. -

    -

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - onException - (Object obj, Throwable e) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - onStart - () -

    -
    -
    - - - -
    -
    - - - - -

    This implementation of onStart() will guarantee that the Application's onCreate method - has completed when it returns. -

    - Subclasses should call super.onStart() before executing any code that touches the application - and it's state. -

    -

    - -
    + - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    - - - - - - diff --git a/docs/html/reference/android/support/test/runner/MonitoringInstrumentation.ActivityFinisher.html b/docs/html/reference/android/support/test/runner/MonitoringInstrumentation.ActivityFinisher.html index 5eff5333e39e..3fbd43eff8cd 100644 --- a/docs/html/reference/android/support/test/runner/MonitoringInstrumentation.ActivityFinisher.html +++ b/docs/html/reference/android/support/test/runner/MonitoringInstrumentation.ActivityFinisher.html @@ -1,4 +1,3 @@ - @@ -93,491 +92,92 @@ - - - - - - -MonitoringInstrumentation.ActivityFinisher | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +MonitoringInstrumentation.ActivityFinisher - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    MonitoringInstrumentation.ActivityFinisher

    - - - - - extends Object
    - - - - - - +

    MonitoringInstrumentation.ActivityFinisher

    +

    + + public + + + + class + MonitoringInstrumentation.ActivityFinisher + +
    + + + + + extends Object + + + + + + + + implements - + Runnable - - - - - - - - -

    - -
    - -
    - - - - - - - - - - - - - - - - + + + + + +

    java.lang.Object
       ↳android.support.test.runner.MonitoringInstrumentation.ActivityFinisher
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.runner.MonitoringInstrumentation.ActivityFinisher +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Loops through all the activities that have not yet finished and explicitly calls finish +

    Loops through all the activities that have not yet finished and explicitly calls finish on them.

    @@ -689,27 +280,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -734,25 +307,23 @@ Summary: - - +
    Public Constructors
    + - - - - + + + + + + +

    Public constructors

    - - - - - - - - MonitoringInstrumentation.ActivityFinisher() - -
    + + MonitoringInstrumentation.ActivityFinisher() + + +
    @@ -763,25 +334,32 @@ Summary: - - - - - - - - - +
    Public Methods
    - - - - - - void - - run() - -
    + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + run() + + +
    @@ -793,207 +371,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1001,41 +648,51 @@ From class - @@ -1044,16 +701,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - java.lang.Runnable + + From +interface + + + java.lang.Runnable + +
    -
    - - - - - - - - - @@ -1071,39 +718,28 @@ From interface -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - MonitoringInstrumentation.ActivityFinisher - () -

    -
    -
    - - - -
    -
    - - +
    +

    MonitoringInstrumentation.ActivityFinisher

    +
    +
    + + +
    +
    +MonitoringInstrumentation.ActivityFinisher ()
    + + -

    + +

    -
    @@ -1118,39 +754,28 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - void - - run - () -

    -
    -
    - - - -
    -
    - - +
    +

    run

    +
    +
    + + +
    +
    +void run ()
    + + -

    + +

    -
    @@ -1162,193 +787,32 @@ From interface - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/runner/MonitoringInstrumentation.html b/docs/html/reference/android/support/test/runner/MonitoringInstrumentation.html index ed587c308c46..10989c3f257f 100644 --- a/docs/html/reference/android/support/test/runner/MonitoringInstrumentation.html +++ b/docs/html/reference/android/support/test/runner/MonitoringInstrumentation.html @@ -1,5 +1,3 @@ - - @@ -92,494 +90,96 @@ - - - - - - - -MonitoringInstrumentation | Android Developers - - - - - - - - - - - - - - - - - - - -
    - + - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    + + + + + + + + - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    MonitoringInstrumentation

    - - - - - - - - - extends Instrumentation
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - +

    MonitoringInstrumentation

    +

    + + public + + + + class + MonitoringInstrumentation + +
    + + + + + + + + + + + extends Instrumentation + + + + + + + + + + + +

    java.lang.Object
       ↳android.app.Instrumentation
        ↳android.support.test.runner.MonitoringInstrumentation
    + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.app.Instrumentation +
        ↳android.support.test.runner.MonitoringInstrumentation +
    - - - - - +
    - + +
    + Known Direct Subclasses - +
    -
    - - +
    + + + -
    +

    -

    Class Overview

    -

    An instrumentation that enables several advanced features and makes some hard guarantees about +

    An instrumentation that enables several advanced features and makes some hard guarantees about the state of the application under instrumentation.

    A short list of these capabilities: @@ -766,12 +362,36 @@ Summary: -

    +

    Summary

    + + + + + + + + + + + + @@ -783,2529 +403,3275 @@ Summary: -
    -

    Summary

    - -

    Nested classes

    + + + + + class + MonitoringInstrumentation.ActivityFinisher +

    Loops through all the activities that have not yet finished and explicitly calls finish + on them.  + + +

    +
    + +
    Nested Classes
    + + + - -

    Inherited constants

    + + From + class + + android.app.Instrumentation + +
    + + +
    +
    +
    - class
    MonitoringInstrumentation.ActivityFinisher - Loops through all the activities that have not yet finished and explicitly calls finish - on them.  -
    + + + + + + + + +

    Public constructors

    + + MonitoringInstrumentation() + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -

    Public methods

    + + + + + + void + + + callActivityOnCreate(Activity activity, Bundle bundle) + + +
    + + + + + + void + + + callActivityOnDestroy(Activity activity) + + +
    + + + + + + void + + + callActivityOnPause(Activity activity) + + +
    + + + + + + void + + + callActivityOnRestart(Activity activity) + + +
    + + + + + + void + + + callActivityOnResume(Activity activity) + + +
    + + + + + + void + + + callActivityOnStart(Activity activity) + + +
    + + + + + + void + + + callActivityOnStop(Activity activity) + + +
    + + + + + + void + + + callApplicationOnCreate(Application app) + + +
    + + + + + + void + + + execStartActivities(Context who, IBinder contextThread, IBinder token, Activity target, Intent[] intents, Bundle options) + + +

    + + + +

    + +
    + + + + + + Instrumentation.ActivityResult + + + execStartActivity(Context who, IBinder contextThread, IBinder token, Activity target, Intent intent, int requestCode, Bundle options) + + +

    + + + +

    + +
    + + + + + + Instrumentation.ActivityResult + + + execStartActivity(Context who, IBinder contextThread, IBinder token, Activity target, Intent intent, int requestCode) + + +

    + + + +

    + +
    + + + + + + Instrumentation.ActivityResult + + + execStartActivity(Context who, IBinder contextThread, IBinder token, Fragment target, Intent intent, int requestCode, Bundle options) + + +

    + + + +

    + +
    + + + + + + void + + + finish(int resultCode, Bundle results) + + +

    Ensures all activities launched in this instrumentation are finished before the + instrumentation exits. + + +

    + +
    + + + + + + Activity + + + newActivity(Class<?> clazz, Context context, IBinder token, Application application, Intent intent, ActivityInfo info, CharSequence title, Activity parent, String id, Object lastNonConfigurationInstance) + + +
    + + + + + + void + + + onCreate(Bundle arguments) + + +

    Sets up lifecycle monitoring, and argument registry. + + +

    + +
    + + + + + + void + + + onDestroy() + + +
    + + + + + + boolean + + + onException(Object obj, Throwable e) + + +
    + + + + + + void + + + onStart() + + +

    This implementation of onStart() will guarantee that the Application's onCreate method + has completed when it returns. + + +

    + +
    + + + + + + Activity + + + startActivitySync(Intent intent) + + +
    +
    - [Expand] -
    Inherited Constants
    -
    - From class -android.app.Instrumentation -
    - -
    + - - - - + - - + +

    Inherited methods

    StringREPORT_KEY_STREAMRESULT +
    + From +class + + + android.app.Instrumentation + + +
    + + +
    +
    -
    + From +class + + + java.lang.Object + + +
    + +
    + + + - - + + - - - + +

    + -
    Public Constructors
    + +

    Public constructors

    + +
    +

    MonitoringInstrumentation

    +
    +
    + + -
    -
    - MonitoringInstrumentation() + +
    +MonitoringInstrumentation ()
    + + -
    + + - - + + +

    Public methods

    - - - +
    +

    callActivityOnDestroy

    +
    +
    + + +
    +
    +void callActivityOnDestroy (Activity activity)
    + + + + +

    +
    Public Methods
    + +
    +

    callActivityOnCreate

    +
    +
    + + +
    +
    +void callActivityOnCreate (Activity activity, 
    +                Bundle bundle)
    + + + + +

    + + + + + + + + + + +
    Parameters
    activity + Activity +
    bundle + Bundle +
    +
    - void
    -
    - callActivityOnCreate(Activity activity, Bundle bundle) + -
    + + + + + +
    Parameters
    activity + Activity +
    +
    -
    + +
    +

    callActivityOnPause

    +
    +
    + + +
    +
    +void callActivityOnPause (Activity activity)
    + + + + +

    + + + + + + +
    Parameters
    activity + Activity +
    +
    - void
    -
    - callActivityOnDestroy(Activity activity) -
    + + + + + +
    Parameters
    activity + Activity +
    -
    + + +
    +

    callActivityOnResume

    +
    +
    + + +
    +
    +void callActivityOnResume (Activity activity)
    + + + + +

    + + + + + + +
    Parameters
    activity + Activity +
    - void
    -
    - callActivityOnPause(Activity activity) + -
    + +
    +void callActivityOnStart (Activity activity)
    + + + + +

    + + + + + + +
    Parameters
    activity + Activity +
    + + +
    +

    callActivityOnStop

    +
    +
    + + - void
    -
    - callActivityOnRestart(Activity activity) + +
    +void callActivityOnStop (Activity activity)
    + + + + +

    + + + + + + +
    Parameters
    activity + Activity +
    -
    +
    +

    callApplicationOnCreate

    +
    +
    + + +
    +
    +void callApplicationOnCreate (Application app)
    + + + + +

    + + + + + + +
    Parameters
    app + Application +
    - - - - void
    -
    - callActivityOnResume(Activity activity) - -
    - - - - - - void - - callActivityOnStart(Activity activity) - -
    - - - - - - void - - callActivityOnStop(Activity activity) - -
    - - - - - - void - - callApplicationOnCreate(Application app) - -
    - - - - - - void - - execStartActivities(Context who, IBinder contextThread, IBinder token, Activity target, Intent[] intents, Bundle options) - -
    - - - - - -
    - -
    - - - - - - Instrumentation.ActivityResult - - execStartActivity(Context who, IBinder contextThread, IBinder token, Activity target, Intent intent, int requestCode, Bundle options) - -
    - - - - - -
    - -
    - - - - - - Instrumentation.ActivityResult - - execStartActivity(Context who, IBinder contextThread, IBinder token, Activity target, Intent intent, int requestCode) - -
    - - - - - -
    - -
    - - - - - - Instrumentation.ActivityResult - - execStartActivity(Context who, IBinder contextThread, IBinder token, Fragment target, Intent intent, int requestCode, Bundle options) - -
    - - - - - -
    - -
    - - - - - - void - - finish(int resultCode, Bundle results) - -
    - Ensures all activities launched in this instrumentation are finished before the - instrumentation exits. - - - -
    - -
    - - - - - - Activity - - newActivity(Class<?> clazz, Context context, IBinder token, Application application, Intent intent, ActivityInfo info, CharSequence title, Activity parent, String id, Object lastNonConfigurationInstance) - -
    - - - - - - void - - onCreate(Bundle arguments) - -
    - Sets up lifecycle monitoring, and argument registry. - - - -
    - -
    - - - - - - void - - onDestroy() - -
    - - - - - - boolean - - onException(Object obj, Throwable e) - -
    - - - - - - void - - onStart() - -
    - This implementation of onStart() will guarantee that the Application's onCreate method - has completed when it returns. - - - -
    - -
    - - - - - - Activity - - startActivitySync(Intent intent) - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Protected Methods
    - - - - - - void - - dumpThreadStateToOutputs(String outputFileName) - -
    - - - - - - String - - getThreadState() - -
    - - - - - - void - - waitForActivitiesToComplete() - -
    - Ensures we've onStopped() all activities which were onStarted(). - - - -
    - -
    - - - - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - android.app.Instrumentation - -
    - - -
    -
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Constructors

    - - - - - -
    -

    - - public - - - - - - - MonitoringInstrumentation - () -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - - - - - void - - callActivityOnCreate - (Activity activity, Bundle bundle) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - callActivityOnDestroy - (Activity activity) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - callActivityOnPause - (Activity activity) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - callActivityOnRestart - (Activity activity) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - callActivityOnResume - (Activity activity) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - callActivityOnStart - (Activity activity) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - callActivityOnStop - (Activity activity) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - callApplicationOnCreate - (Application app) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    +
    -
    -

    - - public - - - - - void - - execStartActivities - (Context who, IBinder contextThread, IBinder token, Activity target, Intent[] intents, Bundle options) -

    -
    -
    - - - -
    -
    - - - - -

    -

    +
    +

    execStartActivities

    +
    +
    + +
    +
    +void execStartActivities (Context who, 
    +                IBinder contextThread, 
    +                IBinder token, 
    +                Activity target, 
    +                Intent[] intents, 
    +                Bundle options)
    + + + + +

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Parameters
    who + Context +
    contextThread + IBinder +
    token + IBinder +
    target + Activity +
    intents + Intent +
    options + Bundle +
    +
    -
    -

    - - public - - - - - Instrumentation.ActivityResult - - execStartActivity - (Context who, IBinder contextThread, IBinder token, Activity target, Intent intent, int requestCode, Bundle options) -

    -
    -
    - - - -
    -
    - - - - -

    -

    +
    +

    execStartActivity

    +
    +
    + +
    +
    +Instrumentation.ActivityResult execStartActivity (Context who, 
    +                IBinder contextThread, 
    +                IBinder token, 
    +                Activity target, 
    +                Intent intent, 
    +                int requestCode, 
    +                Bundle options)
    + + + + +

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Parameters
    who + Context +
    contextThread + IBinder +
    token + IBinder +
    target + Activity +
    intent + Intent +
    requestCode + int +
    options + Bundle +
    + + + + + + +
    Returns
    Instrumentation.ActivityResult
    +
    -
    -

    - - public - - - - - Instrumentation.ActivityResult - - execStartActivity - (Context who, IBinder contextThread, IBinder token, Activity target, Intent intent, int requestCode) -

    -
    -
    - - - -
    -
    - - - - -

    -

    +
    +

    execStartActivity

    +
    +
    + +
    +
    +Instrumentation.ActivityResult execStartActivity (Context who, 
    +                IBinder contextThread, 
    +                IBinder token, 
    +                Activity target, 
    +                Intent intent, 
    +                int requestCode)
    + + + + +

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Parameters
    who + Context +
    contextThread + IBinder +
    token + IBinder +
    target + Activity +
    intent + Intent +
    requestCode + int +
    + + + + + + +
    Returns
    Instrumentation.ActivityResult
    +
    -
    -

    - - public - - - - - Instrumentation.ActivityResult - - execStartActivity - (Context who, IBinder contextThread, IBinder token, Fragment target, Intent intent, int requestCode, Bundle options) -

    -
    -
    - - - -
    -
    - - - - -

    -

    +
    +

    execStartActivity

    +
    +
    + +
    +
    +Instrumentation.ActivityResult execStartActivity (Context who, 
    +                IBinder contextThread, 
    +                IBinder token, 
    +                Fragment target, 
    +                Intent intent, 
    +                int requestCode, 
    +                Bundle options)
    + + + + +

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Parameters
    who + Context +
    contextThread + IBinder +
    token + IBinder +
    target + Fragment +
    intent + Intent +
    requestCode + int +
    options + Bundle +
    + + + + + + +
    Returns
    Instrumentation.ActivityResult
    +
    -
    -

    - - public - - +
    +

    finish

    +
    +
    + + - - void - - finish - (int resultCode, Bundle results) -

    -
    -
    - - - -
    -
    - - - - -

    Ensures all activities launched in this instrumentation are finished before the +

    +
    +void finish (int resultCode, 
    +                Bundle results)
    + + + + +

    Ensures all activities launched in this instrumentation are finished before the instrumentation exits.

    Subclasses who override this method should do their finish processing and then call super.finish to invoke this logic. Not waiting for all activities to finish() before exiting can cause device wide instability.

    -

    +

    + + + + + + + + + + +
    Parameters
    resultCode + int +
    results + Bundle +
    -
    -
    -

    - - public - - +
    +

    newActivity

    +
    +
    + + - - Activity - - newActivity - (Class<?> clazz, Context context, IBinder token, Application application, Intent intent, ActivityInfo info, CharSequence title, Activity parent, String id, Object lastNonConfigurationInstance) -

    -
    -
    - - - -
    -
    - - - - -

    -
    -
    Throws
    - + +
    +Activity newActivity (Class<?> clazz, 
    +                Context context, 
    +                IBinder token, 
    +                Application application, 
    +                Intent intent, 
    +                ActivityInfo info, 
    +                CharSequence title, 
    +                Activity parent, 
    +                String id, 
    +                Object lastNonConfigurationInstance)
    + + + + +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Parameters
    clazz + Class +
    context + Context +
    token + IBinder +
    application + Application +
    intent + Intent +
    info + ActivityInfo +
    title + CharSequence +
    parent + Activity +
    id + String +
    lastNonConfigurationInstance + Object +
    + + + + + + +
    Returns
    Activity
    + + - + + - + +
    Throws
    InstantiationException - InstantiationException
    IllegalAccessException - IllegalAccessException
    -
    + -
    -
    -

    - - public - - - - - void - - onCreate - (Bundle arguments) -

    -
    -
    - - - -
    -
    - - +
    +

    onCreate

    +
    +
    + + +
    +
    +void onCreate (Bundle arguments)
    + + -

    Sets up lifecycle monitoring, and argument registry. + +

    Sets up lifecycle monitoring, and argument registry.

    Subclasses must call up to onCreate(). This onCreate method does not call start() it is the subclasses responsibility to call start if it desires.

    -

    +

    + + + + + + +
    Parameters
    arguments + Bundle +
    -
    -
    -

    - - public - - - - - void - - onDestroy - () -

    -
    -
    - - - -
    -
    - - +
    +

    onDestroy

    +
    +
    + + +
    +
    +void onDestroy ()
    + + -

    + +

    -
    -
    -

    - - public - - - - - boolean - - onException - (Object obj, Throwable e) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    onException

    +
    +
    + +
    +
    +boolean onException (Object obj, 
    +                Throwable e)
    + + + + +

    + + + + + + + + + + +
    Parameters
    obj + Object +
    e + Throwable +
    + + + + + + +
    Returns
    boolean
    +
    -
    -

    - - public - - - - - void - - onStart - () -

    -
    -
    - - - -
    -
    - - +
    +

    onStart

    +
    +
    + + +
    +
    +void onStart ()
    + + -

    This implementation of onStart() will guarantee that the Application's onCreate method + +

    This implementation of onStart() will guarantee that the Application's onCreate method has completed when it returns.

    Subclasses should call super.onStart() before executing any code that touches the application and it's state.

    -

    +

    -
    -
    -

    - - public - - - - - Activity - - startActivitySync - (Intent intent) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    startActivitySync

    +
    +
    + +
    +
    +Activity startActivitySync (Intent intent)
    + + + + +

    + + + + + + +
    Parameters
    intent + Intent +
    + + + + + + +
    Returns
    Activity
    +
    @@ -3314,101 +3680,106 @@ From class -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - - - void - - dumpThreadStateToOutputs - (String outputFileName) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    dumpThreadStateToOutputs

    +
    +
    + +
    +
    +void dumpThreadStateToOutputs (String outputFileName)
    + + + + +

    + + + + + + +
    Parameters
    outputFileName + String +
    +
    -
    -

    - - protected - - - - - String - - getThreadState - () -

    -
    -
    +
    +

    getThreadState

    +
    +
    + + +
    +
    +String getThreadState ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    -
    -
    + +
    +

    specifyDexMakerCacheProperty

    +
    +
    + + +
    +
    +void specifyDexMakerCacheProperty ()
    + + -

    + +

    -
    -
    -

    - - protected - - - - - void - - waitForActivitiesToComplete - () -

    -
    -
    - - - -
    -
    - - +
    +

    waitForActivitiesToComplete

    +
    +
    + + +
    +
    +void waitForActivitiesToComplete ()
    + + -

    Ensures we've onStopped() all activities which were onStarted(). + +

    Ensures we've onStopped() all activities which were onStarted().

    According to Activity's contract, the process is not killable between onStart and onStop. Breaking this contract (which finish() will if you let it) can cause bad behaviour (including @@ -3417,9 +3788,8 @@ From class

    We give the app 2 seconds to stop all its activities, then we proceed.

    -

    +

    -
    @@ -3427,193 +3797,32 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/runner/UsageTrackerFacilitator.html b/docs/html/reference/android/support/test/runner/UsageTrackerFacilitator.html new file mode 100644 index 000000000000..398b40efdb7b --- /dev/null +++ b/docs/html/reference/android/support/test/runner/UsageTrackerFacilitator.html @@ -0,0 +1,921 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +UsageTrackerFacilitator + + + + + + + + + + +
    + +
    +
    + + + + +
    + + + + + + + + + + + + +
    + +
    + + + +

    UsageTrackerFacilitator

    +

    + + public + + + + class + UsageTrackerFacilitator + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.runner.UsageTrackerFacilitator +
    + + + + +

    + + +

    Helper class to enable/disable usage tracker in the runner. For details on how AndroidJUnitRunner + tracks usage, see + + AndroidJUnitRunner Analytics +

    + + + + + + + +

    Summary

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + UsageTrackerFacilitator(RunnerArgs runnerArgs) + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + registerUsageTracker(UsageTracker usageTracker) + + +
    + + + + + + void + + + sendUsages() + + +
    + + + + + + boolean + + + shouldTrackUsage() + + +
    + + + + + + void + + + trackUsage(String usage) + + +
    + + + + + + + + + + + + + + + + +

    Inherited methods

    + + From +class + + + java.lang.Object + + +
    + + +
    +
    + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + + + + +
    +

    UsageTrackerFacilitator

    +
    +
    + + + +
    +
    +UsageTrackerFacilitator (RunnerArgs runnerArgs)
    + + + + +

    + + + + + + +
    Parameters
    runnerArgs + RunnerArgs +
    + +
    + + + + + + + + + + + + + +

    Public methods

    + + + + + +
    +

    registerUsageTracker

    +
    +
    + + + +
    +
    +void registerUsageTracker (UsageTracker usageTracker)
    + + + + +

    + + + + + + +
    Parameters
    usageTracker + UsageTracker +
    + +
    + + + + +
    +

    sendUsages

    +
    +
    + + + +
    +
    +void sendUsages ()
    + + + + +

    + +
    + + + + +
    +

    shouldTrackUsage

    +
    +
    + + + +
    +
    +boolean shouldTrackUsage ()
    + + + + +

    + + + + + + +
    Returns
    boolean
    + +
    + + + + +
    +

    trackUsage

    +
    +
    + + + +
    +
    +void trackUsage (String usage)
    + + + + +

    + + + + + + +
    Parameters
    usage + String +
    + +
    + + + + + + + + + + + +
    + + + + + + + + + diff --git a/docs/html/reference/android/support/test/runner/intent/IntentCallback.html b/docs/html/reference/android/support/test/runner/intent/IntentCallback.html index f0cdd1f652a6..c963ebf65e37 100644 --- a/docs/html/reference/android/support/test/runner/intent/IntentCallback.html +++ b/docs/html/reference/android/support/test/runner/intent/IntentCallback.html @@ -1,7 +1,3 @@ - - - - @@ -93,570 +89,139 @@ - - - - - - -IntentCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    - - - - - - - -
    + + + + -
    + + + + + + - -
    + + +IntentCallback -
    -
    + - - -
    - public - + + - interface -

    IntentCallback

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    IntentCallback

    +

    + + public + + + + interface + IntentCallback + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.runner.intent.IntentCallback
    android.support.test.runner.intent.IntentCallback +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Callback for monitoring Intents captured by Instrumentation. +

    Callback for monitoring Intents captured by Instrumentation.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -685,33 +250,38 @@ type="text/css"> - - - +
    Public Methods
    + - - - + + + + + - + + +

    + + + +

    Public methods

    - abstract - - - - void - - onIntentSent(Intent intent) - -
    - Called on main thread when an activity is started from the current instrumentation process + +
    + abstract + + + + + void + + + onIntentSent(Intent intent) + + +

    Called on main thread when an activity is started from the current instrumentation process by the given intent. - - - - - -

    @@ -722,16 +292,6 @@ type="text/css"> -
    - - - - - - - - - @@ -757,41 +317,39 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - onIntentSent - (Intent intent) -

    -
    -
    - - - -
    -
    - - +
    +

    onIntentSent

    +
    +
    + + +
    +
    +void onIntentSent (Intent intent)
    + + -

    Called on main thread when an activity is started from the current instrumentation process + +

    Called on main thread when an activity is started from the current instrumentation process by the given intent. -

    +

    + + + + + + +
    Parameters
    intent + Intent +
    -
    @@ -803,193 +361,36 @@ type="text/css"> - -
    - -
    - -
    - - -
    - -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/runner/intent/IntentMonitor.html b/docs/html/reference/android/support/test/runner/intent/IntentMonitor.html index 82ab88af3abb..558c639a9e9b 100644 --- a/docs/html/reference/android/support/test/runner/intent/IntentMonitor.html +++ b/docs/html/reference/android/support/test/runner/intent/IntentMonitor.html @@ -1,5 +1,3 @@ - - @@ -93,544 +91,129 @@ - - - - - - -IntentMonitor | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    - - - - - - - -
    -
    + + + + + + + + + + + - -
    + + + + -
    -
    +IntentMonitor - -
    - public + + + - interface -

    IntentMonitor

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    IntentMonitor

    +

    + + public + + + + interface + IntentMonitor + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.runner.intent.IntentMonitor
    android.support.test.runner.intent.IntentMonitor +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Interface for tests to use when they need to monitor intents used to start activities from - the current Instrumentation. +

    Interface for tests to use when they need to monitor intents used to start activities from + the current Instrumentation.

    Retrieve instances of the monitor through {@link IntentMonitorRegistry).

    @@ -642,27 +225,9 @@ type="text/css"> -

    - - - - - - - - - - - - - - - - -
    -

    Summary

    +

    Summary

    @@ -691,56 +256,65 @@ type="text/css"> - +
    Public Methods
    + - - - - + + + + + - - - - - - - + + +

    + + + + + + + + + + + + + +

    Public methods

    - abstract - - - - - void - - addIntentCallback(IntentCallback callback) - -
    - Adds an IntentCallback, which will be notified when intents are sent from the + +
    + abstract + + + + + void + + + addIntentCallback(IntentCallback callback) + + +

    Adds an IntentCallback, which will be notified when intents are sent from the current instrumentation process. - - - - - -

    - abstract - - - - - void - - removeIntentCallback(IntentCallback callback) - -
    - Removes a previously registered IntentCallback. - - - -
    - -
    + abstract + + + + + void + + + removeIntentCallback(IntentCallback callback) + + +

    Removes a previously registered IntentCallback. + + +

    + +
    @@ -751,16 +325,6 @@ type="text/css"> -
    - - - - - - - - - @@ -786,74 +350,70 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - addIntentCallback - (IntentCallback callback) -

    -
    -
    - - - -
    -
    - - +
    +

    addIntentCallback

    +
    +
    + + +
    +
    +void addIntentCallback (IntentCallback callback)
    + + -

    Adds an IntentCallback, which will be notified when intents are sent from the + +

    Adds an IntentCallback, which will be notified when intents are sent from the current instrumentation process. -

    +

    + + + + + + +
    Parameters
    callback + IntentCallback +
    -
    -
    -

    - - public - - - abstract - - void - - removeIntentCallback - (IntentCallback callback) -

    -
    -
    - - - -
    -
    - - +
    +

    removeIntentCallback

    +
    +
    + + +
    +
    +void removeIntentCallback (IntentCallback callback)
    + + -

    Removes a previously registered IntentCallback. -

    + +

    Removes a previously registered IntentCallback. +

    + + + + + + +
    Parameters
    callback + IntentCallback +
    -
    @@ -865,193 +425,36 @@ type="text/css"> - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/runner/intent/IntentMonitorRegistry.html b/docs/html/reference/android/support/test/runner/intent/IntentMonitorRegistry.html index b57307a1252a..a4d5456701d7 100644 --- a/docs/html/reference/android/support/test/runner/intent/IntentMonitorRegistry.html +++ b/docs/html/reference/android/support/test/runner/intent/IntentMonitorRegistry.html @@ -1,4 +1,3 @@ - @@ -93,489 +92,85 @@ - - - - - - -IntentMonitorRegistry | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +IntentMonitorRegistry - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    IntentMonitorRegistry

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    IntentMonitorRegistry

    +

    + + public + + final + + class + IntentMonitorRegistry + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.runner.intent.IntentMonitorRegistry
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.runner.intent.IntentMonitorRegistry +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Exposes an implementation of IntentMonitor to users. +

    Exposes an implementation of IntentMonitor to users.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -727,55 +295,64 @@ Summary: - - - - - - - - - + +
    +

    focusable

    +
    +
    + + -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Methods
    - + + - static - - IntentMonitor - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - getInstance() - -
    - Returns the IntentMonitor. - - - -
    - -
    - - - - static - - void - - registerInstance(IntentMonitor monitor) - -
    - Stores the given IntentMonitor instance in the registry. - - - -
    - -
    + + + static + + + IntentMonitor + + + getInstance() + + +

    Returns the IntentMonitor. + + +

    + +
    + + + static + + + void + + + registerInstance(IntentMonitor monitor) + + +

    Stores the given IntentMonitor instance in the registry. + + +

    + +
    @@ -787,207 +364,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -996,16 +642,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1031,84 +667,77 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - IntentMonitor - - getInstance - () -

    -
    -
    - - +
    +

    getInstance

    +
    +
    + + -
    -
    - - - - -

    Returns the IntentMonitor. This monitor is not guaranteed to be present under all' - instrumentations.

    -
    -
    Throws
    - + +
    +IntentMonitor getInstance ()
    + + + + +

    Returns the IntentMonitor. This monitor is not guaranteed to be present under all' + instrumentations.

    +
    + + + + + +
    Returns
    IntentMonitor
    + + - +
    Throws
    IllegalStateException - if no monitor has been registered. + IllegalStateExceptionif no monitor has been registered.
    -
    + -
    -
    -

    - - public - static - - - - void - - registerInstance - (IntentMonitor monitor) -

    -
    -
    - - - -
    -
    - - +
    +

    registerInstance

    +
    +
    + + +
    +
    +void registerInstance (IntentMonitor monitor)
    + + -

    Stores the given IntentMonitor instance in the registry. Passing null removes the + +

    Stores the given IntentMonitor instance in the registry. Passing null removes the monitor from the registry. -

    +

    + + + + + + +
    Parameters
    monitor + IntentMonitor +
    -
    @@ -1120,193 +749,36 @@ From class - -
    - -
    - -
    - - - -
    - -
    - + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/runner/intent/IntentStubber.html b/docs/html/reference/android/support/test/runner/intent/IntentStubber.html index 88afd279d987..d93bafea2ec7 100644 --- a/docs/html/reference/android/support/test/runner/intent/IntentStubber.html +++ b/docs/html/reference/android/support/test/runner/intent/IntentStubber.html @@ -1,5 +1,3 @@ - - @@ -93,480 +91,77 @@ - - - - - - -IntentStubber | Android Developers - - - - - - - - - - - - - - - - - - - - -
    - + - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + + +
    @@ -586,127 +181,114 @@ Summary: Methods - + | [Expand All]
    -
    - - - - -
    +
    -
    - public - - - - interface -

    IntentStubber

    - - - - - - - - +

    IntentStubber

    +

    + + public + + + + interface + IntentStubber + +
    + + + + + -

    +

    -
    - -
    -
    - - - - - - + + + + +
    android.support.test.runner.intent.IntentStubber
    android.support.test.runner.intent.IntentStubber +
    - - - - - - -
    - + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    Interface to intercept activity launch for a given Intent and stub - Instrumentation.ActivityResult its response. +

    Interface to intercept activity launch for a given Intent and stub + Instrumentation.ActivityResult its response.

    - Retrieve instances of the stubber through IntentStubberRegistry + Retrieve instances of the stubber through IntentStubberRegistry

    Stubbing intents requires support from Instrumentation, therefore do not expect an instance to be present under any arbitrary instrumentation. @@ -716,27 +298,9 @@ Summary: -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -765,33 +329,38 @@ Summary: - - - - - - - - - - + -
    Public Methods
    - abstract - + + - Instrumentation.ActivityResult - - + + + + + - + + +

    + + + +

    Public methods

    - getActivityResultForIntent(Intent intent) - -
    - Returns the first matching stubbed result for the given activity if stubbed result was set + +
    + abstract + + + + + Instrumentation.ActivityResult + + + getActivityResultForIntent(Intent intent) + + +

    Returns the first matching stubbed result for the given activity if stubbed result was set by test author. - - - - - -

    @@ -802,16 +371,6 @@ Summary: - - - - - - - - - - @@ -837,45 +396,50 @@ Summary: -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - Instrumentation.ActivityResult - - getActivityResultForIntent - (Intent intent) -

    -
    -
    - - - -
    -
    - - +
    +

    getActivityResultForIntent

    +
    +
    + + +
    +
    +Instrumentation.ActivityResult getActivityResultForIntent (Intent intent)
    + + -

    Returns the first matching stubbed result for the given activity if stubbed result was set + +

    Returns the first matching stubbed result for the given activity if stubbed result was set by test author. The method searches the list of existing matcher/response pairs in reverse order of which they were entered; i.e. the last stubbing has the highest priority. If no stubbed result matching the given intent is found, null is returned.

    Must be called on main thread. -

    +

    + + + + + + +
    Parameters
    intent + Intent +
    + + + + + + +
    Returns
    Instrumentation.ActivityResult
    -
    @@ -887,193 +451,36 @@ Summary: - -
    - -
    - -
    - - - - - - + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/runner/intent/IntentStubberRegistry.html b/docs/html/reference/android/support/test/runner/intent/IntentStubberRegistry.html index f82ddecb8e1c..06b8aaa10c62 100644 --- a/docs/html/reference/android/support/test/runner/intent/IntentStubberRegistry.html +++ b/docs/html/reference/android/support/test/runner/intent/IntentStubberRegistry.html @@ -1,4 +1,3 @@ - @@ -93,489 +92,85 @@ - - - - - - -IntentStubberRegistry | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +IntentStubberRegistry - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    IntentStubberRegistry

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    IntentStubberRegistry

    +

    + + public + + final + + class + IntentStubberRegistry + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.runner.intent.IntentStubberRegistry
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.runner.intent.IntentStubberRegistry +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Exposes an implementation of IntentStubber. +

    Exposes an implementation of IntentStubber.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -727,94 +295,113 @@ Summary: - - - - - - - - - - - - - - - - +
    Public Methods
    - - - - static - - IntentStubber - - getInstance() - -
    - Returns the loaded Intent Stubber mInstance. - - - -
    - -
    - - - - static - - boolean - - isLoaded() - -
    + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - - static - - void - - load(IntentStubber intentStubber) - -
    - Loads an IntentStubber into this registry. - - - -
    - -
    - - synchronized - - static - - void - - reset() - -
    - Clears the current instance of Intent Stubber. - - - -
    - -
    + + + static + + + IntentStubber + + + getInstance() + + +

    Returns the loaded Intent Stubber mInstance. + + +

    + +
    + + + static + + + boolean + + + isLoaded() + + +
    + + + static + + + void + + + load(IntentStubber intentStubber) + + +

    Loads an IntentStubber into this registry. + + +

    + +
    + + + static + + + void + + + reset() + + +

    Clears the current instance of Intent Stubber. + + +

    + +
    @@ -826,207 +413,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1035,16 +691,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1070,162 +716,136 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - IntentStubber - - getInstance - () -

    -
    -
    - - +
    +

    getInstance

    +
    +
    + + -
    -
    - - - - -

    Returns the loaded Intent Stubber mInstance.

    -
    -
    Throws
    - + +
    +IntentStubber getInstance ()
    + + + + +

    Returns the loaded Intent Stubber mInstance.

    +
    + + + + + +
    Returns
    IntentStubber
    + + - + + - +
    Throws
    IllegalStateException - if this method is not called on the main thread.IllegalStateExceptionif this method is not called on the main thread.
    IllegalStateException - if no Intent Stubber has been loaded. + IllegalStateExceptionif no Intent Stubber has been loaded.
    -
    + -
    -
    -

    - - public - static - - - - boolean - - isLoaded - () -

    -
    -
    - - - -
    -
    - - - - -

    -
    -
    Returns
    - -
    +
    +

    isLoaded

    +
    +
    + +
    +
    +boolean isLoaded ()
    + + + + +

    + + + + + + +
    Returns
    booleanif an IntentStubber has been loaded. +
    +
    -
    -

    - - public - static - - - - void - - load - (IntentStubber intentStubber) -

    -
    -
    - - - -
    -
    - - +
    +

    load

    +
    +
    + + +
    +
    +void load (IntentStubber intentStubber)
    + + -

    Loads an IntentStubber into this registry. There can only be one active stubber at a + +

    Loads an IntentStubber into this registry. There can only be one active stubber at a time.

    Calling this method multiple times in the same instrumentation will result in an exception.

    This method can be called from any thread. -

    +

    + + + + + + +
    Parameters
    intentStubber + IntentStubber +
    -
    -
    -

    - - public - static - - - synchronized - void - - reset - () -

    -
    -
    - - - -
    -
    - - +
    +

    reset

    +
    +
    + + +
    +
    +void reset ()
    + + -

    Clears the current instance of Intent Stubber. -

    + +

    Clears the current instance of Intent Stubber. +

    -
    @@ -1237,193 +857,36 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    +
    + + + +
    diff --git a/docs/html/reference/android/support/test/runner/intent/package-summary.html b/docs/html/reference/android/support/test/runner/intent/package-summary.html index 3a2e1497ccd0..401a356e2a16 100644 --- a/docs/html/reference/android/support/test/runner/intent/package-summary.html +++ b/docs/html/reference/android/support/test/runner/intent/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,784 +92,186 @@ - - - - - - -android.support.test.runner.intent | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.runner.intent - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.runner.intent

    -
    - -
    - -
    - - +

    android.support.test.runner.intent

    + +

    Interfaces

    -
    - - + + - + - + - - + + - + - - + + - + - - + +
    IntentCallbackIntentCallback - Callback for monitoring Intents captured by Instrumentation.  - - + Callback for monitoring Intents captured by Instrumentation.  + +
    IntentMonitorIntentMonitor Interface for tests to use when they need to monitor intents used to start activities from - the current Instrumentation.  - - + the current Instrumentation.  + +
    IntentStubberIntentStubber - Interface to intercept activity launch for a given Intent and stub - Instrumentation.ActivityResult its response.  - - + Interface to intercept activity launch for a given Intent and stub + Instrumentation.ActivityResult its response.  + +
    -
    - - + +

    Classes

    -
    - - + + - + - + + + + + + + + + +
    IntentMonitorRegistryIntentMonitorRegistry - Exposes an implementation of IntentMonitor to users.  - + Exposes an implementation of IntentMonitor to users.  + + +
    IntentStubberRegistry + Exposes an implementation of IntentStubber.  + +
    + -
    IntentStubberRegistry - Exposes an implementation of IntentStubber.  + -
    + -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    - + +
    + + + +
    diff --git a/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleCallback.html b/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleCallback.html index 9532bbc7342f..067ad2dbc872 100644 --- a/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleCallback.html +++ b/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleCallback.html @@ -1,5 +1,3 @@ - - @@ -92,551 +90,129 @@ - - - - - - - -ActivityLifecycleCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    - -
    + + + + + + + + + + + - -
    + + + + -
    -
    +ActivityLifecycleCallback - -
    - public + + + - interface -

    ActivityLifecycleCallback

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    ActivityLifecycleCallback

    +

    + + public + + + + interface + ActivityLifecycleCallback + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.runner.lifecycle.ActivityLifecycleCallback
    android.support.test.runner.lifecycle.ActivityLifecycleCallback +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Callback for monitoring activity lifecycle events. These callbacks are invoked on the main +

    Callback for monitoring activity lifecycle events. These callbacks are invoked on the main thread, so any long operations or violating the strict mode policies should be avoided.

    @@ -644,27 +220,9 @@ type="text/css"> -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -693,33 +251,38 @@ type="text/css"> - - - - +
    Public Methods
    + - - - + + + + + - + + +

    + + + +

    Public methods

    - abstract - - - void - - onActivityLifecycleChanged(Activity activity, Stage stage) - -
    - Called on the main thread after an activity has processed its lifecycle change event + +
    + abstract + + + + + void + + + onActivityLifecycleChanged(Activity activity, Stage stage) + + +

    Called on the main thread after an activity has processed its lifecycle change event (for example onResume or onStart) - - - - - -

    @@ -730,16 +293,6 @@ type="text/css"> -
    - - - - - - - - - @@ -765,54 +318,46 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - onActivityLifecycleChanged - (Activity activity, Stage stage) -

    -
    -
    - - +
    +

    onActivityLifecycleChanged

    +
    +
    + + -
    -
    - - - - -

    Called on the main thread after an activity has processed its lifecycle change event - (for example onResume or onStart)

    -
    -
    Parameters
    - - - - - - +
    activity - The activity
    stage - its current stage. + +
    +void onActivityLifecycleChanged (Activity activity, 
    +                Stage stage)
    + + + + +

    Called on the main thread after an activity has processed its lifecycle change event + (for example onResume or onStart)

    + + + + + + + + + - -
    Parameters
    activity + Activity: + The activity
    stage + Stage: + its current stage.
    - +
    -
    @@ -824,193 +369,43 @@ type="text/css"> - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitor.html b/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitor.html index 21337f8e8c33..f510eaefad40 100644 --- a/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitor.html +++ b/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitor.html @@ -1,4 +1,3 @@ - @@ -93,590 +92,146 @@ - - - - - - -ActivityLifecycleMonitor | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    + + + -
    + + + + + + + + + - -
    + + + -
    -
    +ActivityLifecycleMonitor - + -
    - public + + - interface -

    ActivityLifecycleMonitor

    +
    +
    +
    + + + +
    + +
    +
    + -
    +

    ActivityLifecycleMonitor

    +

    + + public + + + + interface + ActivityLifecycleMonitor + +
    -

    -
    - + + + + + +

    - - - - + + + + +
    android.support.test.runner.lifecycle.ActivityLifecycleMonitor
    android.support.test.runner.lifecycle.ActivityLifecycleMonitor +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Interface for tests to use when they need to query the activity lifecycle state. +

    Interface for tests to use when they need to query the activity lifecycle state.

    Activity lifecycle changes occur only on the UI thread - therefore listeners registered with an ActivityLifecycleMonitor should expect to be invoked on the UI thread. The direct query methods can only be called on the UI thread because otherwise they would not be able to return consistent responses. -

    - Retrieve instances of the monitor thru ActivityLifecycleMonitorRegistry. -

    + Retrieve instances of the monitor through ActivityLifecycleMonitorRegistry.

    Detecting these lifecycle states requires support from Instrumentation, therefore do not expect an instance to be present under any arbitrary instrumentation. -

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -705,101 +260,118 @@ type="text/css"> - - - - - - - - - - - - - - - - - - - - - + +
    +BySelector descEndsWith (String substring)
    + + + + +

    Constructs a new BySelector and sets the content description criteria.

    +
    Public Methods
    - abstract - - - - - void - - addLifecycleCallback(ActivityLifecycleCallback callback) - -
    - Adds a new callback that will be notified when lifecycle changes occur. - - - -
    - -
    - abstract - - - - - Collection<Activity> - - getActivitiesInStage(Stage stage) - -
    - Returns all activities in a given stage of their lifecycle. - - - -
    - -
    - abstract + + - - Stage - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    - getLifecycleStageOf(Activity activity) - -
    - Returns the current lifecycle stage of a given activity. - - - -
    - -
    - abstract - - - - - void - - removeLifecycleCallback(ActivityLifecycleCallback callback) - -
    - Removes a previously registered lifecycle callback. - - - -
    - -
    + abstract + + + + + void + + + addLifecycleCallback(ActivityLifecycleCallback callback) + + +

    Adds a new callback that will be notified when lifecycle changes occur. + + +

    + +
    + abstract + + + + + Collection<Activity> + + + getActivitiesInStage(Stage stage) + + +

    Returns all activities in a given stage of their lifecycle. + + +

    + +
    + abstract + + + + + Stage + + + getLifecycleStageOf(Activity activity) + + +

    Returns the current lifecycle stage of a given activity. + + +

    + +
    + abstract + + + + + void + + + removeLifecycleCallback(ActivityLifecycleCallback callback) + + +

    Removes a previously registered lifecycle callback. + + +

    + +
    @@ -810,16 +382,6 @@ type="text/css"> - - - - - - - - - - @@ -845,37 +407,27 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - addLifecycleCallback - (ActivityLifecycleCallback callback) -

    -
    -
    - - - -
    -
    - - +
    +

    addLifecycleCallback

    +
    +
    + + +
    +
    +void addLifecycleCallback (ActivityLifecycleCallback callback)
    + + -

    Adds a new callback that will be notified when lifecycle changes occur. + +

    Adds a new callback that will be notified when lifecycle changes occur.

    Implementors will not hold a strong ref to the callback, the code which registers callbacks is responsible for this. Code which registers callbacks should responsibly @@ -884,49 +436,38 @@ type="text/css">

    Callbacks are executed on the main thread of the application, and should take care not to block or otherwise perform expensive operations as it will directly impact the application. -

    -
    -
    Parameters
    - - - +
    callback - an ActivityLifecycleCallback +

    + + + + + - -
    Parameters
    callback + ActivityLifecycleCallback: + an ActivityLifecycleCallback
    - +
    -
    -
    -

    - - public - - - abstract - - Collection<Activity> - - getActivitiesInStage - (Stage stage) -

    -
    -
    - - - -
    -
    - - +
    +

    getActivitiesInStage

    +
    +
    + + +
    +
    +Collection<Activity> getActivitiesInStage (Stage stage)
    + + -

    Returns all activities in a given stage of their lifecycle. + +

    Returns all activities in a given stage of their lifecycle.

    This method can only return a consistant and correct answer from the main thread, therefore callers should always invoke it from the main thread and implementors are free to throw an @@ -942,62 +483,53 @@ type="text/css"> Callers should be aware that the monitor implementation may not hold strong references to the Activities in the application. Therefore stages which are considered end stages or eligible for garbage collection on low memory situations may not return an instance of a particular - activity if it has been garbage collected.

    -
    -
    Parameters
    - - - - -
    stage - the stage to query for.
    -
    -
    -
    Returns
    -
    • a snapshot Collection of activities in the given stage. This collection may be empty.
    -
    -
    -
    Throws
    - + activity if it has been garbage collected.

    +
    + + + + + +
    Parameters
    stage + Stage: + the stage to query for.
    + + + + + + +
    Returns
    Collection<Activity>a snapshot Collection of activities in the given stage. This collection may be empty.
    + + - +
    Throws
    IllegalStateException - if called from outside the main thread. + IllegalStateExceptionif called from outside the main thread.
    -
    + -
    -
    -

    - - public - - - abstract - - Stage - - getLifecycleStageOf - (Activity activity) -

    -
    -
    - - - -
    -
    - - +
    +

    getLifecycleStageOf

    +
    +
    + + +
    +
    +Stage getLifecycleStageOf (Activity activity)
    + + -

    Returns the current lifecycle stage of a given activity. + +

    Returns the current lifecycle stage of a given activity.

    This method can only return a consistant and correct answer from the main thread, therefore callers should always invoke @@ -1008,73 +540,72 @@ type="text/css"> Implementors should ensure this method returns a consistant response if called from a lifecycle callback also registered with this monitor (eg: it would be horriblely wrong if a callback sees PAUSED and calls this method with the same activity and gets RESUMED. -

    -
    -
    Parameters
    - +

    +
    + + + + + +
    Parameters
    activity + Activity: + an activity in this application.
    + + + + + + +
    Returns
    Stagethe lifecycle stage this activity is in.
    + + - + + -
    Throws
    activity - an activity in this application.IllegalArgumentExceptionif activity is unknown to the monitor.
    -
    -
    -
    Returns
    -
    • the lifecycle stage this activity is in.
    -
    -
    -
    Throws
    - - + + - - - - +
    IllegalArgumentException - if activity is unknown to the monitor.NullPointerExceptionif activity is null.
    NullPointerException - if activity is null.
    IllegalStateException - if called off the main thread. + IllegalStateExceptionif called off the main thread.
    -
    + -
    -
    -

    - - public - - - abstract - - void - - removeLifecycleCallback - (ActivityLifecycleCallback callback) -

    -
    -
    - - - -
    -
    - - +
    +

    removeLifecycleCallback

    +
    +
    + + +
    +
    +void removeLifecycleCallback (ActivityLifecycleCallback callback)
    + + -

    Removes a previously registered lifecycle callback. -

    + +

    Removes a previously registered lifecycle callback. +

    + + + + + + +
    Parameters
    callback + ActivityLifecycleCallback +
    -
    @@ -1086,193 +617,43 @@ type="text/css"> - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitorRegistry.html b/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitorRegistry.html index def3bc274194..b0c249dbcdb7 100644 --- a/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitorRegistry.html +++ b/docs/html/reference/android/support/test/runner/lifecycle/ActivityLifecycleMonitorRegistry.html @@ -1,4 +1,3 @@ - @@ -93,496 +92,85 @@ - - - - - - -ActivityLifecycleMonitorRegistry | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ActivityLifecycleMonitorRegistry - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ActivityLifecycleMonitorRegistry

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    ActivityLifecycleMonitorRegistry

    +

    + + public + + final + + class + ActivityLifecycleMonitorRegistry + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.runner.lifecycle.ActivityLifecycleMonitorRegistry
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.runner.lifecycle.ActivityLifecycleMonitorRegistry +
    + + +

    - - - -
    - - -

    Class Overview

    -

    An exposed registry instance to make it easy for callers to find the lifecycle monitor for their +

    An exposed registry instance to make it easy for callers to find the lifecycle monitor for their application.

    @@ -686,27 +265,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -735,55 +296,64 @@ Summary: - - - - - - - - - + + - - - + +
    +

    depth

    +
    +
    + + -
    - - + +
    +

    desc

    +
    +
    + + +
    +
    +BySelector desc (Pattern contentDescription)
    + + + + +

    Constructs a new BySelector and sets the content description criteria.

    +
    Public Methods
    - - - - static + + - ActivityLifecycleMonitor - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - getInstance() -
    - Returns the ActivityLifecycleMonitor. - - - -
    - -
    - - - - static - - void - - registerInstance(ActivityLifecycleMonitor monitor) - -
    - Stores a lifecycle monitor in the registry. - - - -
    - -
    + + + static + + + ActivityLifecycleMonitor + + + getInstance() + + +

    Returns the ActivityLifecycleMonitor. + + +

    + +
    + + + static + + + void + + + registerInstance(ActivityLifecycleMonitor monitor) + + +

    Stores a lifecycle monitor in the registry. + + +

    + +
    @@ -795,207 +365,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1004,16 +643,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1039,100 +668,80 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - ActivityLifecycleMonitor - - getInstance - () -

    -
    -
    - +
    +

    getInstance

    +
    +
    + + - -
    -
    - - - - -

    Returns the ActivityLifecycleMonitor. - - This monitor is not guaranteed to be present under all instrumentations.

    -
    -
    Returns
    -
    • ActivityLifecycleMonitor the monitor for this application.
    -
    -
    -
    Throws
    - + +
    +ActivityLifecycleMonitor getInstance ()
    + + + + +

    Returns the ActivityLifecycleMonitor. + + This monitor is not guaranteed to be present under all instrumentations.

    +
    + + + + + +
    Returns
    ActivityLifecycleMonitorActivityLifecycleMonitor the monitor for this application.
    + + - +
    Throws
    IllegalStateException - if no monitor has been registered. + IllegalStateExceptionif no monitor has been registered.
    -
    + -
    -
    -

    - - public - static - - - - void - - registerInstance - (ActivityLifecycleMonitor monitor) -

    -
    -
    - - - -
    -
    - - +
    +

    registerInstance

    +
    +
    + + +
    +
    +void registerInstance (ActivityLifecycleMonitor monitor)
    + + -

    Stores a lifecycle monitor in the registry. + +

    Stores a lifecycle monitor in the registry.

    This is a global registry - so be aware of the impact of calling this method! -

    -
    -
    Parameters
    - - - +
    monitor - the monitor for this application. Null deregisters any existing monitor. +

    + + + + + - -
    Parameters
    monitor + ActivityLifecycleMonitor: + the monitor for this application. Null deregisters any existing monitor.
    - +
    -
    @@ -1144,193 +753,43 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    + + diff --git a/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleCallback.html b/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleCallback.html index a9b859cb0223..6f73722b9aae 100644 --- a/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleCallback.html +++ b/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleCallback.html @@ -1,5 +1,3 @@ - - @@ -92,578 +90,138 @@ - - - - - - - -ApplicationLifecycleCallback | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    - -
    + + + + + + + + + + + - -
    + + + + -
    -
    +ApplicationLifecycleCallback - -
    - public + + + - interface -

    ApplicationLifecycleCallback

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    ApplicationLifecycleCallback

    +

    + + public + + + + interface + ApplicationLifecycleCallback + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.runner.lifecycle.ApplicationLifecycleCallback
    android.support.test.runner.lifecycle.ApplicationLifecycleCallback +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Callback for monitoring application lifecycle events. +

    Callback for monitoring application lifecycle events.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -692,35 +250,40 @@ type="text/css"> - - - - +
    Public Methods
    + - - - + + + + + - + + +

    + + + +

    Public methods

    - abstract - - - void - - onApplicationLifecycleChanged(Application app, ApplicationStage stage) - -
    - Called on after an application has processed its lifecycle change event + +
    + abstract + + + + + void + + + onApplicationLifecycleChanged(Application app, ApplicationStage stage) + + +

    Called on after an application has processed its lifecycle change event (for example onCreate) These callbacks may occur on main thread so implementers should limit the amount of processing performed - - - - - -

    @@ -731,16 +294,6 @@ type="text/css"> -
    - - - - - - - - - @@ -766,56 +319,48 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - onApplicationLifecycleChanged - (Application app, ApplicationStage stage) -

    -
    -
    - - +
    +

    onApplicationLifecycleChanged

    +
    +
    + + -
    -
    - - - - -

    Called on after an application has processed its lifecycle change event +

    +
    +void onApplicationLifecycleChanged (Application app, 
    +                ApplicationStage stage)
    + + + + +

    Called on after an application has processed its lifecycle change event (for example onCreate) These callbacks may occur on main thread so implementers should limit the amount of - processing performed

    -
    -
    Parameters
    - - - - - - +
    app - the Application
    stage - its current stage. + processing performed

    + + + + + + + + + - -
    Parameters
    app + Application: + the Application
    stage + ApplicationStage: + its current stage.
    - +
    -
    @@ -827,193 +372,43 @@ type="text/css"> - -
    - -
    - -
    - - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitor.html b/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitor.html index 36e5892973af..96e3075cb551 100644 --- a/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitor.html +++ b/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitor.html @@ -1,8 +1,3 @@ - - - - - @@ -92,551 +87,132 @@ - - - - - - - -ApplicationLifecycleMonitor | Android Developers - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    -
    + + + + + + + + + + + - -
    + + + + -
    -
    +ApplicationLifecycleMonitor - -
    - public + + + - interface -

    ApplicationLifecycleMonitor

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    ApplicationLifecycleMonitor

    +

    + + public + + + + interface + ApplicationLifecycleMonitor + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.runner.lifecycle.ApplicationLifecycleMonitor
    android.support.test.runner.lifecycle.ApplicationLifecycleMonitor +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Interface for tests to use when they need to be informed of the application lifecycle state. +

    Interface for tests to use when they need to be informed of the application lifecycle state.

    Retrieve instances of the monitor thru ApplicationLifecycleMonitorRegistry.

    @@ -650,27 +226,9 @@ type="text/css"> -
    - - - - - - - - - - - - - - - - -
    -

    Summary

    +

    Summary

    @@ -699,55 +257,64 @@ type="text/css"> - +
    Public Methods
    + - - - - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - abstract - - - - - void - - addLifecycleCallback(ApplicationLifecycleCallback callback) - -
    - Adds a new callback that will be notified when lifecycle changes occur. - - - -
    - -
    - abstract - - - - - void - - removeLifecycleCallback(ApplicationLifecycleCallback callback) - -
    - Removes a previously registered lifecycle callback. - - - -
    - -
    + abstract + + + + + void + + + addLifecycleCallback(ApplicationLifecycleCallback callback) + + +

    Adds a new callback that will be notified when lifecycle changes occur. + + +

    + +
    + abstract + + + + + void + + + removeLifecycleCallback(ApplicationLifecycleCallback callback) + + +

    Removes a previously registered lifecycle callback. + + +

    + +
    @@ -758,16 +325,6 @@ type="text/css"> -
    - - - - - - - - - @@ -793,37 +350,27 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - void - - addLifecycleCallback - (ApplicationLifecycleCallback callback) -

    -
    -
    - - - -
    -
    - - +
    +

    addLifecycleCallback

    +
    +
    + + +
    +
    +void addLifecycleCallback (ApplicationLifecycleCallback callback)
    + + -

    Adds a new callback that will be notified when lifecycle changes occur. + +

    Adds a new callback that will be notified when lifecycle changes occur.

    Implementors will not hold a strong ref to the callback, the code which registers callbacks is responsible for this. Code which registers callbacks should responsibly @@ -832,52 +379,49 @@ type="text/css">

    Callbacks may be executed on the main thread of the application, and should take care not to block or otherwise perform expensive operations as it will directly impact the application. -

    -
    -
    Parameters
    - - - +
    callback - an ApplicationLifecycleCallback +

    + + + + + - -
    Parameters
    callback + ApplicationLifecycleCallback: + an ApplicationLifecycleCallback
    - +
    -
    -
    -

    - - public - - - abstract - - void - - removeLifecycleCallback - (ApplicationLifecycleCallback callback) -

    -
    -
    - - - -
    -
    - - +
    +

    removeLifecycleCallback

    +
    +
    + + +
    +
    +void removeLifecycleCallback (ApplicationLifecycleCallback callback)
    + + -

    Removes a previously registered lifecycle callback. -

    + +

    Removes a previously registered lifecycle callback. +

    + + + + + + +
    Parameters
    callback + ApplicationLifecycleCallback +
    -
    @@ -889,193 +433,43 @@ type="text/css"> - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitorRegistry.html b/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitorRegistry.html index 0107635fdece..e63b39e6c10b 100644 --- a/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitorRegistry.html +++ b/docs/html/reference/android/support/test/runner/lifecycle/ApplicationLifecycleMonitorRegistry.html @@ -1,4 +1,3 @@ - @@ -93,496 +92,85 @@ - - - - - - -ApplicationLifecycleMonitorRegistry | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ApplicationLifecycleMonitorRegistry - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - class -

    ApplicationLifecycleMonitorRegistry

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    ApplicationLifecycleMonitorRegistry

    +

    + + public + + final + + class + ApplicationLifecycleMonitorRegistry + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.runner.lifecycle.ApplicationLifecycleMonitorRegistry
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.runner.lifecycle.ApplicationLifecycleMonitorRegistry +
    + + +

    - - - -
    - - -

    Class Overview

    -

    An exposed registry instance to make it easy for callers to find the application lifecycle +

    An exposed registry instance to make it easy for callers to find the application lifecycle monitor for their application.

    @@ -686,27 +265,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -735,55 +296,64 @@ Summary: - - - - - - -
    Public Methods
    - - - - static + + - ApplicationLifecycleMonitor - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - getInstance() -
    - Returns the ActivityLifecycleMonitor. - - - -
    - -
    - - - - static - - void - - registerInstance(ApplicationLifecycleMonitor monitor) - -
    - Stores a lifecycle monitor in the registry. - - - -
    - -
    + + + static + + + ApplicationLifecycleMonitor + + + getInstance() + + +

    Returns the ActivityLifecycleMonitor. + + +

    + +
    + + + static + + + void + + + registerInstance(ApplicationLifecycleMonitor monitor) + + +

    Stores a lifecycle monitor in the registry. + + +

    + +
    @@ -795,207 +365,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1004,16 +643,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1039,100 +668,80 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - ApplicationLifecycleMonitor - - getInstance - () -

    -
    -
    - +
    +

    getInstance

    +
    +
    + + - -
    -
    - - - - -

    Returns the ActivityLifecycleMonitor. - - This monitor is not guaranteed to be present under all instrumentations.

    -
    -
    Returns
    -
    • ActivityLifecycleMonitor the monitor for this application.
    -
    -
    -
    Throws
    - + +
    +ApplicationLifecycleMonitor getInstance ()
    + + + + +

    Returns the ActivityLifecycleMonitor. + + This monitor is not guaranteed to be present under all instrumentations.

    +
    + + + + + +
    Returns
    ApplicationLifecycleMonitorActivityLifecycleMonitor the monitor for this application.
    + + - +
    Throws
    IllegalStateException - if no monitor has been registered. + IllegalStateExceptionif no monitor has been registered.
    -
    + -
    -
    -

    - - public - static - - - - void - - registerInstance - (ApplicationLifecycleMonitor monitor) -

    -
    -
    - - - -
    -
    - - +
    +

    registerInstance

    +
    +
    + + +
    +
    +void registerInstance (ApplicationLifecycleMonitor monitor)
    + + -

    Stores a lifecycle monitor in the registry. + +

    Stores a lifecycle monitor in the registry.

    This is a global registry - so be aware of the impact of calling this method! -

    -
    -
    Parameters
    - - - +
    monitor - the monitor for this application. Null deregisters any existing monitor. +

    + + + + + - -
    Parameters
    monitor + ApplicationLifecycleMonitor: + the monitor for this application. Null deregisters any existing monitor.
    - +
    -
    @@ -1144,193 +753,43 @@ From class - -
    - -
    - -
    - - - -
    - -
    -
    + + diff --git a/docs/html/reference/android/support/test/runner/lifecycle/ApplicationStage.html b/docs/html/reference/android/support/test/runner/lifecycle/ApplicationStage.html index 5250cc1d5900..5eeaec62a8e7 100644 --- a/docs/html/reference/android/support/test/runner/lifecycle/ApplicationStage.html +++ b/docs/html/reference/android/support/test/runner/lifecycle/ApplicationStage.html @@ -1,4 +1,3 @@ - @@ -93,515 +92,104 @@ - - - - - - -ApplicationStage | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +ApplicationStage - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - final - - enum -

    ApplicationStage

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - +

    ApplicationStage

    +

    + + public + + final + + enum + ApplicationStage + +
    + + + + + + + + + + + extends Enum<ApplicationStage> + + + + + + + + + + + +

    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.runner.lifecycle.ApplicationStage
    + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Enum<android.support.test.runner.lifecycle.ApplicationStage> +
        ↳android.support.test.runner.lifecycle.ApplicationStage +
    + + +

    - - - -
    - - -

    Class Overview

    -

    An enumeration of the lifecycle stages an application undergoes that can be monitored. +

    An enumeration of the lifecycle stages an application undergoes that can be monitored.

    - See the Application javadoc for detailed documentation. + See the Application javadoc for detailed documentation.

    @@ -724,27 +306,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -757,33 +321,34 @@ Summary: - - - - - - - - - - - - - - - - - +
    Enum Values
    ApplicationStage CREATED  - Indicates that onCreate has finished.  - - - -
    ApplicationStage PRE_ON_CREATE  - Indicates that onCreate is being called before any onCreate code executes.  - - - -
    + + + + + + + + + + + + + + + @@ -803,41 +368,54 @@ Summary: -

    Enum values

    ApplicationStage  + CREATED +

    Indicates that onCreate has finished.  + + +

    +
    ApplicationStage  + PRE_ON_CREATE +

    Indicates that onCreate is being called before any onCreate code executes.  + + +

    +
    - - - +
    Public Methods
    + - - - - - - - - - - + + + + + + + + + + + + + + + + + + +

    Public methods

    - - static - - ApplicationStage - - valueOf(String name) - -
    - - - final - static - - ApplicationStage[] - - values() - -
    + + + static + + + ApplicationStage + + + valueOf(String name) + + +
    + + + static + final + + ApplicationStage[] + + + values() + + +
    @@ -849,207 +427,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1057,201 +704,271 @@ From class - @@ -1261,41 +978,51 @@ From class - @@ -1304,16 +1031,6 @@ From interface

    Inherited methods

    - -From class - - java.lang.Enum + + From +class + + + java.lang.Enum + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - -From interface - - java.lang.Comparable + + From +interface + + + java.lang.Comparable + +
    -
    - - - - - - - - - @@ -1322,69 +1039,53 @@ From interface -

    Enum Values

    +

    Enum values

    -
    -

    - - public - static - final - ApplicationStage - - CREATED -

    -
    - - - - -
    -
    - - +
    +

    CREATED

    +
    + + + +
    +
    +ApplicationStage CREATED
    + + -

    Indicates that onCreate has finished.

    - + +

    Indicates that onCreate has finished.

    -
    +
    -
    -

    - - public - static - final - ApplicationStage - - PRE_ON_CREATE -

    -
    - - - +
    +

    PRE_ON_CREATE

    +
    + + + -
    -
    - - - - -

    Indicates that onCreate is being called before any onCreate code executes.

    +
    +
    +ApplicationStage PRE_ON_CREATE
    + + + +

    Indicates that onCreate is being called before any onCreate code executes.

    -
    +
    @@ -1408,71 +1109,72 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - ApplicationStage - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +ApplicationStage valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    ApplicationStage
    +
    -
    -

    - - public - static - final - - - ApplicationStage[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +ApplicationStage[] values ()
    + + + + +

    + + + + + + +
    Returns
    ApplicationStage[]
    +
    @@ -1484,193 +1186,43 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/runner/lifecycle/Stage.html b/docs/html/reference/android/support/test/runner/lifecycle/Stage.html index 8f5fd558f5e7..b730f112a8a4 100644 --- a/docs/html/reference/android/support/test/runner/lifecycle/Stage.html +++ b/docs/html/reference/android/support/test/runner/lifecycle/Stage.html @@ -1,861 +1,3 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Stage | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - - final - - enum -

    Stage

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.runner.lifecycle.Stage
    - - - - - - - -
    - - -

    Class Overview

    -

    An enumeration of the lifecycle stages an activity undergoes. -

    - See the Activity javadoc for detailed documentation. -

    -

    - - - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -874,45 +16,22 @@ Summary: - -
    Enum Values
    Stage CREATED  - Indicates that onCreate has been called.  - - - -
    Stage DESTROYED  - Indicates that onDestroy has been called - system is shutting down the activity.  - - - -
    Stage PAUSED  - Indicates that onPause has been called - activity is no longer in the foreground.  - - - -
    Stage PRE_ON_CREATE  - Indicates that onCreate is being called before any onCreate code executes.  - - - -
    Stage RESTARTED  - Indicates that onResume has been called - we have navigated back to the activity.  - - - -
    Stage RESUMED  - Indicates that onResume has been called - activity is now visible to user.  - - - -
    Stage STARTED  - Indicates that onStart has been called.  - - - -
    Stage STOPPED  - Indicates that onStop has been called - activity is no longer visible to the user.  - - - -
    - - - - - - - - - -
    Public Methods
    - static - Stage - - valueOf(String name) -
    - final - static - Stage[] - - values() -
    @@ -920,410 +39,1008 @@ Summary: - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - java.lang.Enum -
    - -
    -
    - -From class - - java.lang.Object - -
    - -
    +

    +

    An enumeration of the lifecycle stages an activity undergoes. +

    + See the Activity javadoc for detailed documentation. +

    +

    - int
    -
    - hashCode() -
    +

    Summary

    - final - void
    -
    - notify() -
    - final + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - void - - - - - - - - - - - @@ -1333,41 +1050,51 @@ From class - @@ -1376,16 +1103,6 @@ From interface

    Enum values

    Stage  + CREATED +

    Indicates that onCreate has been called.  + + +

    +
    Stage  + DESTROYED +

    Indicates that onDestroy has been called - system is shutting down the activity.  + + +

    +
    Stage  + PAUSED +

    Indicates that onPause has been called - activity is no longer in the foreground.  + + +

    +
    Stage  + PRE_ON_CREATE +

    Indicates that onCreate is being called before any onCreate code executes.  + + +

    +
    Stage  + RESTARTED +

    Indicates that onResume has been called - we have navigated back to the activity.  + + +

    +
    Stage  + RESUMED +

    Indicates that onResume has been called - activity is now visible to user.  + + +

    +
    Stage  + STARTED +

    Indicates that onStart has been called.  + + +

    +
    Stage  + STOPPED +

    Indicates that onStop has been called - activity is no longer visible to the user.  + + +

    +
    - notifyAll() -
    - String - - toString() -
    - final - void - - wait() + + + - + + + + + + + + + + + + + + + + + + + - -

    Public methods

    + + + static + + + Stage + + + valueOf(String name) + + +
    + + + static + final + + Stage[] + + + values() + + +
    +
    - final - void -
    - wait(long arg0, int arg1) -
    + + + - final + + - void - - + +

    Inherited methods

    + From +class + + + java.lang.Enum + + +
    + + +
    +
    - wait(long arg0) -
    -
    + From +class + + + java.lang.Object + + +
    + +
    - -From interface - - java.lang.Comparable + + From +interface + + + java.lang.Comparable + +
    - - - - - - - - - - @@ -1394,255 +1111,191 @@ From interface -

    Enum Values

    +

    Enum values

    -
    -

    - - public - static - final - Stage - - CREATED -

    -
    - +
    +

    CREATED

    +
    + + + +
    +
    +Stage CREATED
    + + + +

    Indicates that onCreate has been called.

    -
    -
    - - - - -

    Indicates that onCreate has been called.

    - - -
    +
    -
    -

    - - public - static - final - Stage - - DESTROYED -

    -
    - - - - -
    -
    - - +
    +

    DESTROYED

    +
    + + + +
    +
    +Stage DESTROYED
    + + -

    Indicates that onDestroy has been called - system is shutting down the activity.

    - + +

    Indicates that onDestroy has been called - system is shutting down the activity.

    -
    +
    -
    -

    - - public - static - final - Stage - - PAUSED -

    -
    - - - +
    +

    PAUSED

    +
    + + + -
    -
    - - - - -

    Indicates that onPause has been called - activity is no longer in the foreground.

    +
    +
    +Stage PAUSED
    + + + +

    Indicates that onPause has been called - activity is no longer in the foreground.

    -
    +
    -
    -

    - - public - static - final - Stage - - PRE_ON_CREATE -

    -
    - - - - -
    -
    +
    +

    PRE_ON_CREATE

    +
    + + + +
    +
    +Stage PRE_ON_CREATE
    + + + +

    Indicates that onCreate is being called before any onCreate code executes.

    - -

    Indicates that onCreate is being called before any onCreate code executes.

    - - -
    +
    -
    -

    - - public - static - final - Stage - - RESTARTED -

    -
    - - - - -
    -
    - +
    +

    RESTARTED

    +
    + + + +
    +
    +Stage RESTARTED
    + + + +

    Indicates that onResume has been called - we have navigated back to the activity.

    -

    Indicates that onResume has been called - we have navigated back to the activity.

    - - -
    +
    -
    -

    - - public - static - final - Stage - - RESUMED -

    -
    - - +
    +

    RESUMED

    +
    + + + +
    +
    +Stage RESUMED
    + + -
    -
    - - - - -

    Indicates that onResume has been called - activity is now visible to user.

    - + +

    Indicates that onResume has been called - activity is now visible to user.

    -
    +
    -
    -

    - - public - static - final - Stage - - STARTED -

    -
    - - - - -
    -
    - - - +
    +

    STARTED

    +
    + + + -

    Indicates that onStart has been called.

    +
    +
    +Stage STARTED
    + + + +

    Indicates that onStart has been called.

    -
    +
    -
    -

    - - public - static - final - Stage - - STOPPED -

    -
    - - - - -
    -
    +
    +

    STOPPED

    +
    + + + +
    +
    +Stage STOPPED
    + + + +

    Indicates that onStop has been called - activity is no longer visible to the user.

    - -

    Indicates that onStop has been called - activity is no longer visible to the user.

    - - -
    +
    @@ -1666,71 +1319,72 @@ From interface -

    Public Methods

    +

    Public methods

    -
    -

    - - public - static - - - - Stage - - valueOf - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    valueOf

    +
    +
    + +
    +
    +Stage valueOf (String name)
    + + + + +

    + + + + + + +
    Parameters
    name + String +
    + + + + + + +
    Returns
    Stage
    +
    -
    -

    - - public - static - final - - - Stage[] - - values - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    values

    +
    +
    + +
    +
    +Stage[] values ()
    + + + + +

    + + + + + + +
    Returns
    Stage[]
    +
    @@ -1742,193 +1396,43 @@ From interface - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/runner/lifecycle/package-summary.html b/docs/html/reference/android/support/test/runner/lifecycle/package-summary.html index c8542f35f1e2..b8e8b2f31438 100644 --- a/docs/html/reference/android/support/test/runner/lifecycle/package-summary.html +++ b/docs/html/reference/android/support/test/runner/lifecycle/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,835 +92,235 @@ - - - - - - -android.support.test.runner.lifecycle | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.runner.lifecycle - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.runner.lifecycle

    -
    - -
    - -
    - - +

    android.support.test.runner.lifecycle

    + +

    Interfaces

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + +
    ActivityLifecycleCallbackActivityLifecycleCallback Callback for monitoring activity lifecycle events.  - - + +
    ActivityLifecycleMonitorActivityLifecycleMonitor Interface for tests to use when they need to query the activity lifecycle state.  - - + +
    ApplicationLifecycleCallbackApplicationLifecycleCallback Callback for monitoring application lifecycle events.  - - + +
    ApplicationLifecycleMonitorApplicationLifecycleMonitor Interface for tests to use when they need to be informed of the application lifecycle state.  - - + +
    -
    - - + +

    Classes

    -
    - - + + - + - + - - + + - + - - + +
    ActivityLifecycleMonitorRegistryActivityLifecycleMonitorRegistry An exposed registry instance to make it easy for callers to find the lifecycle monitor for their application.  - - + +
    ApplicationLifecycleMonitorRegistryApplicationLifecycleMonitorRegistry An exposed registry instance to make it easy for callers to find the application lifecycle monitor for their application.  - - + +
    -
    - - + +

    Enums

    -
    - - + + - + - + - - + + - + + + +
    ApplicationStageApplicationStage An enumeration of the lifecycle stages an application undergoes that can be monitored.  - - + +
    StageStage An enumeration of the lifecycle stages an activity undergoes.  - - + +
    + + + + -
    -
    - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + +
    + + diff --git a/docs/html/reference/android/support/test/runner/package-summary.html b/docs/html/reference/android/support/test/runner/package-summary.html index 4279c011fa4e..d70aba9c00af 100644 --- a/docs/html/reference/android/support/test/runner/package-summary.html +++ b/docs/html/reference/android/support/test/runner/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,759 +92,175 @@ - - - - - - -android.support.test.runner | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.runner - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    - - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.runner

    -
    - -
    - -
    - - - +

    android.support.test.runner

    + + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + + + + + + + + + +
    AndroidJUnit4AndroidJUnit4 Aliases the current default Android JUnit 4 class runner, for future-proofing.  - - + +
    AndroidJUnitRunnerAndroidJUnitRunner - An Instrumentation that runs JUnit3 and JUnit4 tests against + An Instrumentation that runs JUnit3 and JUnit4 tests against an Android package (application).  - - + +
    MonitoringInstrumentationMonitoringInstrumentation An instrumentation that enables several advanced features and makes some hard guarantees about the state of the application under instrumentation.  - - + +
    MonitoringInstrumentation.ActivityFinisherMonitoringInstrumentation.ActivityFinisher Loops through all the activities that have not yet finished and explicitly calls finish on them.  + + - +
    UsageTrackerFacilitator + Helper class to enable/disable usage tracker in the runner.  + +
    + -
    -
    - - - - - - - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + + + + + + +
    + + + diff --git a/docs/html/reference/android/support/test/uiautomator/By.html b/docs/html/reference/android/support/test/uiautomator/By.html index 9d73c6054f89..bcb5ced500b5 100644 --- a/docs/html/reference/android/support/test/uiautomator/By.html +++ b/docs/html/reference/android/support/test/uiautomator/By.html @@ -1,4 +1,3 @@ - @@ -93,512 +92,85 @@ - - - - - - -By | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +By - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - +
    +
    + -
    -
    +

    By

    +

    + + public + + + + class + By + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.uiautomator.By +
    + - + -
    - public +

    +

    By is a utility class which enables the creation of BySelectors in a concise + manner.

    - class -

    By

    +

    Its primary function is to provide static factory methods for constructing BySelectors + using a shortened syntax. For example, you would use findObject(By.text("foo")) rather + than findObject(new BySelector().text("foo")) to select UI elements with the text value + "foo".

    +

    - extends Object
    +

    Summary

    @@ -660,29 +282,17 @@ Summary: -
    -
    -
    - - - - - - - - -
    java.lang.Object
       ↳android.support.test.uiautomator.By
    @@ -690,2303 +300,2616 @@ Summary: -
    + + + -

    Class Overview

    -

    By is a utility class which enables the creation of BySelectors in a concise - manner.

    -

    Its primary function is to provide static factory methods for constructing BySelectors - using a shortened syntax. For example, you would use findObject(By.text("foo")) rather - than findObject(new BySelector().text("foo")) to select UI elements with the text value - "foo".

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + static + + + BySelector + + + checkable(boolean isCheckable) + + +

    Constructs a new BySelector and sets the checkable criteria. + + +

    + +
    + + + static + + + BySelector + + + checked(boolean isChecked) + + +

    Constructs a new BySelector and sets the checked criteria. + + +

    + +
    + + + static + + + BySelector + + + clazz(String packageName, String className) + + +

    Constructs a new BySelector and sets the class name criteria. + + +

    + +
    + + + static + + + BySelector + + + clazz(Class clazz) + + +

    Constructs a new BySelector and sets the class name criteria. + + +

    + +
    + + + static + + + BySelector + + + clazz(Pattern className) + + +

    Constructs a new BySelector and sets the class name criteria. + + +

    + +
    + + + static + + + BySelector + + + clazz(String className) + + +

    Constructs a new BySelector and sets the class name criteria. + + +

    + +
    + + + static + + + BySelector + + + clickable(boolean isClickable) + + +

    Constructs a new BySelector and sets the clickable criteria. + + +

    + +
    + + + static + + + BySelector + + + copy(BySelector original) + + +

    Constructs a new BySelector and copies the criteria from original. + + +

    + +
    + + + static + + + BySelector + + + depth(int depth) + + +

    Constructs a new BySelector and sets the depth criteria. + + +

    + +
    + + + static + + + BySelector + + + desc(String contentDescription) + + +

    Constructs a new BySelector and sets the content description criteria. + + +

    + +
    + + + static + + + BySelector + + + desc(Pattern contentDescription) + + +

    Constructs a new BySelector and sets the content description criteria. + + +

    + +
    + + + static + + + BySelector + + + descContains(String substring) + + +

    Constructs a new BySelector and sets the content description criteria. + + +

    + +
    + + + static + + + BySelector + + + descEndsWith(String substring) + + +

    Constructs a new BySelector and sets the content description criteria. + + +

    + +
    + + + static + + + BySelector + + + descStartsWith(String substring) + + +

    Constructs a new BySelector and sets the content description criteria. + + +

    + +
    + + + static + + + BySelector + + + enabled(boolean isEnabled) + + +

    Constructs a new BySelector and sets the enabled criteria. + + +

    + +
    + + + static + + + BySelector + + + focusable(boolean isFocusable) + + +

    Constructs a new BySelector and sets the focusable criteria. + + +

    + +
    + + + static + + + BySelector + + + focused(boolean isFocused) + + +

    Constructs a new BySelector and sets the focused criteria. + + +

    + +
    + + + static + + + BySelector + + + hasChild(BySelector childSelector) + + +

    Constructs a new BySelector and adds a child selector criteria. + + +

    + +
    + + + static + + + BySelector + + + hasDescendant(BySelector descendantSelector) + + +

    Constructs a new BySelector and adds a descendant selector criteria. + + +

    + +
    + + + static + + + BySelector + + + hasDescendant(BySelector descendantSelector, int maxDepth) + + +

    Constructs a new BySelector and adds a descendant selector criteria. + + +

    + +
    + + + static + + + BySelector + + + longClickable(boolean isLongClickable) + + +

    Constructs a new BySelector and sets the long clickable criteria. + + +

    + +
    + + + static + + + BySelector + + + pkg(Pattern applicationPackage) + + +

    Constructs a new BySelector and sets the application package name criteria. + + +

    + +
    + + + static + + + BySelector + + + pkg(String applicationPackage) + + +

    Constructs a new BySelector and sets the application package name criteria. + + +

    + +
    + + + static + + + BySelector + + + res(String resourceName) + + +

    Constructs a new BySelector and sets the resource name criteria. + + +

    + +
    + + + static + + + BySelector + + + res(String resourcePackage, String resourceId) + + +

    Constructs a new BySelector and sets the resource name criteria. + + +

    + +
    + + + static + + + BySelector + + + res(Pattern resourceName) + + +

    Constructs a new BySelector and sets the resource id criteria. + + +

    + +
    + + + static + + + BySelector + + + scrollable(boolean isScrollable) + + +

    Constructs a new BySelector and sets the scrollable criteria. + + +

    + +
    + + + static + + + BySelector + + + selected(boolean isSelected) + + +

    Constructs a new BySelector and sets the selected criteria. + + +

    + +
    + + + static + + + BySelector + + + text(Pattern regex) + + +

    Constructs a new BySelector and sets the text value criteria. + + +

    + +
    + + + static + + + BySelector + + + text(String text) + + +

    Constructs a new BySelector and sets the text value criteria. + + +

    + +
    + + + static + + + BySelector + + + textContains(String substring) + + +

    Constructs a new BySelector and sets the text value criteria. + + +

    + +
    + + + static + + + BySelector + + + textEndsWith(String substring) + + +

    Constructs a new BySelector and sets the text value criteria. + + +

    + +
    + + + static + + + BySelector + + + textStartsWith(String substring) + + +

    Constructs a new BySelector and sets the text value criteria. + +

    + +
    -
    + + + + + +

    Inherited methods

    + From +class + + + java.lang.Object + + +
    + + +
    +
    + + -
    + -

    Summary

    + + + + + + +

    Public methods

    + +
    +

    checkable

    +
    +
    + + +
    +
    +BySelector checkable (boolean isCheckable)
    + + + + +

    Constructs a new BySelector and sets the checkable criteria.

    + + + + + + +
    Parameters
    isCheckable + boolean +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    +
    + +
    +

    checked

    +
    +
    + + +
    +
    +BySelector checked (boolean isChecked)
    + + + + +

    Constructs a new BySelector and sets the checked criteria.

    + + + + + + +
    Parameters
    isChecked + boolean +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    +
    + +
    +

    clazz

    +
    +
    + + +
    +
    +BySelector clazz (String packageName, 
    +                String className)
    + + + + +

    Constructs a new BySelector and sets the class name criteria.

    + + + + + + + + + + +
    Parameters
    packageName + String +
    className + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    +
    - - + +
    +

    clazz

    +
    +
    + + +
    +
    +BySelector clazz (Class clazz)
    + + + + +

    Constructs a new BySelector and sets the class name criteria.

    +
    Public Methods
    + + + + + +
    Parameters
    clazz + Class +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    +
    -
    + +
    +

    clazz

    +
    +
    + + - static +
    +
    +BySelector clazz (Pattern className)
    + + + + +

    Constructs a new BySelector and sets the class name criteria.

    + + + + + + +
    Parameters
    className + Pattern +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    - BySelector
    -
    - checkable(boolean isCheckable) + -
    - Constructs a new BySelector and sets the checkable criteria. + +
    +

    clazz

    +
    +
    + + -
    +
    +
    +BySelector clazz (String className)
    + + + + +

    Constructs a new BySelector and sets the class name criteria.

    + + + + + + +
    Parameters
    className + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    -
    +
    +

    clickable

    +
    +
    + + +
    +
    +BySelector clickable (boolean isClickable)
    + + + + +

    Constructs a new BySelector and sets the clickable criteria.

    + + + + + + +
    Parameters
    isClickable + boolean +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    +
    - static - BySelector
    -
    - checked(boolean isChecked) + -
    - Constructs a new BySelector and sets the checked criteria. +
    +

    copy

    +
    +
    + + +
    +
    +BySelector copy (BySelector original)
    + + + +

    Constructs a new BySelector and copies the criteria from original. +

    + + + + + + +
    Parameters
    original + BySelector +
    + + + + + + +
    Returns
    BySelector
    -
    +
    -
    + +
    +BySelector depth (int depth)
    + + + +

    Constructs a new BySelector and sets the depth criteria. +

    + + + + + + +
    Parameters
    depth + int +
    + + + + + + +
    Returns
    BySelector
    + - static - BySelector
    -
    - clazz(Pattern className) + -
    - Constructs a new BySelector and sets the class name criteria. +
    +

    desc

    +
    +
    + + +
    +
    +BySelector desc (String contentDescription)
    + + + + +

    Constructs a new BySelector and sets the content description criteria.

    + + + + + + +
    Parameters
    contentDescription + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    +
    -
    -
    + + + + + +
    Parameters
    contentDescription + Pattern +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    -
    + + - static +
    +

    descContains

    +
    +
    + + - BySelector
    -
    - clazz(String className) + +
    +BySelector descContains (String substring)
    + + + + +

    Constructs a new BySelector and sets the content description criteria.

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    -
    - Constructs a new BySelector and sets the class name criteria. +
    + - +
    +

    descEndsWith

    +
    +
    + + -
    + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    +
    -
    + +
    +

    descStartsWith

    +
    +
    + + +
    +
    +BySelector descStartsWith (String substring)
    + + + + +

    Constructs a new BySelector and sets the content description criteria.

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    - static +
    - BySelector
    -
    - clazz(Class clazz) -
    - Constructs a new BySelector and sets the class name criteria. + +
    +

    enabled

    +
    +
    + + +
    +
    +BySelector enabled (boolean isEnabled)
    + + + + +

    Constructs a new BySelector and sets the enabled criteria.

    + + + + + + +
    Parameters
    isEnabled + boolean +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    -
    +
    -
    + +
    +BySelector focusable (boolean isFocusable)
    + + + + +

    Constructs a new BySelector and sets the focusable criteria.

    + + + + + + +
    Parameters
    isFocusable + boolean +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    + - static + - BySelector
    -
    - clazz(String packageName, String className) +
    +

    focused

    +
    +
    + + -
    - Constructs a new BySelector and sets the class name criteria. +
    +
    +BySelector focused (boolean isFocused)
    + + + + +

    Constructs a new BySelector and sets the focused criteria.

    + + + + + + +
    Parameters
    isFocused + boolean +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    + +
    +
    -
    - -
    - - - - static - - BySelector - - clickable(boolean isClickable) - -
    - Constructs a new BySelector and sets the clickable criteria. - - - -
    - -
    - - - - static - - BySelector - - copy(BySelector original) - -
    - Constructs a new BySelector and copies the criteria from original. - - - -
    - -
    - - - - static - - BySelector - - depth(int depth) - -
    - Constructs a new BySelector and sets the depth criteria. - - - -
    - -
    - - - - static - - BySelector - - desc(Pattern contentDescription) - -
    - Constructs a new BySelector and sets the content description criteria. - - - -
    - -
    - - - - static - - BySelector - - desc(String contentDescription) - -
    - Constructs a new BySelector and sets the content description criteria. - - - -
    - -
    - - - - static - - BySelector - - descContains(String substring) - -
    - Constructs a new BySelector and sets the content description criteria. - - - -
    - -
    - - - - static - - BySelector - - descEndsWith(String substring) - -
    - Constructs a new BySelector and sets the content description criteria. - - - -
    - -
    - - - - static - - BySelector - - descStartsWith(String substring) - -
    - Constructs a new BySelector and sets the content description criteria. - - - -
    - -
    - - - - static - - BySelector - - enabled(boolean isEnabled) - -
    - Constructs a new BySelector and sets the enabled criteria. - - - -
    - -
    - - - - static - - BySelector - - focusable(boolean isFocusable) - -
    - Constructs a new BySelector and sets the focusable criteria. - - - -
    - -
    - - - - static - - BySelector - - focused(boolean isFocused) - -
    - Constructs a new BySelector and sets the focused criteria. - - - -
    - -
    - - - - static - - BySelector - - hasChild(BySelector childSelector) - -
    - Constructs a new BySelector and adds a child selector criteria. - - - -
    - -
    - - - - static - - BySelector - - hasDescendant(BySelector descendantSelector, int maxDepth) - -
    - Constructs a new BySelector and adds a descendant selector criteria. - - - -
    - -
    - - - - static - - BySelector - - hasDescendant(BySelector descendantSelector) - -
    - Constructs a new BySelector and adds a descendant selector criteria. - - - -
    - -
    - - - - static - - BySelector - - longClickable(boolean isLongClickable) - -
    - Constructs a new BySelector and sets the long clickable criteria. - - - -
    - -
    - - - - static - - BySelector - - pkg(String applicationPackage) - -
    - Constructs a new BySelector and sets the application package name criteria. - - - -
    - -
    - - - - static - - BySelector - - pkg(Pattern applicationPackage) - -
    - Constructs a new BySelector and sets the application package name criteria. - - - -
    - -
    - - - - static - - BySelector - - res(String resourceName) - -
    - Constructs a new BySelector and sets the resource name criteria. - - - -
    - -
    - - - - static - - BySelector - - res(Pattern resourceName) - -
    - Constructs a new BySelector and sets the resource id criteria. - - - -
    - -
    - - - - static - - BySelector - - res(String resourcePackage, String resourceId) - -
    - Constructs a new BySelector and sets the resource name criteria. - - - -
    - -
    - - - - static - - BySelector - - scrollable(boolean isScrollable) - -
    - Constructs a new BySelector and sets the scrollable criteria. - - - -
    - -
    - - - - static - - BySelector - - selected(boolean isSelected) - -
    - Constructs a new BySelector and sets the selected criteria. - - - -
    - -
    - - - - static - - BySelector - - text(Pattern regex) - -
    - Constructs a new BySelector and sets the text value criteria. - - - -
    - -
    - - - - static - - BySelector - - text(String text) - -
    - Constructs a new BySelector and sets the text value criteria. - - - -
    - -
    - - - - static - - BySelector - - textContains(String substring) - -
    - Constructs a new BySelector and sets the text value criteria. - - - -
    - -
    - - - - static - - BySelector - - textEndsWith(String substring) - -
    - Constructs a new BySelector and sets the text value criteria. - - - -
    - -
    - - - - static - - BySelector - - textStartsWith(String substring) - -
    - Constructs a new BySelector and sets the text value criteria. - - - -
    - -
    - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - static - - - - BySelector - - checkable - (boolean isCheckable) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the checkable criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - checked - (boolean isChecked) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the checked criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - clazz - (Pattern className) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the class name criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - clazz - (String className) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the class name criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - clazz - (Class clazz) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the class name criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - clazz - (String packageName, String className) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the class name criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - clickable - (boolean isClickable) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the clickable criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - copy - (BySelector original) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and copies the criteria from original. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - depth - (int depth) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the depth criteria. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - desc - (Pattern contentDescription) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the content description criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - desc - (String contentDescription) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the content description criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - descContains - (String substring) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the content description criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - descEndsWith - (String substring) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the content description criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - descStartsWith - (String substring) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the content description criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - enabled - (boolean isEnabled) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the enabled criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - focusable - (boolean isFocusable) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the focusable criteria.

    -
    -
    See Also
    - -
    - -
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - focused - (boolean isFocused) -

    -
    -
    - - - -
    -
    - - + +
    +

    hasChild

    +
    +
    + + -

    Constructs a new BySelector and sets the focused criteria.

    -
    -
    See Also
    -
    +
    +BySelector hasChild (BySelector childSelector)
    + + + + +

    Constructs a new BySelector and adds a child selector criteria.

    + + + + + + +
    Parameters
    childSelector + BySelector +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    - - -
    -

    - - public - static - - - - BySelector - - hasChild - (BySelector childSelector) -

    -
    -
    - - - -
    -
    - - + +
    +

    hasDescendant

    +
    +
    + + -

    Constructs a new BySelector and adds a child selector criteria.

    -
    -
    See Also
    -
    +
    +BySelector hasDescendant (BySelector descendantSelector)
    + + + + +

    Constructs a new BySelector and adds a descendant selector criteria.

    + + + + + + +
    Parameters
    descendantSelector + BySelector +
    + + + + + + +
    Returns
    BySelector
    + -
    -
    -

    - - public - static - - - - BySelector - - hasDescendant - (BySelector descendantSelector, int maxDepth) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and adds a descendant selector criteria.

    - +
    +

    hasDescendant

    +
    +
    + +
    -
    - - - - -
    -

    - - public - static - - - - BySelector - - hasDescendant - (BySelector descendantSelector) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and adds a descendant selector criteria.

    -
    -
    See Also
    -
    -
    -

    - - public - static - - - - BySelector - - longClickable - (boolean isLongClickable) -

    -
    -
    - - - -
    -
    - +
    +

    longClickable

    +
    +
    + + - - -

    Constructs a new BySelector and sets the long clickable criteria.

    -
    -
    See Also
    -
    +
    +BySelector longClickable (boolean isLongClickable)
    + + + + +

    Constructs a new BySelector and sets the long clickable criteria.

    + + + + + + +
    Parameters
    isLongClickable + boolean +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    - - -
    -

    - - public - static - - - - BySelector - - pkg - (String applicationPackage) -

    -
    -
    - - - -
    -
    - - + +
    +

    pkg

    +
    +
    + + -

    Constructs a new BySelector and sets the application package name criteria.

    -
    -
    See Also
    -
    +
    +BySelector pkg (Pattern applicationPackage)
    + + + + +

    Constructs a new BySelector and sets the application package name criteria.

    + + + + + + +
    Parameters
    applicationPackage + Pattern +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    - - -
    -

    - - public - static - - - - BySelector - - pkg - (Pattern applicationPackage) -

    -
    -
    - - - -
    -
    - - + +
    +

    pkg

    +
    +
    + + -

    Constructs a new BySelector and sets the application package name criteria.

    -
    -
    See Also
    -
    +
    +BySelector pkg (String applicationPackage)
    + + + + +

    Constructs a new BySelector and sets the application package name criteria.

    + + + + + + +
    Parameters
    applicationPackage + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    -
    -

    - - public - static - - - - BySelector - - res - (String resourceName) -

    -
    -
    - +
    +

    res

    +
    +
    + + - -
    -
    - - - - -

    Constructs a new BySelector and sets the resource name criteria.

    -
    -
    See Also
    -
    +
    +BySelector res (String resourceName)
    + + + + +

    Constructs a new BySelector and sets the resource name criteria.

    + + + + + + +
    Parameters
    resourceName + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    - - -
    -

    - - public - static - - - - BySelector - - res - (Pattern resourceName) -

    -
    -
    - - - -
    -
    - - + +
    +

    res

    +
    +
    + + -

    Constructs a new BySelector and sets the resource id criteria.

    -
    -
    See Also
    -
    +
    +BySelector res (String resourcePackage, 
    +                String resourceId)
    + + + + +

    Constructs a new BySelector and sets the resource name criteria.

    + + + + + + + + + + +
    Parameters
    resourcePackage + String +
    resourceId + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    - - -
    -

    - - public - static - - - - BySelector - - res - (String resourcePackage, String resourceId) -

    -
    -
    - - - -
    -
    - - + +
    +

    res

    +
    +
    + + -

    Constructs a new BySelector and sets the resource name criteria.

    -
    -
    See Also
    -
    +
    +BySelector res (Pattern resourceName)
    + + + + +

    Constructs a new BySelector and sets the resource id criteria.

    + + + + + + +
    Parameters
    resourceName + Pattern +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    -
    -

    - - public - static - +
    +

    scrollable

    +
    +
    + + - - BySelector - - scrollable - (boolean isScrollable) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the scrollable criteria.

    -
    -
    See Also
    -
    +
    +BySelector scrollable (boolean isScrollable)
    + + + + +

    Constructs a new BySelector and sets the scrollable criteria.

    + + + + + + +
    Parameters
    isScrollable + boolean +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    -
    -

    - - public - static - - - - BySelector - - selected - (boolean isSelected) -

    -
    -
    - +
    +

    selected

    +
    +
    + + - -
    -
    - - - - -

    Constructs a new BySelector and sets the selected criteria.

    -
    -
    See Also
    -
    +
    +BySelector selected (boolean isSelected)
    + + + + +

    Constructs a new BySelector and sets the selected criteria.

    + + + + + + +
    Parameters
    isSelected + boolean +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    -
    -

    - - public - static - - - - BySelector - - text - (Pattern regex) -

    -
    -
    - - - -
    -
    - +
    +

    text

    +
    +
    + + - - -

    Constructs a new BySelector and sets the text value criteria.

    -
    -
    See Also
    -
    +
    +BySelector text (Pattern regex)
    + + + + +

    Constructs a new BySelector and sets the text value criteria.

    + + + + + + +
    Parameters
    regex + Pattern +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    -
    -

    - - public - static - - +
    +

    text

    +
    +
    + + - BySelector - - text - (String text) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs a new BySelector and sets the text value criteria.

    -
    -
    See Also
    -
    +
    +BySelector text (String text)
    + + + + +

    Constructs a new BySelector and sets the text value criteria.

    + + + + + + +
    Parameters
    text + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    -
    -

    - - public - static - - - - BySelector - - textContains - (String substring) -

    -
    -
    - - +
    +

    textContains

    +
    +
    + + -
    -
    - - - - -

    Constructs a new BySelector and sets the text value criteria.

    -
    -
    See Also
    -
    +
    +BySelector textContains (String substring)
    + + + + +

    Constructs a new BySelector and sets the text value criteria.

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    -
    -

    - - public - static - - - - BySelector - - textEndsWith - (String substring) -

    -
    -
    - - - -
    -
    - - +
    +

    textEndsWith

    +
    +
    + + - -

    Constructs a new BySelector and sets the text value criteria.

    -
    -
    See Also
    -
    +
    +BySelector textEndsWith (String substring)
    + + + + +

    Constructs a new BySelector and sets the text value criteria.

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    -
    -

    - - public - static - - - - BySelector - - textStartsWith - (String substring) -

    -
    -
    +
    +

    textStartsWith

    +
    +
    + + - - -
    -
    - - - - -

    Constructs a new BySelector and sets the text value criteria.

    -
    -
    See Also
    -
    +
    +BySelector textStartsWith (String substring)
    + + + + +

    Constructs a new BySelector and sets the text value criteria.

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    BySelector
    +
    +

    See also:

    +
    -
    @@ -2998,193 +2921,59 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/uiautomator/BySelector.html b/docs/html/reference/android/support/test/uiautomator/BySelector.html index 2f07225da263..ecab240560bb 100644 --- a/docs/html/reference/android/support/test/uiautomator/BySelector.html +++ b/docs/html/reference/android/support/test/uiautomator/BySelector.html @@ -1,4 +1,3 @@ - @@ -93,512 +92,85 @@ - - - - - - -BySelector | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +BySelector - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public +

    BySelector

    +

    + + public + + + + class + BySelector + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.uiautomator.BySelector +
    + + - class -

    BySelector

    +

    +

    A BySelector specifies criteria for matching UI elements during a call to + findObject(BySelector). +

    - extends Object
    +

    Summary

    @@ -660,29 +275,17 @@ Summary: -
    -
    -
    - - - - - - - - -
    java.lang.Object
       ↳android.support.test.uiautomator.BySelector
    @@ -690,3006 +293,2802 @@ Summary: -
    -

    Class Overview

    -

    A BySelector specifies criteria for matching UI elements during a call to - findObject(BySelector). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + BySelector + + + checkable(boolean isCheckable) + + +

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

    + +
    + + + + + + BySelector + + + checked(boolean isChecked) + + +

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

    + +
    + + + + + + BySelector + + + clazz(String packageName, String className) + + +

    Sets the class name criteria for matching. + + +

    + +
    + + + + + + BySelector + + + clazz(Class clazz) + + +

    Sets the class name criteria for matching. + + +

    + +
    + + + + + + BySelector + + + clazz(Pattern className) + + +

    Sets the class name criteria for matching. + +

    + +
    + + + + + + BySelector + + + clazz(String className) + + +

    Sets the class name criteria for matching. + + +

    + +
    + + + + + + BySelector + + + clickable(boolean isClickable) + + +

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

    + +
    + + + + + + BySelector + + + depth(int min, int max) + + +

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

    + +
    + + + + + + BySelector + + + depth(int exactDepth) + + +

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

    + +
    + + + + + + BySelector + + + desc(String contentDescription) + + +

    Sets the content description criteria for matching. + + +

    + +
    + + + + + + BySelector + + + desc(Pattern contentDescription) + + +

    Sets the content description criteria for matching. + + +

    + +
    + + + + + + BySelector + + + descContains(String substring) + + +

    Sets the content description criteria for matching. + + +

    + +
    + + + + + + BySelector + + + descEndsWith(String substring) + + +

    Sets the content description criteria for matching. + + +

    + +
    + + + + + + BySelector + + + descStartsWith(String substring) + + +

    Sets the content description criteria for matching. + + +

    + +
    + + + + + + BySelector + + + enabled(boolean isEnabled) + + +

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

    + +
    + + + + + + BySelector + + + focusable(boolean isFocusable) + + +

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

    + +
    + + + + + + BySelector + + + focused(boolean isFocused) + + +

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

    + +
    + + + + + + BySelector + + + hasChild(BySelector childSelector) + + +

    Adds a child selector criteria for matching. + + +

    + +
    + + + + + + BySelector + + + hasDescendant(BySelector descendantSelector) + + +

    Adds a descendant selector criteria for matching. + + +

    + +
    + + + + + + BySelector + + + hasDescendant(BySelector descendantSelector, int maxDepth) + + +

    Adds a descendant selector criteria for matching. + + +

    + +
    + + + + + + BySelector + + + longClickable(boolean isLongClickable) + + +

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

    + +
    + + + + + + BySelector + + + maxDepth(int max) + + +

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

    + +
    + + + + + + BySelector + + + minDepth(int min) + + +

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

    + +
    + + + + + + BySelector + + + pkg(Pattern applicationPackage) + + +

    Sets the package name criteria for matching. + + +

    + +
    + + + + + + BySelector + + + pkg(String applicationPackage) + + +

    Sets the application package name criteria for matching. + + +

    + +
    + + + + + + BySelector + + + res(String resourceName) + + +

    Sets the resource name criteria for matching. + + +

    + +
    + + + + + + BySelector + + + res(String resourcePackage, String resourceId) + + +

    Sets the resource name criteria for matching. + + +

    + +
    + + + + + + BySelector + + + res(Pattern resourceName) + + +

    Sets the resource name criteria for matching. + + +

    + +
    + + + + + + BySelector + + + scrollable(boolean isScrollable) + + +

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

    + +
    + + + + + + BySelector + + + selected(boolean isSelected) + + +

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

    + +
    + + + + + + BySelector + + + text(Pattern textValue) + + +

    Sets the text value criteria for matching. + + +

    + +
    + + + + + + BySelector + + + text(String textValue) + + +

    Sets the text value criteria for matching. + + +

    + +
    + + + + + + BySelector + + + textContains(String substring) + + +

    Sets the text value criteria for matching. + + +

    + +
    + + + + + + BySelector + + + textEndsWith(String substring) + + +

    Sets the text value criteria for matching. + + +

    + +
    + + + + + + BySelector + + + textStartsWith(String substring) + + +

    Sets the text value criteria for matching. + + +

    + +
    + + + + + + String + + + toString() + + +

    Returns a String representation of this BySelector. + + +

    + +
    -

    + + + + + +

    Inherited methods

    + From +class + + + java.lang.Object + + +
    + + +
    +
    + + -
    + -

    Summary

    + + + + + + +

    Public methods

    + +
    +

    checkable

    +
    +
    + + +
    +
    +BySelector checkable (boolean isCheckable)
    + + + + +

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

    + + + + + + +
    Parameters
    isCheckable + boolean: + Whether to match elements that are checkable or elements that are not + checkable.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    + +
    +

    checked

    +
    +
    + + +
    +
    +BySelector checked (boolean isChecked)
    + + + + +

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

    + + + + + + +
    Parameters
    isChecked + boolean: + Whether to match elements that are checked or elements that are unchecked.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    + +
    +

    clazz

    +
    +
    + + +
    +
    +BySelector clazz (String packageName, 
    +                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.

    + + + + + + + + + + +
    Parameters
    packageName + String: + The package value to match.
    className + String: + The class name value to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    - - + +
    +

    clazz

    +
    +
    + + +
    +
    +BySelector clazz (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 Methods
    + + + + + +
    Parameters
    clazz + Class: + The class to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector +
    +
    - - + +
    +

    clazz

    +
    +
    + + +
    +
    +BySelector clazz (Pattern className)
    + + + + +

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

    + + + + + + +
    Parameters
    className + Pattern: + The Pattern to be used for matching.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    - BySelector
    - - - checkable(boolean isCheckable) -
    - Sets the search criteria to match elements that are checkable or not checkable. + +
    +

    clazz

    +
    +
    + + +
    +
    +BySelector clazz (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.

    + + + + + + +
    Parameters
    className + String: + The full class name value to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    - +
    + - - +
    +

    clickable

    +
    +
    + + +
    +
    +BySelector clickable (boolean isClickable)
    + + + + +

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

    + + + + + + +
    Parameters
    isClickable + boolean: + Whether to match elements that are clickable or elements that are not + clickable.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    + - BySelector
    - - - checked(boolean isChecked) +
    +

    depth

    +
    +
    + + -
    - Sets the search criteria to match elements that are checked or unchecked. +
    +
    +BySelector depth (int min, 
    +                int max)
    + + + + +

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

    + + + + + + + + + + +
    Parameters
    min + int +
    max + int +
    + + + + + + +
    Returns
    BySelector
    +
    -
    + - +
    +

    depth

    +
    +
    + + +
    +
    +BySelector depth (int exactDepth)
    + + + + +

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

    + + + + + + +
    Parameters
    exactDepth + int +
    + + + + + + +
    Returns
    BySelector
    +
    - - + +
    +

    desc

    +
    +
    + + +
    +
    +BySelector desc (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.

    + + + + + + +
    Parameters
    contentDescription + String: + The exact value to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    - BySelector
    - - - clazz(Pattern className) +
    -
    - Sets the class name criteria for matching. + +
    +

    desc

    +
    +
    + + -
    +
    +
    +BySelector desc (Pattern contentDescription)
    + + + + +

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

    + + + + + + +
    Parameters
    contentDescription + Pattern: + The Pattern to be used for matching.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    - +
    + - - +
    +

    descContains

    +
    +
    + + +
    +
    +BySelector descContains (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.

    + + + + + + +
    Parameters
    substring + String: + The substring to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    - BySelector
    - - - clazz(String className) + -
    - Sets the class name criteria for matching. +
    +

    descEndsWith

    +
    +
    + + +
    +
    +BySelector descEndsWith (String substring)
    + + + +

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

    + + + + + + +
    Parameters
    substring + String: + The substring to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    -
    +
    - + +
    +

    descStartsWith

    +
    +
    + + - - +
    +
    +BySelector descStartsWith (String substring)
    + + + +

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

    + + + + + + +
    Parameters
    substring + String: + The substring to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    + - BySelector - - - clazz(Class clazz) +
    +

    enabled

    +
    +
    + + -
    - Sets the class name criteria for matching. +
    +
    +BySelector enabled (boolean isEnabled)
    + + + + +

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

    + + + + + + +
    Parameters
    isEnabled + boolean: + Whether to match elements that are enabled or elements that are disabled.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    -
    + - +
    +

    focusable

    +
    +
    + + +
    +
    +BySelector focusable (boolean isFocusable)
    + + + + +

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

    + + + + + + +
    Parameters
    isFocusable + boolean: + Whether to match elements that are focusable or elements that are not + focusable.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    - - + +
    +

    focused

    +
    +
    + + +
    +
    +BySelector focused (boolean isFocused)
    + + + + +

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

    + + + + + + +
    Parameters
    isFocused + boolean: + Whether to match elements that are focused or elements that are unfocused.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    - BySelector
    - - - clazz(String packageName, String className) -
    - Sets the class name criteria for matching. + +
    +

    hasChild

    +
    +
    + + +
    +
    +BySelector hasChild (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.

    + + + + + + +
    Parameters
    childSelector + BySelector: + The selector used to find a matching child element.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    - +
    + - - +
    +

    hasDescendant

    +
    +
    + + +
    +
    +BySelector hasDescendant (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.

    + + + + + + +
    Parameters
    descendantSelector + BySelector: + The selector used to find a matching descendant element.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    - BySelector
    - - - clickable(boolean isClickable) + -
    - Sets the search criteria to match elements that are clickable or not clickable. +
    +

    hasDescendant

    +
    +
    + + +
    +
    +BySelector hasDescendant (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.

    + + + + + + + + + + +
    Parameters
    descendantSelector + BySelector: + The selector used to find a matching descendant element.
    maxDepth + int: + The maximum depth under the element to search the descendant.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    -
    - + +
    +

    longClickable

    +
    +
    + + +
    +
    +BySelector longClickable (boolean isLongClickable)
    + + + + +

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

    + + + + + + +
    Parameters
    isLongClickable + boolean: + Whether to match elements that are long clickable or elements that are + not long clickable.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    - - +
    + +
    +

    maxDepth

    +
    +
    + + +
    +
    +BySelector maxDepth (int max)
    + + + + +

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

    + + + + + + +
    Parameters
    max + int +
    + + + + + + +
    Returns
    BySelector
    - BySelector
    - - - depth(int exactDepth) +
    -
    - Sets the search criteria to match elements that are at a certain depth. + +
    +

    minDepth

    +
    +
    + + -
    +
    +
    +BySelector minDepth (int min)
    + + + + +

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

    + + + + + + +
    Parameters
    min + int +
    + + + + + + +
    Returns
    BySelector
    - +
    + - - +
    +

    pkg

    +
    +
    + + +
    +
    +BySelector pkg (Pattern applicationPackage)
    + + + + +

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

    + + + + + + +
    Parameters
    applicationPackage + Pattern: + The Pattern to be used for matching.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    + - BySelector
    - - - depth(int min, int max) +
    +

    pkg

    +
    +
    + + -
    - Sets the search criteria to match elements that are in a range of depths. +
    +
    +BySelector pkg (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.

    + + + + + + +
    Parameters
    applicationPackage + String: + The exact value to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    -
    - + +
    +

    res

    +
    +
    + + +
    +
    +BySelector res (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.

    + + + + + + +
    Parameters
    resourceName + String: + The exact value to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    + +
    +

    res

    +
    +
    + + - BySelector
    - - - desc(Pattern contentDescription) +
    +
    +BySelector res (String resourcePackage, 
    +                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.

    + + + + + + + + + + +
    Parameters
    resourcePackage + String: + The resource package value to match.
    resourceId + String: + The resouce-id value to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    -
    - Sets the content description criteria for matching. +
    + -
    +
    +

    res

    +
    +
    + + - +
    +
    +BySelector res (Pattern resourceName)
    + + + + +

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

    + + + + + + +
    Parameters
    resourceName + Pattern: + The Pattern to be used for matching.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    - - + +
    +

    scrollable

    +
    +
    + + +
    +
    +BySelector scrollable (boolean isScrollable)
    + + + + +

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

    + + + + + + +
    Parameters
    isScrollable + boolean: + Whether to match elements that are scrollable or elements that are not + scrollable.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    - BySelector
    - - - desc(String contentDescription) + -
    - Sets the content description criteria for matching. +
    +

    selected

    +
    +
    + + +
    +
    +BySelector selected (boolean isSelected)
    + + + + +

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

    + + + + + + +
    Parameters
    isSelected + boolean: + Whether to match elements that are selected or elements that are not + selected.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    -
    - + +
    +

    text

    +
    +
    + + +
    +
    +BySelector text (Pattern textValue)
    + + + + +

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

    + + + + + + +
    Parameters
    textValue + Pattern: + The Pattern to be used for matching.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    - - +
    + +
    +

    text

    +
    +
    + + +
    +
    +BySelector text (String textValue)
    + + - BySelector
    - - - descContains(String substring) + +

    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.

    + + + + + + +
    Parameters
    textValue + String: + The exact value to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    -
    - Sets the content description criteria for matching. +
    + -
    +
    +

    textContains

    +
    +
    + + - +
    +
    +BySelector textContains (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.

    + + + + + + +
    Parameters
    substring + String: + The substring to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    - - + +
    +

    textEndsWith

    +
    +
    + + +
    +
    +BySelector textEndsWith (String substring)
    + + + +

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

    + + + + + + +
    Parameters
    substring + String: + The substring to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    - BySelector
    - - - descEndsWith(String substring) +
    -
    - Sets the content description criteria for matching. + +
    +

    textStartsWith

    +
    +
    + + -
    +
    +
    +BySelector textStartsWith (String substring)
    + + - + +

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

    + + + + + + +
    Parameters
    substring + String: + The substring to match.
    + + + + + + +
    Returns
    BySelectorA reference to this BySelector. +
    +
    - - + +
    +

    toString

    +
    +
    + + +
    +
    +String toString ()
    + + + +

    Returns a String representation of this BySelector. The format is + "BySelector [<KEY>='<VALUE> ... ]". 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). +

    + + + + + + +
    Returns
    String
    +
    - BySelector
    - - - descStartsWith(String substring) -
    - Sets the content description criteria for matching. -
    - - - - - - - - - - - - - BySelector - - - enabled(boolean isEnabled) - -
    - Sets the search criteria to match elements that are enabled or disabled. - - - -
    - - - - - - - - - - - - - BySelector - - - focusable(boolean isFocusable) - -
    - Sets the search criteria to match elements that are focusable or not focusable. - - - -
    - - - - - - - - - - - - - BySelector - - - focused(boolean isFocused) - -
    - Sets the search criteria to match elements that are focused or unfocused. - - - -
    - - - - - - - - - - - - - BySelector - - - hasChild(BySelector childSelector) - -
    - Adds a child selector criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - hasDescendant(BySelector descendantSelector, int maxDepth) - -
    - Adds a descendant selector criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - hasDescendant(BySelector descendantSelector) - -
    - Adds a descendant selector criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - longClickable(boolean isLongClickable) - -
    - Sets the search criteria to match elements that are long clickable or not long clickable. - - - -
    - - - - - - - - - - - - - BySelector - - - maxDepth(int max) - -
    - Sets the search criteria to match elements that are no more than a certain depth. - - - -
    - - - - - - - - - - - - - BySelector - - - minDepth(int min) - -
    - Sets the search criteria to match elements that are at least a certain depth. - - - -
    - - - - - - - - - - - - - BySelector - - - pkg(String applicationPackage) - -
    - Sets the application package name criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - pkg(Pattern applicationPackage) - -
    - Sets the package name criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - res(String resourceName) - -
    - Sets the resource name criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - res(Pattern resourceName) - -
    - Sets the resource name criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - res(String resourcePackage, String resourceId) - -
    - Sets the resource name criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - scrollable(boolean isScrollable) - -
    - Sets the search criteria to match elements that are scrollable or not scrollable. - - - -
    - - - - - - - - - - - - - BySelector - - - selected(boolean isSelected) - -
    - Sets the search criteria to match elements that are selected or not selected. - - - -
    - - - - - - - - - - - - - BySelector - - - text(Pattern textValue) - -
    - Sets the text value criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - text(String textValue) - -
    - Sets the text value criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - textContains(String substring) - -
    - Sets the text value criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - textEndsWith(String substring) - -
    - Sets the text value criteria for matching. - - - -
    - - - - - - - - - - - - - BySelector - - - textStartsWith(String substring) - -
    - Sets the text value criteria for matching. - - - -
    - - - - - - - - - - - - - String - - - toString() - -
    - Returns a String representation of this BySelector. - - - -
    - - - - - - - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - - - - - BySelector - - checkable - (boolean isCheckable) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    isCheckable - Whether to match elements that are checkable or elements that are not - checkable.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - checked - (boolean isChecked) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    isChecked - Whether to match elements that are checked or elements that are unchecked.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - clazz - (Pattern className) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    className - The Pattern to be used for matching.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - clazz - (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.

    -
    -
    Parameters
    - - - - -
    className - The full class name value to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - clazz - (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.

    -
    -
    Parameters
    - - - - -
    clazz - The class to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - clazz - (String packageName, 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.

    -
    -
    Parameters
    - - - - - - - -
    packageName - The package value to match.
    className - The class name value to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - clickable - (boolean isClickable) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    isClickable - Whether to match elements that are clickable or elements that are not - clickable.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - depth - (int exactDepth) -

    -
    -
    - - - -
    -
    - - - - -

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

    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - depth - (int min, int max) -

    -
    -
    - - - -
    -
    - - - - -

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

    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - desc - (Pattern contentDescription) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    contentDescription - The Pattern to be used for matching.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - desc - (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.

    -
    -
    Parameters
    - - - - -
    contentDescription - The exact value to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - descContains - (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.

    -
    -
    Parameters
    - - - - -
    substring - The substring to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - descEndsWith - (String substring) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    substring - The substring to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - descStartsWith - (String substring) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    substring - The substring to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - enabled - (boolean isEnabled) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    isEnabled - Whether to match elements that are enabled or elements that are disabled.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - focusable - (boolean isFocusable) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    isFocusable - Whether to match elements that are focusable or elements that are not - focusable.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - focused - (boolean isFocused) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    isFocused - Whether to match elements that are focused or elements that are unfocused.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - hasChild - (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.

    -
    -
    Parameters
    - - - - -
    childSelector - The selector used to find a matching child element.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - hasDescendant - (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.

    -
    -
    Parameters
    - - - - - - - -
    descendantSelector - The selector used to find a matching descendant element.
    maxDepth - The maximum depth under the element to search the descendant.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - hasDescendant - (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.

    -
    -
    Parameters
    - - - - -
    descendantSelector - The selector used to find a matching descendant element.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - longClickable - (boolean isLongClickable) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    isLongClickable - Whether to match elements that are long clickable or elements that are - not long clickable.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - maxDepth - (int max) -

    -
    -
    - - - -
    -
    - - - - -

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

    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - minDepth - (int min) -

    -
    -
    - - - -
    -
    - - - - -

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

    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - pkg - (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.

    -
    -
    Parameters
    - - - - -
    applicationPackage - The exact value to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - pkg - (Pattern applicationPackage) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    applicationPackage - The Pattern to be used for matching.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - res - (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.

    -
    -
    Parameters
    - - - - -
    resourceName - The exact value to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - res - (Pattern resourceName) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    resourceName - The Pattern to be used for matching.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - res - (String resourcePackage, 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.

    -
    -
    Parameters
    - - - - - - - -
    resourcePackage - The resource package value to match.
    resourceId - The resouce-id value to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - scrollable - (boolean isScrollable) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    isScrollable - Whether to match elements that are scrollable or elements that are not - scrollable.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - selected - (boolean isSelected) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    isSelected - Whether to match elements that are selected or elements that are not - selected.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - text - (Pattern textValue) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    textValue - The Pattern to be used for matching.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - text - (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.

    -
    -
    Parameters
    - - - - -
    textValue - The exact value to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - textContains - (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.

    -
    -
    Parameters
    - - - - -
    substring - The substring to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - textEndsWith - (String substring) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    substring - The substring to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - BySelector - - textStartsWith - (String substring) -

    -
    -
    - - - -
    -
    - - - - -

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

    -
    -
    Parameters
    - - - - -
    substring - The substring to match.
    -
    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - String - - toString - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a String representation of this BySelector. The format is - "BySelector [<KEY>='<VALUE> ... ]". 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). -

    - -
    -
    - - - - - - + - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/uiautomator/Configurator.html b/docs/html/reference/android/support/test/uiautomator/Configurator.html index 47ffa48186ac..ac7fb079b07f 100644 --- a/docs/html/reference/android/support/test/uiautomator/Configurator.html +++ b/docs/html/reference/android/support/test/uiautomator/Configurator.html @@ -1,1028 +1,110 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Configurator | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    - -
    - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - - final - - class -

    Configurator

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳android.support.test.uiautomator.Configurator
    - - - - - - - -
    - - -

    Class Overview

    -

    Allows you to set key parameters for running uiautomator tests. The new - settings take effect immediately and can be changed any time during a test run. - - To modify parameters using Configurator, first obtain an instance by calling - getInstance(). As a best practice, make sure you always save - the original value of any parameter that you are modifying. After running your - tests with the modified parameters, make sure to also restore - the original parameter values, otherwise this will impact other tests cases.

    - - - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Methods
    - - - - - - long - - getActionAcknowledgmentTimeout() - -
    - Gets the current timeout for waiting for an acknowledgment of generic - uiautomator actions, such as clicks, text setting, and menu presses. - - - -
    - -
    - static - Configurator - - getInstance() -
    - Retrieves a singleton instance of Configurator. -
    -
    - long - - getKeyInjectionDelay() -
    - Gets the current delay between key presses when injecting text input. -
    -
    - long - - getScrollAcknowledgmentTimeout() - -
    - Gets the timeout for waiting for an acknowledgement of an - uiautomtor scroll swipe action. - - - -
    - -
    - - - - - - long - - getWaitForIdleTimeout() - -
    - Gets the current timeout used for waiting for the user interface to go - into an idle state. -
    -
    - long - - getWaitForSelectorTimeout() -
    - Gets the current timeout for waiting for a widget to become visible in - the user interface so that it can be matched by a selector. - - - -
    - -
    - Configurator - - setActionAcknowledgmentTimeout(long timeout) -
    - Sets the timeout for waiting for an acknowledgment of generic uiautomator - actions, such as clicks, text setting, and menu presses. - - - -
    -
    - Configurator - - setKeyInjectionDelay(long delay) -
    - Sets a delay between key presses when injecting text input. -
    -
    - Configurator - - setScrollAcknowledgmentTimeout(long timeout) -
    - Sets the timeout for waiting for an acknowledgement of an - uiautomtor scroll swipe action. -
    -
    - Configurator - - setWaitForIdleTimeout(long timeout) -
    - Sets the timeout for waiting for the user interface to go into an idle - state before starting a uiautomator action. -
    -
    - Configurator - - setWaitForSelectorTimeout(long timeout) -
    - Sets the timeout for waiting for a widget to become visible in the user - interface so that it can be matched by a selector. -
    -
    @@ -1030,208 +112,839 @@ Summary: - - - - - - + +
    +

    getCurrentActivityName

    +
    +
    + + -
    - - +
    +

    getDisplayHeight

    +
    +
    + + +
    +
    +int getDisplayHeight ()
    + + + + +

    Gets the height of the display, in pixels. The size is adjusted based + on the current orientation of the display.

    + +
    - [Expand] -
    Inherited Methods
    - -From class - java.lang.Object -
    - - - - - - - - - - - @@ -1275,502 +978,500 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - long - - getActionAcknowledgmentTimeout - () -

    -
    -
    - - - -
    -
    - - +
    +

    getActionAcknowledgmentTimeout

    +
    +
    + + +
    +
    +long getActionAcknowledgmentTimeout ()
    + + -

    Gets the current timeout for waiting for an acknowledgment of generic + +

    Gets the current timeout for waiting for an acknowledgment of generic uiautomator actions, such as clicks, text setting, and menu presses. The acknowledgment is an AccessibilityEvent, corresponding to an action, that lets the framework determine if the action was successful. Generally, this timeout should not be modified. - See UiObject

    -
    -
    Returns
    -
    • current timeout in milliseconds
    -
    + See UiObject

    + + + + + + + +
    Returns
    longcurrent timeout in milliseconds
    -
    -
    -

    - - public - static - - - - Configurator - - getInstance - () -

    -
    -
    - - - -
    -
    - - - - -

    Retrieves a singleton instance of Configurator.

    -
    -
    Returns
    -
    • Configurator instance
    -
    +
    +

    getInstance

    +
    +
    + +
    +
    +Configurator getInstance ()
    + + + + +

    Retrieves a singleton instance of Configurator.

    + + + + + + + +
    Returns
    ConfiguratorConfigurator instance
    +
    -
    -

    - - public - - - - - long - - getKeyInjectionDelay - () -

    -
    -
    - - - -
    -
    - - - - -

    Gets the current delay between key presses when injecting text input. - See setText(String)

    -
    -
    Returns
    -
    • current delay in milliseconds
    -
    +
    +

    getKeyInjectionDelay

    +
    +
    + +
    +
    +long getKeyInjectionDelay ()
    + + + + +

    Gets the current delay between key presses when injecting text input. + See setText(String)

    + + + + + + + +
    Returns
    longcurrent delay in milliseconds
    +
    -
    -

    - - public - - - - - long - - getScrollAcknowledgmentTimeout - () -

    -
    -
    - - - -
    -
    - - +
    +

    getScrollAcknowledgmentTimeout

    +
    +
    + + +
    +
    +long getScrollAcknowledgmentTimeout ()
    + + -

    Gets the timeout for waiting for an acknowledgement of an + +

    Gets the timeout for waiting for an acknowledgement of an uiautomtor scroll swipe action. The acknowledgment is an AccessibilityEvent, corresponding to the scroll action, that lets the framework determine if the scroll action was successful. Generally, this timeout should not be modified. - See UiScrollable

    -
    -
    Returns
    -
    • current timeout in milliseconds
    -
    + See UiScrollable

    + + + + + + + +
    Returns
    longcurrent timeout in milliseconds
    -
    - - -
    -

    - - public - - - + - long - - getWaitForIdleTimeout - () -

    -
    -
    +
    +

    getToolType

    +
    +
    + + +
    +
    +int getToolType ()
    + + + + +

    Gets the current tool type to use for motion events.

    + + + + + + +
    Returns
    int
    +
    +

    See also:

    + +
    +
    -
    -
    + +
    +

    getWaitForIdleTimeout

    +
    +
    + + +
    +
    +long getWaitForIdleTimeout ()
    + + -

    Gets the current timeout used for waiting for the user interface to go + +

    Gets the current timeout used for waiting for the user interface to go into an idle state. - By default, all core uiautomator objects except UiDevice will perform + By default, all core uiautomator objects except UiDevice will perform this wait before starting to search for the widget specified by the - object's UiSelector. Once the idle state is detected or the + object's UiSelector. Once the idle state is detected or the timeout elapses (whichever occurs first), the object will start to wait for the selector to find a match. - See setWaitForSelectorTimeout(long)

    -
    -
    Returns
    -
    • Current timeout value in milliseconds
    -
    + See setWaitForSelectorTimeout(long)

    + + + + + + + +
    Returns
    longCurrent timeout value in milliseconds
    -
    -
    -

    - - public - - - - - long - - getWaitForSelectorTimeout - () -

    -
    -
    - - - -
    -
    - - +
    +

    getWaitForSelectorTimeout

    +
    +
    + + +
    +
    +long getWaitForSelectorTimeout ()
    + + -

    Gets the current timeout for waiting for a widget to become visible in + +

    Gets the current timeout for waiting for a widget to become visible in the user interface so that it can be matched by a selector. Because user interface content is dynamic, sometimes a widget may not be visible immediately and won't be detected by a selector. This timeout allows the uiautomator framework to wait for a match to be found, up until - the timeout elapses.

    -
    -
    Returns
    -
    • Current timeout value in milliseconds
    -
    + the timeout elapses.

    + + + + + + + +
    Returns
    longCurrent timeout value in milliseconds
    -
    -
    -

    - - public - - - - - Configurator - - setActionAcknowledgmentTimeout - (long timeout) -

    -
    -
    - - - -
    -
    - - +
    +

    setActionAcknowledgmentTimeout

    +
    +
    + + +
    +
    +Configurator setActionAcknowledgmentTimeout (long timeout)
    + + -

    Sets the timeout for waiting for an acknowledgment of generic uiautomator + +

    Sets the timeout for waiting for an acknowledgment of generic uiautomator actions, such as clicks, text setting, and menu presses. The acknowledgment is an AccessibilityEvent, corresponding to an action, that lets the framework determine if the action was successful. Generally, this timeout should not be modified. - See UiObject

    -
    -
    Parameters
    - - - - -
    timeout - Timeout value in milliseconds
    -
    -
    -
    Returns
    -
    • self
    -
    + See UiObject

    + + + + + + + +
    Parameters
    timeout + long: + Timeout value in milliseconds
    + + + + + + +
    Returns
    Configuratorself
    -
    -
    -

    - - public - - - - - Configurator - - setKeyInjectionDelay - (long delay) -

    -
    -
    - - - -
    -
    - - - - -

    Sets a delay between key presses when injecting text input. - See setText(String)

    -
    -
    Parameters
    - - - - -
    delay - Delay value in milliseconds
    -
    -
    -
    Returns
    -
    • self
    -
    +
    +

    setKeyInjectionDelay

    +
    +
    + +
    +
    +Configurator setKeyInjectionDelay (long delay)
    + + + + +

    Sets a delay between key presses when injecting text input. + See setText(String)

    + + + + + + + +
    Parameters
    delay + long: + Delay value in milliseconds
    + + + + + + +
    Returns
    Configuratorself
    +
    -
    -

    - - public - - - - - Configurator - - setScrollAcknowledgmentTimeout - (long timeout) -

    -
    -
    - - - -
    -
    - - +
    +

    setScrollAcknowledgmentTimeout

    +
    +
    + + +
    +
    +Configurator setScrollAcknowledgmentTimeout (long timeout)
    + + -

    Sets the timeout for waiting for an acknowledgement of an + +

    Sets the timeout for waiting for an acknowledgement of an uiautomtor scroll swipe action. The acknowledgment is an AccessibilityEvent, corresponding to the scroll action, that lets the framework determine if the scroll action was successful. Generally, this timeout should not be modified. - See UiScrollable

    -
    -
    Parameters
    - - - - -
    timeout - Timeout value in milliseconds
    -
    -
    -
    Returns
    -
    • self
    -
    + See UiScrollable

    + + + + + + + +
    Parameters
    timeout + long: + Timeout value in milliseconds
    + + + + + + +
    Returns
    Configuratorself
    -
    - - -
    -

    - - public - + +
    +

    setToolType

    +
    +
    + + +
    +
    +Configurator setToolType (int toolType)
    + + + + +

    Sets the current tool type to use for motion events.

    + + + + + + +
    Parameters
    toolType + int +
    + + + + + + +
    Returns
    Configurator
    +
    +

    See also:

    + +
    - Configurator - - setWaitForIdleTimeout - (long timeout) -

    -
    -
    - - +
    -
    -
    + +
    +

    setWaitForIdleTimeout

    +
    +
    + + +
    +
    +Configurator setWaitForIdleTimeout (long timeout)
    + + -

    Sets the timeout for waiting for the user interface to go into an idle + +

    Sets the timeout for waiting for the user interface to go into an idle state before starting a uiautomator action. - By default, all core uiautomator objects except UiDevice will perform + By default, all core uiautomator objects except UiDevice will perform this wait before starting to search for the widget specified by the - object's UiSelector. Once the idle state is detected or the + object's UiSelector. Once the idle state is detected or the timeout elapses (whichever occurs first), the object will start to wait for the selector to find a match. - See setWaitForSelectorTimeout(long)

    -
    -
    Parameters
    - - - - -
    timeout - Timeout value in milliseconds
    -
    -
    -
    Returns
    -
    • self
    -
    + See setWaitForSelectorTimeout(long)

    + + + + + + + +
    Parameters
    timeout + long: + Timeout value in milliseconds
    + + + + + + +
    Returns
    Configuratorself
    -
    -
    -

    - - public - - - - - Configurator - - setWaitForSelectorTimeout - (long timeout) -

    -
    -
    - - - -
    -
    - - +
    +

    setWaitForSelectorTimeout

    +
    +
    + + +
    +
    +Configurator setWaitForSelectorTimeout (long timeout)
    + + -

    Sets the timeout for waiting for a widget to become visible in the user + +

    Sets the timeout for waiting for a widget to become visible in the user interface so that it can be matched by a selector. Because user interface content is dynamic, sometimes a widget may not be visible immediately and won't be detected by a selector. This timeout allows the uiautomator framework to wait for a match to be found, up until - the timeout elapses.

    -
    -
    Parameters
    - - - - -
    timeout - Timeout value in milliseconds.
    -
    -
    -
    Returns
    -
    • self
    -
    + the timeout elapses.

    + + + + + + + +
    Parameters
    timeout + long: + Timeout value in milliseconds.
    + + + + + + +
    Returns
    Configuratorself
    -
    @@ -1782,193 +1483,59 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/uiautomator/Direction.html b/docs/html/reference/android/support/test/uiautomator/Direction.html index 6e517480b028..2a45d2fe20f7 100644 --- a/docs/html/reference/android/support/test/uiautomator/Direction.html +++ b/docs/html/reference/android/support/test/uiautomator/Direction.html @@ -1,830 +1,3 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Direction | Android Developers - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - - - - -
    -
    - - - - -
    - public - - final - - enum -

    Direction

    - - - - - - - - - extends Enum<E extends Enum<E>>
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    java.lang.Object
       ↳java.lang.Enum<E extends java.lang.Enum<E>>
        ↳android.support.test.uiautomator.Direction
    - - - - - - - -
    - - -

    Class Overview

    -

    An enumeration used to specify the primary direction of certain gestures.

    - - - - - -
    - - - - - - - - - - - - - - - - -
    - - -

    Summary

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -838,68 +11,27 @@ Summary: - -
    Enum Values
    Direction DOWN  -   - - - -
    Direction LEFT  -   - - - -
    Direction RIGHT  -   - - - -
    Direction UP  -   - - - -
    - - - - - - - - - - - - - - - - -
    Public Methods
    - - - - static - Direction - - reverse(Direction direction) -
    - Returns the reverse of the given direction. -
    -
    - static - Direction - - valueOf(String name) -
    - final - static - Direction[] - - values() -
    @@ -907,410 +39,983 @@ Summary: - - - - - - - - - - - + +
    +

    dumpWindowHierarchy

    +
    +
    + + +
    +
    +void dumpWindowHierarchy (String fileName)
    + + -
    - - +
    +

    findObject

    +
    +
    + + +
    +
    +UiObject findObject (UiSelector selector)
    + + + + +

    Returns a UiObject which represents a view that matches the specified selector criteria.

    +
    - [Expand] -
    Inherited Methods
    - -From class - java.lang.Enum -
    - -
    -
    - -From class - - java.lang.Object - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Constructors

    - - - - - -
    -

    - - public - - - - - - - UiCollection - (UiSelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Constructs an instance as described by the selector

    - -
    @@ -2381,257 +2171,235 @@ From class -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - - - UiObject - - getChildByDescription - (UiSelector childPattern, String text) -

    -
    -
    - +
    +

    getChildByDescription

    +
    +
    + + - -
    -
    - - - - -

    Searches for child UI element within the constraints of this UiCollection UiSelector +

    +
    +UiObject getChildByDescription (UiSelector childPattern, 
    +                String text)
    + + + + +

    Searches for child UI element within the constraints of this UiCollection UiSelector selector. It looks for any child matching the childPattern argument that has a child UI element anywhere within its sub hierarchy that has content-description text. The returned UiObject will point at the childPattern instance that matched the - search and not at the identifying child element that matched the content description.

    -
    -
    Parameters
    - - - - - - - -
    childPattern - UiSelector selector of the child pattern to match and return
    text - String of the identifying child contents of of the childPattern
    -
    -
    -
    Returns
    -
    • UiObject pointing at and instance of childPattern
    -
    -
    -
    Throws
    - + search and not at the identifying child element that matched the content description.

    + +
    + + + + + + + + + +
    Parameters
    childPattern + UiSelector: + UiSelector selector of the child pattern to match and return
    text + String: + String of the identifying child contents of of the childPattern
    + + + + + + +
    Returns
    UiObjectUiObject pointing at and instance of childPattern
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    -
    -

    - - public - - - - - UiObject - - getChildByInstance - (UiSelector childPattern, int instance) -

    -
    -
    - +
    +

    getChildByInstance

    +
    +
    + + - -
    -
    - - - - -

    Searches for child UI element within the constraints of this UiCollection UiSelector +

    +
    +UiObject getChildByInstance (UiSelector childPattern, 
    +                int instance)
    + + + + +

    Searches for child UI element within the constraints of this UiCollection UiSelector selector. It looks for any child matching the childPattern argument that has a child UI element anywhere within its sub hierarchy that is at the instance specified. The operation is performed only on the visible items and no scrolling is performed - in this case.

    -
    -
    Parameters
    - - - - - - - -
    childPattern - UiSelector selector of the child pattern to match and return
    instance - int the desired matched instance of this childPattern
    -
    -
    -
    Returns
    -
    • UiObject pointing at and instance of childPattern
    -
    -
    -
    Throws
    - + in this case.

    + +
    + + + + + + + + + +
    Parameters
    childPattern + UiSelector: + UiSelector selector of the child pattern to match and return
    instance + int: + int the desired matched instance of this childPattern
    + + + + + + +
    Returns
    UiObjectUiObject pointing at and instance of childPattern
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    -
    -

    - - public - - - - - UiObject - - getChildByText - (UiSelector childPattern, String text) -

    -
    -
    - +
    +

    getChildByText

    +
    +
    + + - -
    -
    - - - - -

    Searches for child UI element within the constraints of this UiCollection UiSelector +

    +
    +UiObject getChildByText (UiSelector childPattern, 
    +                String text)
    + + + + +

    Searches for child UI element within the constraints of this UiCollection UiSelector selector. It looks for any child matching the childPattern argument that has a child UI element anywhere within its sub hierarchy that has text attribute = text. The returned UiObject will point at the childPattern instance that matched the search and not at the identifying child element that matched the - text attribute.

    -
    -
    Parameters
    - - - - - - - -
    childPattern - UiSelector selector of the child pattern to match and return
    text - String of the identifying child contents of of the childPattern
    -
    -
    -
    Returns
    -
    • UiObject pointing at and instance of childPattern
    -
    -
    -
    Throws
    - + text attribute.

    + +
    + + + + + + + + + +
    Parameters
    childPattern + UiSelector: + UiSelector selector of the child pattern to match and return
    text + String: + String of the identifying child contents of of the childPattern
    + + + + + + +
    Returns
    UiObjectUiObject pointing at and instance of childPattern
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    -
    -

    - - public - - - - - int - - getChildCount - (UiSelector childPattern) -

    -
    -
    - - - -
    -
    - - +
    +

    getChildCount

    +
    +
    + + +
    +
    +int getChildCount (UiSelector childPattern)
    + + -

    Counts child UI element instances matching the childPattern + +

    Counts child UI element instances matching the childPattern argument. The method returns the number of matching UI elements that are currently visible. The count does not include items of a scrollable list - that are off-screen.

    -
    -
    Parameters
    - - - +
    childPattern - a UiSelector that represents the matching child UI + that are off-screen.

    + + + + + + - -
    Parameters
    childPattern + UiSelector: + a UiSelector that represents the matching child UI elements to count
    - -
    -
    Returns
    -
    • the number of matched childPattern under the current UiCollection
    -
    +
    + + + + + + +
    Returns
    intthe number of matched childPattern under the current UiCollection
    -
    @@ -2643,193 +2411,59 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/uiautomator/UiDevice.html b/docs/html/reference/android/support/test/uiautomator/UiDevice.html index 3685972b4921..0e026f95e990 100644 --- a/docs/html/reference/android/support/test/uiautomator/UiDevice.html +++ b/docs/html/reference/android/support/test/uiautomator/UiDevice.html @@ -1,4 +1,3 @@ - @@ -93,512 +92,85 @@ - - - - - - -UiDevice | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +UiDevice - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public +

    UiDevice

    +

    + + public + + + + class + UiDevice + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.uiautomator.UiDevice +
    + + - class -

    UiDevice

    +

    +

    UiDevice provides access to state information about the device. + You can also use this class to simulate user actions on the device, + such as pressing the d-pad or pressing the Home and Menu buttons.

    - extends Object
    +

    Summary

    @@ -660,29 +275,17 @@ Summary: -
    -
    -
    - - - - - - - - -
    java.lang.Object
       ↳android.support.test.uiautomator.UiDevice
    @@ -690,19 +293,1715 @@ Summary: -
    -

    Class Overview

    -

    UiDevice provides access to state information about the device. - You can also use this class to simulate user actions on the device, - such as pressing the d-pad or pressing the Home and Menu buttons.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +

    Public methods

    + + + + + + void + + + clearLastTraversedText() + + +

    Clears the text from the last UI traversal event. + + +

    + +
    + + + + + + boolean + + + click(int x, int y) + + +

    Perform a click at arbitrary coordinates specified by the user + + +

    + +
    + + + + + + boolean + + + drag(int startX, int startY, int endX, int endY, int steps) + + +

    Performs a swipe from one coordinate to another coordinate. + + +

    + +
    + + + + + + void + + + dumpWindowHierarchy(File dest) + + +

    Dump the current window hierarchy to a File. + + +

    + +
    + + + + + + void + + + dumpWindowHierarchy(OutputStream out) + + +

    Dump the current window hierarchy to an OutputStream. + + +

    + +
    + + + + + + void + + + dumpWindowHierarchy(String fileName) + + +

    + This method is deprecated. + Use dumpWindowHierarchy(File) or + dumpWindowHierarchy(OutputStream) instead. + + + +

    + +
    + + + + + + UiObject2 + + + findObject(BySelector selector) + + +

    Returns the first object to match the selector criteria. + + +

    + +
    + + + + + + UiObject + + + findObject(UiSelector selector) + + +

    Returns a UiObject which represents a view that matches the specified selector criteria. + + +

    + +
    + + + + + + List<UiObject2> + + + findObjects(BySelector selector) + + +

    Returns all objects that match the selector criteria. + + +

    + +
    + + + + + + void + + + freezeRotation() + + +

    Disables the sensors and freezes the device rotation at its + current rotation state. + + +

    + +
    + + + + + + String + + + getCurrentActivityName() + + +

    + This method is deprecated. + The results returned should be considered unreliable + + +

    + +
    + + + + + + String + + + getCurrentPackageName() + + +

    Retrieves the name of the last package to report accessibility events. + + +

    + +
    + + + + + + int + + + getDisplayHeight() + + +

    Gets the height of the display, in pixels. + + +

    + +
    + + + + + + int + + + getDisplayRotation() + + +

    Returns the current rotation of the display, as defined in Surface + + +

    + +
    + + + + + + Point + + + getDisplaySizeDp() + + +

    Returns the display size in dp (device-independent pixel) + The returned display size is adjusted per screen rotation. + + +

    + +
    + + + + + + int + + + getDisplayWidth() + + +

    Gets the width of the display, in pixels. + + +

    + +
    + + + static + + + UiDevice + + + getInstance() + + +

    + This method is deprecated. + Should use getInstance(Instrumentation) instead. This version hides + UiDevice's dependency on having an Instrumentation reference and is prone to misuse. + + +

    + +
    + + + static + + + UiDevice + + + getInstance(Instrumentation instrumentation) + + +

    Retrieves a singleton instance of UiDevice + + +

    + +
    + + + + + + String + + + getLastTraversedText() + + +

    Retrieves the text from the last UI traversal event received. + + +

    + +
    + + + + + + String + + + getLauncherPackageName() + + +

    Retrieves default launcher package name + + +

    + +
    + + + + + + String + + + getProductName() + + +

    Retrieves the product name of the device. + + +

    + +
    + + + + + + boolean + + + hasAnyWatcherTriggered() + + +

    Checks if any registered UiWatcher have triggered. + + +

    + +
    + + + + + + boolean + + + hasObject(BySelector selector) + + +

    Returns whether there is a match for the given selector criteria. + + +

    + +
    + + + + + + boolean + + + hasWatcherTriggered(String watcherName) + + +

    Checks if a specific registered UiWatcher has triggered. + + +

    + +
    + + + + + + boolean + + + isNaturalOrientation() + + +

    Check if the device is in its natural orientation. + + +

    + +
    + + + + + + boolean + + + isScreenOn() + + +

    Checks the power manager if the screen is ON. + + +

    + +
    + + + + + + boolean + + + openNotification() + + +

    Opens the notification shade. + + +

    + +
    + + + + + + boolean + + + openQuickSettings() + + +

    Opens the Quick Settings shade. + + +

    + +
    + + + + + <R> + R + + + performActionAndWait(Runnable action, EventCondition<R> condition, long timeout) + + +

    Performs the provided action and waits for the condition to be met. + + +

    + +
    + + + + + + boolean + + + pressBack() + + +

    Simulates a short press on the BACK button. + + +

    + +
    + + + + + + boolean + + + pressDPadCenter() + + +

    Simulates a short press on the CENTER button. + + +

    + +
    + + + + + + boolean + + + pressDPadDown() + + +

    Simulates a short press on the DOWN button. + + +

    + +
    + + + + + + boolean + + + pressDPadLeft() + + +

    Simulates a short press on the LEFT button. + + +

    + +
    + + + + + + boolean + + + pressDPadRight() + + +

    Simulates a short press on the RIGHT button. + + +

    + +
    + + + + + + boolean + + + pressDPadUp() + + +

    Simulates a short press on the UP button. + + +

    + +
    + + + + + + boolean + + + pressDelete() + + +

    Simulates a short press on the DELETE key. + + +

    + +
    + + + + + + boolean + + + pressEnter() + + +

    Simulates a short press on the ENTER key. + + +

    + +
    + + + + + + boolean + + + pressHome() + + +

    Simulates a short press on the HOME button. + + +

    + +
    + + + + + + boolean + + + pressKeyCode(int keyCode) + + +

    Simulates a short press using a key code. + + +

    + +
    + + + + + + boolean + + + pressKeyCode(int keyCode, int metaState) + + +

    Simulates a short press using a key code. + + +

    + +
    + + + + + + boolean + + + pressMenu() + + +

    Simulates a short press on the MENU button. + + +

    + +
    + + + + + + boolean + + + pressRecentApps() + + +

    Simulates a short press on the Recent Apps button. + + +

    + +
    + + + + + + boolean + + + pressSearch() + + +

    Simulates a short press on the SEARCH button. + + +

    + +
    + + + + + + void + + + registerWatcher(String name, UiWatcher watcher) + + +

    Registers a UiWatcher to run automatically when the testing framework is unable to + find a match using a UiSelector. + + +

    + +
    + + + + + + void + + + removeWatcher(String name) + + +

    Removes a previously registered UiWatcher. + + +

    + +
    + + + + + + void + + + resetWatcherTriggers() + + +

    Resets a UiWatcher that has been triggered. + + +

    + +
    + + + + + + void + + + runWatchers() + + +

    This method forces all registered watchers to run. + + +

    + +
    + + + + + + void + + + setCompressedLayoutHeirarchy(boolean compressed) + + +

    Enables or disables layout hierarchy compression. + + +

    + +
    + + + + + + void + + + setOrientationLeft() + + +

    Simulates orienting the device to the left and also freezes rotation + by disabling the sensors. + + +

    + +
    + + + + + + void + + + setOrientationNatural() + + +

    Simulates orienting the device into its natural orientation and also freezes rotation + by disabling the sensors. + + +

    + +
    + + + + + + void + + + setOrientationRight() + + +

    Simulates orienting the device to the right and also freezes rotation + by disabling the sensors. + + +

    + +
    + + + + + + void + + + sleep() + + +

    This method simply presses the power button if the screen is ON else + it does nothing if the screen is already OFF. + + +

    + +
    + + + + + + boolean + + + swipe(int startX, int startY, int endX, int endY, int steps) + + +

    Performs a swipe from one coordinate to another using the number of steps + to determine smoothness and speed. + + +

    + +
    + + + + + + boolean + + + swipe(Point[] segments, int segmentSteps) + + +

    Performs a swipe between points in the Point array. + + +

    + +
    + + + + + + boolean + + + takeScreenshot(File storePath, float scale, int quality) + + +

    Take a screenshot of current window and store it as PNG + The screenshot is adjusted per screen rotation + + +

    + +
    + + + + + + boolean + + + takeScreenshot(File storePath) + + +

    Take a screenshot of current window and store it as PNG + Default scale of 1.0f (original size) and 90% quality is used + The screenshot is adjusted per screen rotation + + +

    + +
    + + + + + + void + + + unfreezeRotation() + + +

    Re-enables the sensors and un-freezes the device rotation allowing its contents + to rotate with the device physical rotation. + + +

    + +
    + + + + + <R> + R + + + wait(SearchCondition<R> condition, long timeout) + + +

    Waits for given the condition to be met. + + +

    + +
    + + + + + + void + + + waitForIdle(long timeout) + + +

    Waits for the current application to idle. + + +

    + +
    + + + + + + void + + + waitForIdle() + + +

    Waits for the current application to idle. + + +

    + +
    + + + + + + boolean + + + waitForWindowUpdate(String packageName, long timeout) + + +

    Waits for a window content update event to occur. + + +

    + +
    + + + + + + void + + + wakeUp() + + +

    This method simulates pressing the power button if the screen is OFF else + it does nothing if the screen is already ON. + + +

    + +
    @@ -710,4330 +2009,2484 @@ Summary: + + + + + +

    Inherited methods

    + From +class + + + java.lang.Object + + +
    + + +
    +
    + -
    + -

    Summary

    + + + + + + + +

    Public methods

    + +
    +

    clearLastTraversedText

    +
    +
    + + +
    +
    +void clearLastTraversedText ()
    + + + +

    Clears the text from the last UI traversal event. + See getLastTraversedText().

    + +
    + +
    +

    click

    +
    +
    + + +
    +
    +boolean click (int x, 
    +                int y)
    + + + + +

    Perform a click at arbitrary coordinates specified by the user

    + + + + + + + + + + + +
    Parameters
    x + int: + coordinate
    y + int: + coordinate
    + + + + + + +
    Returns
    booleantrue if the click succeeded else false
    +
    + - - +
    +

    drag

    +
    +
    + + +
    +
    +boolean drag (int startX, 
    +                int startY, 
    +                int endX, 
    +                int endY, 
    +                int steps)
    + + + + +

    Performs a swipe from one coordinate to another coordinate. You can control + the smoothness and speed of the swipe by specifying the number of steps. + Each step execution is throttled to 5 milliseconds per step, so for a 100 + steps, the swipe will take around 0.5 seconds to complete.

    + +
    Public Methods
    + + + + + + + + + + + + + + + + + + + + + +
    Parameters
    startX + int: + X-axis value for the starting coordinate
    startY + int: + Y-axis value for the starting coordinate
    endX + int: + X-axis value for the ending coordinate
    endY + int: + Y-axis value for the ending coordinate
    steps + int: + is the number of steps for the swipe action
    + + + + + + +
    Returns
    booleantrue if swipe is performed, false if the operation fails + or the coordinates are invalid
    +
    -
    + +
    +

    dumpWindowHierarchy

    +
    +
    + + +
    +
    +void dumpWindowHierarchy (File dest)
    + + + + +

    Dump the current window hierarchy to a File.

    + + + + + + +
    Parameters
    dest + File: + The file in which to store the window hierarchy information.
    + + + + + + +
    Throws
    IOException
    + +
    - void
    -
    - clearLastTraversedText() + -
    - Clears the text from the last UI traversal event. +
    +

    dumpWindowHierarchy

    +
    +
    + + +
    +
    +void dumpWindowHierarchy (OutputStream out)
    + + + + +

    Dump the current window hierarchy to an OutputStream.

    + + + + + + +
    Parameters
    out + OutputStream: + The output stream that the window hierarchy information is written to.
    + + + + + + +
    Throws
    IOException
    + +
    -
    -
    +

    +

    + This method is deprecated.
    + Use dumpWindowHierarchy(File) or + dumpWindowHierarchy(OutputStream) instead. +

    +

    Helper method used for debugging to dump the current window's layout hierarchy. + Relative file paths are stored the application's internal private storage location.

    + + + - boolean
    -
    - click(int x, int y) +
    +

    findObject

    +
    +
    + + -
    - Perform a click at arbitrary coordinates specified by the user +
    +
    +UiObject2 findObject (BySelector selector)
    + + + + +

    Returns the first object to match the selector criteria.

    + + + + + + +
    Parameters
    selector + BySelector +
    + + + + + + +
    Returns
    UiObject2
    +
    -
    + -
    + + + + + +
    Returns
    UiObjectUiObject object +
    +
    -
    + +
    +

    findObjects

    +
    +
    + + +
    +
    +List<UiObject2> findObjects (BySelector selector)
    + + + + +

    Returns all objects that match the selector criteria.

    + + + + + + +
    Parameters
    selector + BySelector +
    + + + + + + +
    Returns
    List<UiObject2>
    +
    - boolean
    -
    - drag(int startX, int startY, int endX, int endY, int steps) -
    - Performs a swipe from one coordinate to another coordinate. + +
    +

    freezeRotation

    +
    +
    + + +
    +
    +void freezeRotation ()
    + + + + +

    Disables the sensors and freezes the device rotation at its + current rotation state.

    + + + + + + + + + + + +
    Throws
    RemoteException
    RemoteException
    + -
    +
    -
    + +
    +String getCurrentActivityName ()
    + + +

    +

    + This method is deprecated.
    + The results returned should be considered unreliable +

    +

    Retrieves the last activity to report accessibility events.

    + + + + + + + +
    Returns
    StringString name of activity
    + + - void
    -
    - dumpWindowHierarchy(File dest) +
    +

    getCurrentPackageName

    +
    +
    + + -
    - Dump the current window hierarchy to a File. +
    +
    +String getCurrentPackageName ()
    + + + + +

    Retrieves the name of the last package to report accessibility events.

    + + + + + + + +
    Returns
    StringString name of package
    +
    -
    + -
    + + + + + +
    Returns
    intheight in pixels or zero on failure
    +
    - - + +
    +

    getDisplayRotation

    +
    +
    + + +
    +
    +int getDisplayRotation ()
    + + + + +

    Returns the current rotation of the display, as defined in Surface

    + + + + + + + +
    Returns
    int
    +
    - void
    - - - dumpWindowHierarchy(String fileName) -
    - - This method is deprecated. - Use dumpWindowHierarchy(File) or - dumpWindowHierarchy(OutputStream) instead. - + +
    +

    getDisplaySizeDp

    +
    +
    + + +
    +
    +Point getDisplaySizeDp ()
    + + -
    + +

    Returns the display size in dp (device-independent pixel) - + The returned display size is adjusted per screen rotation. Also this will return the actual + size of the screen, rather than adjusted per system decorations (like status bar).

    + + + + + + +
    Returns
    Pointa Point containing the display size in dp +
    +
    - - + +
    +

    getDisplayWidth

    +
    +
    + + +
    +
    +int getDisplayWidth ()
    + + + + +

    Gets the width of the display, in pixels. The width and height details + are reported based on the current orientation of the display.

    + + + + + + + +
    Returns
    intwidth in pixels or zero on failure
    +
    - void
    - - - dumpWindowHierarchy(OutputStream out) + -
    - Dump the current window hierarchy to an OutputStream. +
    +

    getInstance

    +
    +
    + + +
    +
    +UiDevice getInstance ()
    + + +

    +

    + This method is deprecated.
    + Should use getInstance(Instrumentation) instead. This version hides + UiDevice's dependency on having an Instrumentation reference and is prone to misuse. +

    +

    Retrieves a singleton instance of UiDevice

    + + + + + + + +
    Returns
    UiDeviceUiDevice instance
    -
    +
    - + +
    +

    getInstance

    +
    +
    + + - - +
    +
    +UiDevice getInstance (Instrumentation instrumentation)
    + + + + +

    Retrieves a singleton instance of UiDevice

    + + + + + + +
    Parameters
    instrumentation + Instrumentation +
    + + + + + + +
    Returns
    UiDeviceUiDevice instance +
    +
    + +
    +

    getLastTraversedText

    +
    +
    + + - UiObject2
    - - - findObject(BySelector selector) +
    +
    +String getLastTraversedText ()
    + + -
    - Returns the first object to match the selector criteria. + +

    Retrieves the text from the last UI traversal event received. + You can use this method to read the contents in a WebView container + because the accessibility framework fires events + as each text is highlighted. You can write a test to perform + directional arrow presses to focus on different elements inside a WebView, + and call this method to get the text from each traversed element. + If you are testing a view container that can return a reference to a + Document Object Model (DOM) object, your test should use the view's + DOM instead.

    + + + + + + + +
    Returns
    Stringtext of the last traversal event, else return an empty string
    +
    -
    - + +
    +

    getLauncherPackageName

    +
    +
    + + +
    +
    +String getLauncherPackageName ()
    + + + + +

    Retrieves default launcher package name

    + + + + + + +
    Returns
    Stringpackage name of the default launcher +
    - - +
    + +
    +

    getProductName

    +
    +
    + + +
    +
    +String getProductName ()
    + + - UiObject
    - - - findObject(UiSelector selector) + +

    Retrieves the product name of the device. -

    - Returns a UiObject which represents a view that matches the specified selector criteria. + This method provides information on what type of device the test is running on. This value is + the same as returned by invoking #adb shell getprop ro.product.name.

    + + + + + + + +
    Returns
    Stringproduct name of the device
    +
    -
    + - +
    +

    hasAnyWatcherTriggered

    +
    +
    + + +
    +
    +boolean hasAnyWatcherTriggered ()
    + + + + +

    Checks if any registered UiWatcher have triggered. + + See registerWatcher(String, UiWatcher) + See hasWatcherTriggered(String)

    + + + + + + + +
    Returns
    boolean
    +
    - - + +
    +

    hasObject

    +
    +
    + + +
    +
    +boolean hasObject (BySelector selector)
    + + + + +

    Returns whether there is a match for the given selector criteria.

    + + + + + + +
    Parameters
    selector + BySelector +
    + + + + + + +
    Returns
    boolean
    +
    - List<UiObject2>
    - - - findObjects(BySelector selector) -
    - Returns all objects that match the selector criteria. + +
    +

    hasWatcherTriggered

    +
    +
    + + +
    +
    +boolean hasWatcherTriggered (String watcherName)
    + + + + +

    Checks if a specific registered UiWatcher has triggered. + See registerWatcher(String, UiWatcher). If a UiWatcher runs and its + checkForCondition() call returned true, then + the UiWatcher is considered triggered. This is helpful if a watcher is detecting errors + from ANR or crash dialogs and the test needs to know if a UiWatcher has been triggered.

    + + + + + + + +
    Returns
    booleantrue if triggered else false
    -
    +
    - + +
    +

    isNaturalOrientation

    +
    +
    + + - - +
    +
    +boolean isNaturalOrientation ()
    + + + + +

    Check if the device is in its natural orientation. This is determined by checking if the + orientation is at 0 or 180 degrees.

    + + + + + + + +
    Returns
    booleantrue if it is in natural orientation
    +
    + +
    +

    isScreenOn

    +
    +
    + + - void
    - - - freezeRotation() +
    +
    +boolean isScreenOn ()
    + + + + +

    Checks the power manager if the screen is ON.

    + + + + + + + +
    Returns
    booleantrue if the screen is ON else false
    + + + + + + + + + + +
    Throws
    RemoteException
    RemoteException
    + -
    - Disables the sensors and freezes the device rotation at its - current rotation state. +
    + -
    +
    +

    openNotification

    +
    +
    + + - +
    +
    +boolean openNotification ()
    + + + + +

    Opens the notification shade.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    +
    - - + +
    +

    openQuickSettings

    +
    +
    + + +
    +
    +boolean openQuickSettings ()
    + + + + +

    Opens the Quick Settings shade.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    +
    - String
    - - - getCurrentActivityName() + -
    - - This method is deprecated. - The results returned should be considered unreliable +
    +

    performActionAndWait

    +
    +
    + + +
    +
    +R performActionAndWait (Runnable action, 
    +                EventCondition<R> condition, 
    +                long timeout)
    + + + + +

    Performs the provided action and waits for the condition to be met.

    + + + + + + + + + + + + + + +
    Parameters
    action + Runnable: + The Runnable action to perform.
    condition + EventCondition: + The EventCondition to evaluate.
    timeout + long: + Maximum amount of time to wait in milliseconds.
    + + + + + + +
    Returns
    RThe final result returned by the condition. +
    +
    -
    - + +
    +

    pressBack

    +
    +
    + + +
    +
    +boolean pressBack ()
    + + + + +

    Simulates a short press on the BACK button.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    - - +
    + +
    +

    pressDPadCenter

    +
    +
    + + +
    +
    +boolean pressDPadCenter ()
    + + + + +

    Simulates a short press on the CENTER button.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    - String
    - - - getCurrentPackageName() +
    -
    - Retrieves the name of the last package to report accessibility events. + +
    +

    pressDPadDown

    +
    +
    + + -
    +
    +
    +boolean pressDPadDown ()
    + + + + +

    Simulates a short press on the DOWN button.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    - +
    + - - +
    +

    pressDPadLeft

    +
    +
    + + +
    +
    +boolean pressDPadLeft ()
    + + + + +

    Simulates a short press on the LEFT button.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    +
    + - int
    - - - getDisplayHeight() +
    +

    pressDPadRight

    +
    +
    + + -
    - Gets the height of the display, in pixels. +
    +
    +boolean pressDPadRight ()
    + + + + +

    Simulates a short press on the RIGHT button.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    +
    -
    + - +
    +

    pressDPadUp

    +
    +
    + + +
    +
    +boolean pressDPadUp ()
    + + + + +

    Simulates a short press on the UP button.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    +
    - - + - - - - int - - - getDisplayRotation() - -
    - Returns the current rotation of the display, as defined in Surface - - - -
    - - - - - - - - - - - - - Point - - - getDisplaySizeDp() - -
    - Returns the display size in dp (device-independent pixel) - - The returned display size is adjusted per screen rotation. - - - -
    - - - - - - - - - - - - - int - - - getDisplayWidth() - -
    - Gets the width of the display, in pixels. - - - -
    - - - - - - - - - - - static - - UiDevice - - - getInstance(Instrumentation instrumentation) - -
    - Retrieves a singleton instance of UiDevice - - - -
    - - - - - - - - - - - static - - UiDevice - - - getInstance() - -
    - - This method is deprecated. - Should use getInstance(Instrumentation) instead. This version hides - UiDevice's dependency on having an Instrumentation reference and is prone to misuse. - - - -
    - - - - - - - - - - - - - String - - - getLastTraversedText() - -
    - Retrieves the text from the last UI traversal event received. - - - -
    - - - - - - - - - - - - - String - - - getLauncherPackageName() - -
    - Retrieves default launcher package name - - - -
    - - - - - - - - - - - - - String - - - getProductName() - -
    - Retrieves the product name of the device. - - - -
    - - - - - - - - - - - - - boolean - - - hasAnyWatcherTriggered() - -
    - Checks if any registered UiWatcher have triggered. - - - -
    - - - - - - - - - - - - - boolean - - - hasObject(BySelector selector) - -
    - Returns whether there is a match for the given selector criteria. - - - -
    - - - - - - - - - - - - - boolean - - - hasWatcherTriggered(String watcherName) - -
    - Checks if a specific registered UiWatcher has triggered. - - - -
    - - - - - - - - - - - - - boolean - - - isNaturalOrientation() - -
    - Check if the device is in its natural orientation. - - - -
    - - - - - - - - - - - - - boolean - - - isScreenOn() - -
    - Checks the power manager if the screen is ON. - - - -
    - - - - - - - - - - - - - boolean - - - openNotification() - -
    - Opens the notification shade. - - - -
    - - - - - - - - - - - - - boolean - - - openQuickSettings() - -
    - Opens the Quick Settings shade. - - - -
    - - - - - - - - - - - - <R> - R - - - performActionAndWait(Runnable action, EventCondition<R> condition, long timeout) - -
    - Performs the provided action and waits for the condition to be met. - - - -
    - - - - - - - - - - - - - boolean - - - pressBack() - -
    - Simulates a short press on the BACK button. - - - -
    - - - - - - - - - - - - - boolean - - - pressDPadCenter() - -
    - Simulates a short press on the CENTER button. - - - -
    - - - - - - - - - - - - - boolean - - - pressDPadDown() - -
    - Simulates a short press on the DOWN button. - - - -
    - - - - - - - - - - - - - boolean - - - pressDPadLeft() - -
    - Simulates a short press on the LEFT button. - - - -
    - - - - - - - - - - - - - boolean - - - pressDPadRight() - -
    - Simulates a short press on the RIGHT button. - - - -
    - - - - - - - - - - - - - boolean - - - pressDPadUp() - -
    - Simulates a short press on the UP button. - - - -
    - - - - - - - - - - - - - boolean - - - pressDelete() - -
    - Simulates a short press on the DELETE key. - - - -
    - - - - - - - - - - - - - boolean - - - pressEnter() - -
    - Simulates a short press on the ENTER key. - - - -
    - - - - - - - - - - - - - boolean - - - pressHome() - -
    - Simulates a short press on the HOME button. - - - -
    - - - - - - - - - - - - - boolean - - - pressKeyCode(int keyCode, int metaState) - -
    - Simulates a short press using a key code. - - - -
    - - - - - - - - - - - - - boolean - - - pressKeyCode(int keyCode) - -
    - Simulates a short press using a key code. - - - -
    - - - - - - - - - - - - - boolean - - - pressMenu() - -
    - Simulates a short press on the MENU button. - - - -
    - - - - - - - - - - - - - boolean - - - pressRecentApps() - -
    - Simulates a short press on the Recent Apps button. - - - -
    - - - - - - - - - - - - - boolean - - - pressSearch() - -
    - Simulates a short press on the SEARCH button. - - - -
    - - - - - - - - - - - - - void - - - registerWatcher(String name, UiWatcher watcher) - -
    - Registers a UiWatcher to run automatically when the testing framework is unable to - find a match using a UiSelector. - - - -
    - - - - - - - - - - - - - void - - - removeWatcher(String name) - -
    - Removes a previously registered UiWatcher. - - - -
    - - - - - - - - - - - - - void - - - resetWatcherTriggers() - -
    - Resets a UiWatcher that has been triggered. - - - -
    - - - - - - - - - - - - - void - - - runWatchers() - -
    - This method forces all registered watchers to run. - - - -
    - - - - - - - - - - - - - void - - - setCompressedLayoutHeirarchy(boolean compressed) - -
    - Enables or disables layout hierarchy compression. - - - -
    - - - - - - - - - - - - - void - - - setOrientationLeft() - -
    - Simulates orienting the device to the left and also freezes rotation - by disabling the sensors. - - - -
    - - - - - - - - - - - - - void - - - setOrientationNatural() - -
    - Simulates orienting the device into its natural orientation and also freezes rotation - by disabling the sensors. - - - -
    - - - - - - - - - - - - - void - - - setOrientationRight() - -
    - Simulates orienting the device to the right and also freezes rotation - by disabling the sensors. - - - -
    - - - - - - - - - - - - - void - - - sleep() - -
    - This method simply presses the power button if the screen is ON else - it does nothing if the screen is already OFF. - - - -
    - - - - - - - - - - - - - boolean - - - swipe(Point[] segments, int segmentSteps) - -
    - Performs a swipe between points in the Point array. - - - -
    - - - - - - - - - - - - - boolean - - - swipe(int startX, int startY, int endX, int endY, int steps) - -
    - Performs a swipe from one coordinate to another using the number of steps - to determine smoothness and speed. - - - -
    - - - - - - - - - - - - - boolean - - - takeScreenshot(File storePath) - -
    - Take a screenshot of current window and store it as PNG - - Default scale of 1.0f (original size) and 90% quality is used - The screenshot is adjusted per screen rotation - - - -
    - - - - - - - - - - - - - boolean - - - takeScreenshot(File storePath, float scale, int quality) - -
    - Take a screenshot of current window and store it as PNG - - The screenshot is adjusted per screen rotation - - - -
    - - - - - - - - - - - - - void - - - unfreezeRotation() - -
    - Re-enables the sensors and un-freezes the device rotation allowing its contents - to rotate with the device physical rotation. - - - -
    - - - - - - - - - - - - <R> - R - - - wait(SearchCondition<R> condition, long timeout) - -
    - Waits for given the condition to be met. - - - -
    - - - - - - - - - - - - - void - - - waitForIdle(long timeout) - -
    - Waits for the current application to idle. - - - -
    - - - - - - - - - - - - - void - - - waitForIdle() - -
    - Waits for the current application to idle. - - - -
    - - - - - - - - - - - - - boolean - - - waitForWindowUpdate(String packageName, long timeout) - -
    - Waits for a window content update event to occur. - - - -
    - - - - - - - - - - - - - void - - - wakeUp() - -
    - This method simulates pressing the power button if the screen is OFF else - it does nothing if the screen is already ON. - - - -
    - - - - - - - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - - - - - void - - clearLastTraversedText - () -

    -
    -
    - - - -
    -
    - - - - -

    Clears the text from the last UI traversal event. - See getLastTraversedText().

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - click - (int x, int y) -

    -
    -
    - - - -
    -
    - - - - -

    Perform a click at arbitrary coordinates specified by the user

    -
    -
    Parameters
    - - - - - - - -
    x - coordinate
    y - coordinate
    -
    -
    -
    Returns
    -
    • true if the click succeeded else false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - drag - (int startX, int startY, int endX, int endY, int steps) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a swipe from one coordinate to another coordinate. You can control - the smoothness and speed of the swipe by specifying the number of steps. - Each step execution is throttled to 5 milliseconds per step, so for a 100 - steps, the swipe will take around 0.5 seconds to complete.

    -
    -
    Parameters
    - - - - - - - - - - - - - - - - -
    startX - X-axis value for the starting coordinate
    startY - Y-axis value for the starting coordinate
    endX - X-axis value for the ending coordinate
    endY - Y-axis value for the ending coordinate
    steps - is the number of steps for the swipe action
    -
    -
    -
    Returns
    -
    • true if swipe is performed, false if the operation fails - or the coordinates are invalid
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - void - - dumpWindowHierarchy - (File dest) -

    -
    -
    - - - -
    -
    - - - - -

    Dump the current window hierarchy to a File.

    -
    -
    Parameters
    - - - - -
    dest - The file in which to store the window hierarchy information.
    -
    -
    -
    Throws
    - - - - -
    IOException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - void - - dumpWindowHierarchy - (String fileName) -

    -
    -
    - - - -
    -
    - - - -

    -

    - This method is deprecated.
    - Use dumpWindowHierarchy(File) or - dumpWindowHierarchy(OutputStream) instead. - -

    -

    Helper method used for debugging to dump the current window's layout hierarchy. - Relative file paths are stored the application's internal private storage location.

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - dumpWindowHierarchy - (OutputStream out) -

    -
    -
    - - - -
    -
    - - - - -

    Dump the current window hierarchy to an OutputStream.

    -
    -
    Parameters
    - - - - -
    out - The output stream that the window hierarchy information is written to.
    -
    -
    -
    Throws
    - - - - -
    IOException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiObject2 - - findObject - (BySelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Returns the first object to match the selector criteria.

    - -
    -
    - - - - -
    -

    - - public - - - - - UiObject - - findObject - (UiSelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a UiObject which represents a view that matches the specified selector criteria.

    -
    -
    Returns
    -
    • UiObject object -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - List<UiObject2> - - findObjects - (BySelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Returns all objects that match the selector criteria.

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - freezeRotation - () -

    -
    -
    - - - -
    -
    - - - - -

    Disables the sensors and freezes the device rotation at its - current rotation state.

    -
    -
    Throws
    - - - - - - - -
    - RemoteException
    RemoteException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getCurrentActivityName - () -

    -
    -
    - - - -
    -
    - - - -

    -

    - This method is deprecated.
    - The results returned should be considered unreliable -

    -

    Retrieves the last activity to report accessibility events.

    -
    -
    Returns
    -
    • String name of activity
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getCurrentPackageName - () -

    -
    -
    - - - -
    -
    - - - - -

    Retrieves the name of the last package to report accessibility events.

    -
    -
    Returns
    -
    • String name of package
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - int - - getDisplayHeight - () -

    -
    -
    - - - -
    -
    - - - - -

    Gets the height of the display, in pixels. The size is adjusted based - on the current orientation of the display.

    -
    -
    Returns
    -
    • height in pixels or zero on failure
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - int - - getDisplayRotation - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the current rotation of the display, as defined in Surface

    - -
    -
    - - - - -
    -

    - - public - - - - - Point - - getDisplaySizeDp - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the display size in dp (device-independent pixel) - - The returned display size is adjusted per screen rotation. Also this will return the actual - size of the screen, rather than adjusted per system decorations (like status bar).

    -
    -
    Returns
    -
    • a Point containing the display size in dp -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - int - - getDisplayWidth - () -

    -
    -
    - - - -
    -
    - - - - -

    Gets the width of the display, in pixels. The width and height details - are reported based on the current orientation of the display.

    -
    -
    Returns
    -
    • width in pixels or zero on failure
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - UiDevice - - getInstance - (Instrumentation instrumentation) -

    -
    -
    - - - -
    -
    - - - - -

    Retrieves a singleton instance of UiDevice

    -
    -
    Returns
    -
    • UiDevice instance -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - UiDevice - - getInstance - () -

    -
    -
    - - - -
    -
    - - - -

    -

    - This method is deprecated.
    - Should use getInstance(Instrumentation) instead. This version hides - UiDevice's dependency on having an Instrumentation reference and is prone to misuse. -

    -

    Retrieves a singleton instance of UiDevice

    -
    -
    Returns
    -
    • UiDevice instance
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getLastTraversedText - () -

    -
    -
    - - - -
    -
    - - - - -

    Retrieves the text from the last UI traversal event received. - - You can use this method to read the contents in a WebView container - because the accessibility framework fires events - as each text is highlighted. You can write a test to perform - directional arrow presses to focus on different elements inside a WebView, - and call this method to get the text from each traversed element. - If you are testing a view container that can return a reference to a - Document Object Model (DOM) object, your test should use the view's - DOM instead.

    -
    -
    Returns
    -
    • text of the last traversal event, else return an empty string
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getLauncherPackageName - () -

    -
    -
    - - - -
    -
    - - - - -

    Retrieves default launcher package name

    -
    -
    Returns
    -
    • package name of the default launcher -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getProductName - () -

    -
    -
    - - - -
    -
    - - - - -

    Retrieves the product name of the device. - - This method provides information on what type of device the test is running on. This value is - the same as returned by invoking #adb shell getprop ro.product.name.

    -
    -
    Returns
    -
    • product name of the device
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - hasAnyWatcherTriggered - () -

    -
    -
    - - - -
    -
    - - - - -

    Checks if any registered UiWatcher have triggered. - - See registerWatcher(String, UiWatcher) - See hasWatcherTriggered(String)

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - hasObject - (BySelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether there is a match for the given selector criteria.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - hasWatcherTriggered - (String watcherName) -

    -
    -
    - - - -
    -
    - - - - -

    Checks if a specific registered UiWatcher has triggered. - See registerWatcher(String, UiWatcher). If a UiWatcher runs and its - checkForCondition() call returned true, then - the UiWatcher is considered triggered. This is helpful if a watcher is detecting errors - from ANR or crash dialogs and the test needs to know if a UiWatcher has been triggered.

    -
    -
    Returns
    -
    • true if triggered else false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isNaturalOrientation - () -

    -
    -
    - - - -
    -
    - - - - -

    Check if the device is in its natural orientation. This is determined by checking if the - orientation is at 0 or 180 degrees.

    -
    -
    Returns
    -
    • true if it is in natural orientation
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isScreenOn - () -

    -
    -
    - - - -
    -
    - - - - -

    Checks the power manager if the screen is ON.

    -
    -
    Returns
    -
    • true if the screen is ON else false
    -
    -
    -
    Throws
    - - - - - - - -
    - RemoteException
    RemoteException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - openNotification - () -

    -
    -
    - - - -
    -
    - - - - -

    Opens the notification shade.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - openQuickSettings - () -

    -
    -
    - - - -
    -
    - - - - -

    Opens the Quick Settings shade.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - R - - performActionAndWait - (Runnable action, EventCondition<R> condition, long timeout) -

    -
    -
    - - - -
    -
    - - - - -

    Performs the provided action and waits for the condition to be met.

    -
    -
    Parameters
    - - - - - - - - - - -
    action - The Runnable action to perform.
    condition - The EventCondition to evaluate.
    timeout - Maximum amount of time to wait in milliseconds.
    -
    -
    -
    Returns
    -
    • The final result returned by the condition. -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressBack - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the BACK button.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressDPadCenter - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the CENTER button.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressDPadDown - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the DOWN button.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressDPadLeft - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the LEFT button.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressDPadRight - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the RIGHT button.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressDPadUp - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the UP button.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressDelete - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the DELETE key.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressEnter - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the ENTER key.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressHome - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the HOME button.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressKeyCode - (int keyCode, int metaState) -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press using a key code. - - See KeyEvent.

    -
    -
    Parameters
    - - - - - - - -
    keyCode - the key code of the event.
    metaState - an integer in which each bit set to 1 represents a pressed meta key
    -
    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressKeyCode - (int keyCode) -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press using a key code. - - See KeyEvent

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressMenu - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the MENU button.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressRecentApps - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the Recent Apps button.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    -
    -
    Throws
    - - - - - - - -
    - RemoteException
    RemoteException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - pressSearch - () -

    -
    -
    - - - -
    -
    - - - - -

    Simulates a short press on the SEARCH button.

    -
    -
    Returns
    -
    • true if successful, else return false
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - void - - registerWatcher - (String name, UiWatcher watcher) -

    -
    -
    - - - -
    -
    - - - - -

    Registers a UiWatcher to run automatically when the testing framework is unable to - find a match using a UiSelector. See runWatchers()

    -
    -
    Parameters
    - - - - - - - -
    name - to register the UiWatcher
    watcher - UiWatcher
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - void - - removeWatcher - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    Removes a previously registered UiWatcher. - - See registerWatcher(String, UiWatcher)

    -
    -
    Parameters
    - - - - -
    name - used to register the UiWatcher
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - void - - resetWatcherTriggers - () -

    -
    -
    - - - -
    -
    - - - - -

    Resets a UiWatcher that has been triggered. - If a UiWatcher runs and its checkForCondition() call - returned true, then the UiWatcher is considered triggered. - See registerWatcher(String, UiWatcher)

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - runWatchers - () -

    -
    -
    - - - -
    -
    - - - - -

    This method forces all registered watchers to run. - See registerWatcher(String, UiWatcher)

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - setCompressedLayoutHeirarchy - (boolean compressed) -

    -
    -
    - - - -
    -
    - - - - -

    Enables or disables layout hierarchy compression. - - If compression is enabled, the layout hierarchy derived from the Acessibility - framework will only contain nodes that are important for uiautomator - testing. Any unnecessary surrounding layout nodes that make viewing - and searching the hierarchy inefficient are removed.

    -
    -
    Parameters
    - - - - -
    compressed - true to enable compression; else, false to disable
    -
    +
    +

    pressDelete

    +
    +
    + +
    -
    +
    +boolean pressDelete ()
    + + + + +

    Simulates a short press on the DELETE key.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    +
    - - -
    -

    - - public + +
    +

    pressEnter

    +
    +
    + + +
    +
    +boolean pressEnter ()
    + + + + +

    Simulates a short press on the ENTER key.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    - void - - setOrientationLeft - () -

    -
    -
    +
    + -
    -
    +
    +

    pressHome

    +
    +
    + + +
    +
    +boolean pressHome ()
    + + + + +

    Simulates a short press on the HOME button.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    +
    -

    Simulates orienting the device to the left and also freezes rotation - by disabling the sensors. + - If you want to un-freeze the rotation and re-enable the sensors - see unfreezeRotation().

    -
    -
    Throws
    - - - - - - - -
    - RemoteException
    RemoteException -
    -
    +
    +

    pressKeyCode

    +
    +
    + +
    -
    +
    +boolean pressKeyCode (int keyCode)
    + + + + +

    Simulates a short press using a key code. + + See KeyEvent

    + + + + + + + +
    Parameters
    keyCode + int +
    + + + + + + +
    Returns
    booleantrue if successful, else return false
    +
    - -
    -

    - - public + +
    +

    pressKeyCode

    +
    +
    + + +
    +
    +boolean pressKeyCode (int keyCode, 
    +                int metaState)
    + + + + +

    Simulates a short press using a key code. + + See KeyEvent.

    + + + + + + + + + + + +
    Parameters
    keyCode + int: + the key code of the event.
    metaState + int: + an integer in which each bit set to 1 represents a pressed meta key
    + + + + + + +
    Returns
    booleantrue if successful, else return false
    +
    - void -
    - setOrientationNatural - () -

    -
    -
    + +
    +

    pressMenu

    +
    +
    + + -
    -
    +
    +
    +boolean pressMenu ()
    + + + + +

    Simulates a short press on the MENU button.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    +
    + -

    Simulates orienting the device into its natural orientation and also freezes rotation - by disabling the sensors. +

    +

    pressRecentApps

    +
    +
    + + - If you want to un-freeze the rotation and re-enable the sensors - see unfreezeRotation().

    -
    -
    Throws
    - + +
    +boolean pressRecentApps ()
    + + + + +

    Simulates a short press on the Recent Apps button.

    + +
    + + + + + +
    Returns
    booleantrue if successful, else return false
    + + - + + - + +
    Throws
    - RemoteExceptionRemoteException
    RemoteException - RemoteException
    -
    + -
    - - -
    -

    - - public - + +
    +

    pressSearch

    +
    +
    + + +
    +
    +boolean pressSearch ()
    + + + + +

    Simulates a short press on the SEARCH button.

    + + + + + + + +
    Returns
    booleantrue if successful, else return false
    - void - - setOrientationRight - () -

    -
    -
    +
    + -
    -
    +
    +

    registerWatcher

    +
    +
    + + +
    +
    +void registerWatcher (String name, 
    +                UiWatcher watcher)
    + + + + +

    Registers a UiWatcher to run automatically when the testing framework is unable to + find a match using a UiSelector. See runWatchers()

    + + + + + + + + + + + +
    Parameters
    name + String: + to register the UiWatcher
    watcher + UiWatcher: + UiWatcher
    +
    -

    Simulates orienting the device to the right and also freezes rotation - by disabling the sensors. + - If you want to un-freeze the rotation and re-enable the sensors - see unfreezeRotation().

    -
    -
    Throws
    - - - - - - - -
    - RemoteException
    RemoteException -
    -
    +
    +

    removeWatcher

    +
    +
    + +
    -
    - - - - -
    -

    - - public +
    +void removeWatcher (String name)
    + + + + +

    Removes a previously registered UiWatcher. + + See registerWatcher(String, UiWatcher)

    + + + + + + + +
    Parameters
    name + String: + used to register the UiWatcher
    +

    + - void - - sleep - () - -
    -
    +
    +

    resetWatcherTriggers

    +
    +
    + + +
    +
    +void resetWatcherTriggers ()
    + + + + +

    Resets a UiWatcher that has been triggered. + If a UiWatcher runs and its checkForCondition() call + returned true, then the UiWatcher is considered triggered. + See registerWatcher(String, UiWatcher)

    + +
    -
    -
    + +
    +

    runWatchers

    +
    +
    + + +
    +
    +void runWatchers ()
    + + -

    This method simply presses the power button if the screen is ON else - it does nothing if the screen is already OFF.

    -
    -
    Throws
    - - - - - - - -
    - RemoteException
    RemoteException -
    -
    + +

    This method forces all registered watchers to run. + See registerWatcher(String, UiWatcher)

    + -
    - - -
    -

    - - public + +
    +

    setCompressedLayoutHeirarchy

    +
    +
    + + +
    +
    +void setCompressedLayoutHeirarchy (boolean compressed)
    + + + +

    Enables or disables layout hierarchy compression. - boolean - - swipe - (Point[] segments, int segmentSteps) -

    -
    -
    + If compression is enabled, the layout hierarchy derived from the Acessibility + framework will only contain nodes that are important for uiautomator + testing. Any unnecessary surrounding layout nodes that make viewing + and searching the hierarchy inefficient are removed.

    + + + + + + + +
    Parameters
    compressed + boolean: + true to enable compression; else, false to disable
    +
    -
    -
    + +
    +

    setOrientationLeft

    +
    +
    + + +
    +
    +void setOrientationLeft ()
    + + + +

    Simulates orienting the device to the left and also freezes rotation + by disabling the sensors. -

    Performs a swipe between points in the Point array. Each step execution is throttled - to 5ms per step. So for a 100 steps, the swipe will take about 1/2 second to complete

    -
    -
    Parameters
    - + If you want to un-freeze the rotation and re-enable the sensors + see unfreezeRotation().

    + +
    + - + + - + +
    Throws
    segments - is Point array containing at least one Point objectRemoteException
    segmentSteps - steps to inject between two PointsRemoteException
    -
    -
    -
    Returns
    -
    • true on success
    -
    + -
    - - -
    -

    - - public - - - - - boolean - - swipe - (int startX, int startY, int endX, int endY, int steps) -

    -
    -
    - - - -
    -
    + +
    +

    setOrientationNatural

    +
    +
    + + +
    +
    +void setOrientationNatural ()
    + + + +

    Simulates orienting the device into its natural orientation and also freezes rotation + by disabling the sensors. -

    Performs a swipe from one coordinate to another using the number of steps - to determine smoothness and speed. Each step execution is throttled to 5ms - per step. So for a 100 steps, the swipe will take about 1/2 second to complete.

    -
    -
    Parameters
    - + If you want to un-freeze the rotation and re-enable the sensors + see unfreezeRotation().

    + +
    + + + + + - + +
    Throws
    RemoteException
    steps - is the number of move steps sent to the systemRemoteException
    -
    -
    -
    Returns
    -
    • false if the operation fails or the coordinates are invalid
    -
    + -
    - - -
    -

    - - public - - - - - boolean - - takeScreenshot - (File storePath) -

    -
    -
    - - - -
    -
    - + +
    +

    setOrientationRight

    +
    +
    + + +
    +
    +void setOrientationRight ()
    + + -

    Take a screenshot of current window and store it as PNG + +

    Simulates orienting the device to the right and also freezes rotation + by disabling the sensors. - Default scale of 1.0f (original size) and 90% quality is used - The screenshot is adjusted per screen rotation

    -
    -
    Parameters
    - + If you want to un-freeze the rotation and re-enable the sensors + see unfreezeRotation().

    + +
    + + + + + - + +
    Throws
    RemoteException
    storePath - where the PNG should be written toRemoteException
    -
    -
    -
    Returns
    -
    • true if screen shot is created successfully, false otherwise
    -
    + -
    - - -
    -

    - - public - - - - - boolean - - takeScreenshot - (File storePath, float scale, int quality) -

    -
    -
    - - - -
    -
    - - - + -

    Take a screenshot of current window and store it as PNG +

    +

    sleep

    +
    +
    + + - The screenshot is adjusted per screen rotation

    -
    -
    Parameters
    - - - - + +
    +void sleep ()
    + + + + +

    This method simply presses the power button if the screen is ON else + it does nothing if the screen is already OFF.

    + +
    storePath - where the PNG should be written to
    + - + + - + +
    Throws
    scale - scale the screenshot down if needed; 1.0f for original sizeRemoteException
    quality - quality of the PNG compression; range: 0-100RemoteException
    -
    -
    -
    Returns
    -
    • true if screen shot is created successfully, false otherwise
    -
    + -
    - - -
    -

    - - public + +
    +

    swipe

    +
    +
    + + +
    +
    +boolean swipe (int startX, 
    +                int startY, 
    +                int endX, 
    +                int endY, 
    +                int steps)
    + + + + +

    Performs a swipe from one coordinate to another using the number of steps + to determine smoothness and speed. Each step execution is throttled to 5ms + per step. So for a 100 steps, the swipe will take about 1/2 second to complete.

    + + + + + + + +
    Parameters
    steps + int: + is the number of move steps sent to the system
    + + + + + + +
    Returns
    booleanfalse if the operation fails or the coordinates are invalid
    +
    - void -
    - unfreezeRotation - () -

    -
    -
    + +
    +

    swipe

    +
    +
    + + -
    -
    +
    +
    +boolean swipe (Point[] segments, 
    +                int segmentSteps)
    + + + + +

    Performs a swipe between points in the Point array. Each step execution is throttled + to 5ms per step. So for a 100 steps, the swipe will take about 1/2 second to complete

    + + + + + + + + + + + +
    Parameters
    segments + Point: + is Point array containing at least one Point object
    segmentSteps + int: + steps to inject between two Points
    + + + + + + +
    Returns
    booleantrue on success
    +
    + -

    Re-enables the sensors and un-freezes the device rotation allowing its contents - to rotate with the device physical rotation. During a test execution, it is best to - keep the device frozen in a specific orientation until the test case execution has completed.

    -
    -
    Throws
    - - - - -
    RemoteException -
    -
    +
    +

    takeScreenshot

    +
    +
    + +
    -
    - +
    +boolean takeScreenshot (File storePath, 
    +                float scale, 
    +                int quality)
    + + + + +

    Take a screenshot of current window and store it as PNG + + The screenshot is adjusted per screen rotation

    + + + + + + + + + + + + + + + +
    Parameters
    storePath + File: + where the PNG should be written to
    scale + float: + scale the screenshot down if needed; 1.0f for original size
    quality + int: + quality of the PNG compression; range: 0-100
    + + + + + + +
    Returns
    booleantrue if screen shot is created successfully, false otherwise
    - +
    -
    -

    - - public + +
    +

    takeScreenshot

    +
    +
    + + +
    +
    +boolean takeScreenshot (File storePath)
    + + - R - - wait - (SearchCondition<R> condition, long timeout) -

    -
    -
    + +

    Take a screenshot of current window and store it as PNG + Default scale of 1.0f (original size) and 90% quality is used + The screenshot is adjusted per screen rotation

    + + + + + + + +
    Parameters
    storePath + File: + where the PNG should be written to
    + + + + + + +
    Returns
    booleantrue if screen shot is created successfully, false otherwise
    +
    -
    -
    + +
    +

    unfreezeRotation

    +
    +
    + + +
    +
    +void unfreezeRotation ()
    + + -

    Waits for given the condition to be met.

    -
    -
    Parameters
    - - - - + +

    Re-enables the sensors and un-freezes the device rotation allowing its contents + to rotate with the device physical rotation. During a test execution, it is best to + keep the device frozen in a specific orientation until the test case execution has completed.

    +
    condition - The SearchCondition to evaluate.
    + - + +
    Throws
    timeout - Maximum amount of time to wait in milliseconds.RemoteException
    -
    -
    -
    Returns
    -
    • The final result returned by the condition. -
    -
    + -
    - - -
    -

    - - public - - - - - void - - waitForIdle - (long timeout) -

    -
    -
    - + +
    +

    wait

    +
    +
    + + -
    -
    +
    +
    +R wait (SearchCondition<R> condition, 
    +                long timeout)
    + + + + +

    Waits for given the condition to be met.

    + + + + + + + + + + +
    Parameters
    condition + SearchCondition: + The SearchCondition to evaluate.
    timeout + long: + Maximum amount of time to wait in milliseconds.
    + + + + + + +
    Returns
    RThe final result returned by the condition. +
    +
    + -

    Waits for the current application to idle.

    -
    -
    Parameters
    - - - - -
    timeout - in milliseconds
    -
    +
    +

    waitForIdle

    +
    +
    + +
    +
    +void waitForIdle (long timeout)
    + + + + +

    Waits for the current application to idle.

    + + + + + + + +
    Parameters
    timeout + long: + in milliseconds
    +
    -
    -

    - - public - - - - - void - - waitForIdle - () -

    -
    -
    - - - -
    -
    - - +
    +

    waitForIdle

    +
    +
    + + +
    +
    +void waitForIdle ()
    + + -

    Waits for the current application to idle. - Default wait timeout is 10 seconds

    + +

    Waits for the current application to idle. + Default wait timeout is 10 seconds

    + -
    -
    -

    - - public - - - - - boolean - - waitForWindowUpdate - (String packageName, long timeout) -

    -
    -
    - - - -
    -
    - - +
    +

    waitForWindowUpdate

    +
    +
    + + +
    +
    +boolean waitForWindowUpdate (String packageName, 
    +                long timeout)
    + + -

    Waits for a window content update event to occur. + +

    Waits for a window content update event to occur. If a package name for the window is specified, but the current window - does not have the same package name, the function returns immediately.

    -
    -
    Parameters
    - - - + + + + +
    packageName - the specified window package name (can be null). + does not have the same package name, the function returns immediately.

    + + + + + + - - - - -
    Parameters
    packageName + String: + the specified window package name (can be null). If null, a window update from any front-end window will end the wait
    timeout - the timeout for the wait
    - -
    -
    Returns
    -
    • true if a window update occurred, false if timeout has elapsed or if the current - window does not have the specified package name
    -
    +
    timeout + long: + the timeout for the wait
    + + + + + + +
    Returns
    booleantrue if a window update occurred, false if timeout has elapsed or if the current + window does not have the specified package name
    -
    -
    -

    - - public - - - - - void - - wakeUp - () -

    -
    -
    - - - -
    -
    - - +
    +

    wakeUp

    +
    +
    + + +
    +
    +void wakeUp ()
    + + -

    This method simulates pressing the power button if the screen is OFF else + +

    This method simulates pressing the power button if the screen is OFF else it does nothing if the screen is already ON. If the screen was OFF and it just got turned ON, this method will insert a 500ms delay - to allow the device time to wake up and accept input.

    -
    -
    Throws
    - + to allow the device time to wake up and accept input.

    + +
    + - + + - + +
    Throws
    - RemoteExceptionRemoteException
    RemoteException - RemoteException
    -
    + -
    @@ -5045,193 +4498,59 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/uiautomator/UiObject.html b/docs/html/reference/android/support/test/uiautomator/UiObject.html index f1149dda4e6c..57536e5d6d69 100644 --- a/docs/html/reference/android/support/test/uiautomator/UiObject.html +++ b/docs/html/reference/android/support/test/uiautomator/UiObject.html @@ -1,5 +1,3 @@ - - @@ -92,513 +90,87 @@ - - - - - - - -UiObject | Android Developers - - - - - - - - - - - - - - - - - - - -
    - + - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - -
    - - -
    - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    UiObject

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    UiObject

    +

    + + public + + + + class + UiObject + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.uiautomator.UiObject
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.uiautomator.UiObject +
    - - - - -
    - + +
    + Known Direct Subclasses - +
    -
    - - - - +
    - +
    + + +
    + Known Indirect Subclasses - +
    -
    +
    + -
    +

    -

    Class Overview

    -

    A UiObject is a representation of a view. It is not in any way directly bound to a +

    A UiObject is a representation of a view. It is not in any way directly bound to a view as an object reference. A UiObject contains information to help it - locate a matching view at runtime based on the UiSelector properties specified in + locate a matching view at runtime based on the UiSelector properties specified in its constructor. Once you create an instance of a UiObject, it can be reused for different views that match the selector criteria.

    @@ -797,9 +361,9 @@ Summary: -
    +

    Summary

    @@ -813,11 +377,94 @@ Summary: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -
    +

    Constants

    int + FINGER_TOUCH_HALF_WIDTH +

    + + +

    +
    int + SWIPE_MARGIN_LIMIT +

    + + +

    +
    long + WAIT_FOR_EVENT_TMEOUT +

    + This constant is deprecated. + use setScrollAcknowledgmentTimeout(long) + + + +

    +
    long + WAIT_FOR_SELECTOR_POLL +

    + + +

    +
    long + WAIT_FOR_SELECTOR_TIMEOUT +

    + This constant is deprecated. + use setWaitForSelectorTimeout(long) + + + +

    +
    long + WAIT_FOR_WINDOW_TMEOUT +

    + + +

    +
    -

    Summary

    @@ -828,3988 +475,3729 @@ Summary: + + + - -

    Public constructors

    + + + + + + + +
    Constants
    + + UiObject(UiSelector selector) + + +

    + This constructor is deprecated. + Use findObject(UiSelector) instead. This version hides + UiObject's dependency on UiDevice and is prone to misuse. + + +

    + +
    - - int - FINGER_TOUCH_HALF_WIDTH - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - -

    Public methods

    + + + + + + void + + + clearTextField() + + +

    Clears the existing text contents in an editable field. + + +

    + +
    + + + + + + boolean + + + click() + + +

    Performs a click at the center of the visible bounds of the UI element represented + by this UiObject. + + +

    + +
    + + + + + + boolean + + + clickAndWaitForNewWindow() + + +

    Waits for window transitions that would typically take longer than the + usual default timeouts. + + +

    + +
    + + + + + + boolean + + + clickAndWaitForNewWindow(long timeout) + + +

    Performs a click at the center of the visible bounds of the UI element represented + by this UiObject and waits for window transitions. + + +

    + +
    + + + + + + boolean + + + clickBottomRight() + + +

    Clicks the bottom and right corner of the UI element + + +

    + +
    + + + + + + boolean + + + clickTopLeft() + + +

    Clicks the top and left corner of the UI element + + +

    + +
    + + + + + + boolean + + + dragTo(UiObject destObj, int steps) + + +

    Drags this object to a destination UiObject. + + +

    + +
    + + + + + + boolean + + + dragTo(int destX, int destY, int steps) + + +

    Drags this object to arbitrary coordinates. + + +

    + +
    + + + + + + boolean + + + exists() + + +

    Check if view exists. + + +

    + +
    + + + + + + Rect + + + getBounds() + + +

    Returns the view's bounds property. + + +

    + +
    + + + + + + UiObject + + + getChild(UiSelector selector) + + +

    Creates a new UiObject for a child view that is under the present UiObject. + + +

    + +
    + + + + + + int + + + getChildCount() + + +

    Counts the child views immediately under the present UiObject. + + +

    + +
    + + + + + + String + + + getClassName() + + +

    Retrieves the className property of the UI element. + + +

    + +
    + + + + + + String + + + getContentDescription() + + +

    Reads the content_desc property of the UI element + + +

    + +
    + + + + + + UiObject + + + getFromParent(UiSelector selector) + + +

    Creates a new UiObject for a sibling view or a child of the sibling view, + relative to the present UiObject. + + +

    + +
    + + + + + + String + + + getPackageName() + + +

    Reads the view's package property + + +

    + +
    + + + + final + + UiSelector + + + getSelector() + + +

    Debugging helper. + + +

    + +
    + + + + + + String + + + getText() + + +

    Reads the text property of the UI element + + +

    + +
    + + + + + + Rect + + + getVisibleBounds() + + +

    Returns the visible bounds of the view. + + +

    + +
    + + + + + + boolean + + + isCheckable() + + +

    Checks if the UI element's checkable property is currently true. + + +

    + +
    + + + + + + boolean + + + isChecked() + + +

    Check if the UI element's checked property is currently true + + +

    + +
    + + + + + + boolean + + + isClickable() + + +

    Checks if the UI element's clickable property is currently true. + + +

    + +
    + + + + + + boolean + + + isEnabled() + + +

    Checks if the UI element's enabled property is currently true. + + +

    + +
    + + + + + + boolean + + + isFocusable() + + +

    Check if the UI element's focusable property is currently true. + + +

    + +
    + + + + + + boolean + + + isFocused() + + +

    Check if the UI element's focused property is currently true + + +

    + +
    + + + + + + boolean + + + isLongClickable() + + +

    Check if the view's long-clickable property is currently true + + +

    + +
    + + + + + + boolean + + + isScrollable() + + +

    Check if the view's scrollable property is currently true + + +

    + +
    + + + + + + boolean + + + isSelected() + + +

    Checks if the UI element's selected property is currently true. + + +

    + +
    + + + + + + boolean + + + longClick() + + +

    Long clicks the center of the visible bounds of the UI element + + +

    + +
    + + + + + + boolean + + + longClickBottomRight() + + +

    Long clicks bottom and right corner of the UI element + + +

    + +
    + + + + + + boolean + + + longClickTopLeft() + + +

    Long clicks on the top and left corner of the UI element + + +

    + +
    + + + + + + boolean + + + performMultiPointerGesture(PointerCoords... touches) + + +

    Performs a multi-touch gesture. + + +

    + +
    + + + + + + boolean + + + performTwoPointerGesture(Point startPoint1, Point startPoint2, Point endPoint1, Point endPoint2, int steps) + + +

    Generates a two-pointer gesture with arbitrary starting and ending points. + + +

    + +
    + + + + + + boolean + + + pinchIn(int percent, int steps) + + +

    Performs a two-pointer gesture, where each pointer moves diagonally + toward the other, from the edges to the center of this UiObject . + + +

    + +
    + + + + + + boolean + + + pinchOut(int percent, int steps) + + +

    Performs a two-pointer gesture, where each pointer moves diagonally + opposite across the other, from the center out towards the edges of the + this UiObject. + + +

    + +
    + + + + + + boolean + + + setText(String text) + + +

    Sets the text in an editable field, after clearing the field's content. + + +

    + +
    + + + + + + boolean + + + swipeDown(int steps) + + +

    Performs the swipe down action on the UiObject. + + +

    + +
    + + + + + + boolean + + + swipeLeft(int steps) + + +

    Performs the swipe left action on the UiObject. + + +

    + +
    + + + + + + boolean + + + swipeRight(int steps) + + +

    Performs the swipe right action on the UiObject. + + +

    + +
    + + + + + + boolean + + + swipeUp(int steps) + + +

    Performs the swipe up action on the UiObject. + + +

    + +
    + + + + + + boolean + + + waitForExists(long timeout) + + +

    Waits a specified length of time for a view to become visible. + + +

    + +
    + + + + + + boolean + + + waitUntilGone(long timeout) + + +

    Waits a specified length of time for a view to become undetectable. + + +

    + +
    intSWIPE_MARGIN_LIMIT +
    - - + + + + + + + + + + + + + + + - - - -

    Protected methods

    + + + + + + AccessibilityNodeInfo + + + findAccessibilityNodeInfo(long timeout) + + +

    Finds a matching UI element in the accessibility hierarchy, by + using the selector for this UiObject. + + +

    + +
    longWAIT_FOR_EVENT_TMEOUT - - This constant is deprecated. - use setScrollAcknowledgmentTimeout(long) - +
    - - - - long - WAIT_FOR_SELECTOR_POLL - + + + + + - + From +class + + + java.lang.Object + + +
    + +

    Inherited methods

    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + Object + + + clone() + + +
    + + + + + + boolean + + + equals(Object arg0) + + +
    + + + + + + void + + + finalize() + + +
    + + + + final + + Class<?> + + + getClass() + + +
    + + + + + + int + + + hashCode() + + +
    + + + + final + + void + + + notify() + + +
    + + + + final + + void + + + notifyAll() + + +
    + + + + + + String + + + toString() + + +
    + + + + final + + void + + + wait(long arg0, int arg1) + + +
    + + + + final + + void + + + wait(long arg0) + + +
    + + + + final + + void + + + wait() + + +
    +
    +
    + - - long - WAIT_FOR_SELECTOR_TIMEOUT - - - This constant is deprecated. - use setWaitForSelectorTimeout(long) - + - - + - - long - WAIT_FOR_WINDOW_TMEOUT - + + - - + +

    Constants

    - + +
    +

    FINGER_TOUCH_HALF_WIDTH

    +
    + + + +
    +
    +int FINGER_TOUCH_HALF_WIDTH
    + + + + +

    + + +

    Constant Value: + + 20 + (0x00000014) + + +

    + +
    +

    SWIPE_MARGIN_LIMIT

    +
    + + + +
    +
    +int SWIPE_MARGIN_LIMIT
    + + + + +

    + + +

    Constant Value: + + 5 + (0x00000005) + + +

    + - - +
    +

    WAIT_FOR_EVENT_TMEOUT

    +
    + + + +
    +
    +long WAIT_FOR_EVENT_TMEOUT
    + + +

    +

    + This constant is deprecated.
    + use setScrollAcknowledgmentTimeout(long) +

    +

    + + +

    Constant Value: + + 3000 + (0x0000000000000bb8) + + +

    - - - +

    +

    + This constant is deprecated.
    + use setWaitForSelectorTimeout(long) +

    +

    + + +

    Constant Value: + + 10000 + (0x0000000000002710) + + + -

    Public Constructors
    + +
    +

    WAIT_FOR_SELECTOR_POLL

    +
    + + + +
    +
    +long WAIT_FOR_SELECTOR_POLL
    + + + + +

    + + +

    Constant Value: + + 1000 + (0x00000000000003e8) + + +

    -
    -
    - UiObject(UiSelector selector) -
    - - This constructor is deprecated. - Use findObject(UiSelector) instead. This version hides - UiObject's dependency on UiDevice and is prone to misuse. + +
    +

    WAIT_FOR_SELECTOR_TIMEOUT

    +
    + + + -
    +
    +
    +long WAIT_FOR_SELECTOR_TIMEOUT
    + + -
    + +
    +

    WAIT_FOR_WINDOW_TMEOUT

    +
    + + + +
    +
    +long WAIT_FOR_WINDOW_TMEOUT
    + + + + +

    + + +

    Constant Value: + + 5500 + (0x000000000000157c) + + +

    - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Methods
    + +

    Public constructors

    + - void
    -
    - clearTextField() +
    +

    UiObject

    +
    +
    + + -
    - Clears the existing text contents in an editable field. +
    +
    +UiObject (UiSelector selector)
    + + +

    +

    + This constructor is deprecated.
    + Use findObject(UiSelector) instead. This version hides + UiObject's dependency on UiDevice and is prone to misuse. +

    +

    Constructs a UiObject to represent a view that matches the specified + selector criteria.

    + +
    -
    -
    - - - - - - boolean - - click() - -
    - Performs a click at the center of the visible bounds of the UI element represented - by this UiObject. - - - -
    - -
    - - - - - - boolean - - clickAndWaitForNewWindow(long timeout) - -
    - Performs a click at the center of the visible bounds of the UI element represented - by this UiObject and waits for window transitions. - - - -
    - -
    - - - - - - boolean - - clickAndWaitForNewWindow() - -
    - Waits for window transitions that would typically take longer than the - usual default timeouts. - - - -
    - -
    - - - - - - boolean - - clickBottomRight() - -
    - Clicks the bottom and right corner of the UI element - - - -
    - -
    - - - - - - boolean - - clickTopLeft() - -
    - Clicks the top and left corner of the UI element - - - -
    - -
    - - - - - - boolean - - dragTo(UiObject destObj, int steps) - -
    - Drags this object to a destination UiObject. - - - -
    - -
    - - - - - - boolean - - dragTo(int destX, int destY, int steps) - -
    - Drags this object to arbitrary coordinates. - - - -
    - -
    - - - - - - boolean - - exists() - -
    - Check if view exists. - - - -
    - -
    - - - - - - Rect - - getBounds() - -
    - Returns the view's bounds property. - - - -
    - -
    - - - - - - UiObject - - getChild(UiSelector selector) - -
    - Creates a new UiObject for a child view that is under the present UiObject. - - - -
    - -
    - - - - - - int - - getChildCount() - -
    - Counts the child views immediately under the present UiObject. - - - -
    - -
    - - - - - - String - - getClassName() - -
    - Retrieves the className property of the UI element. - - - -
    - -
    - - - - - - String - - getContentDescription() - -
    - Reads the content_desc property of the UI element - - - -
    - -
    - - - - - - UiObject - - getFromParent(UiSelector selector) - -
    - Creates a new UiObject for a sibling view or a child of the sibling view, - relative to the present UiObject. - - - -
    - -
    - - - - - - String - - getPackageName() - -
    - Reads the view's package property - - - -
    - -
    - - - final - - - UiSelector - - getSelector() - -
    - Debugging helper. - - - -
    - -
    - - - - - - String - - getText() - -
    - Reads the text property of the UI element - - - -
    - -
    - - - - - - Rect - - getVisibleBounds() - -
    - Returns the visible bounds of the view. - - - -
    - -
    - - - - - - boolean - - isCheckable() - -
    - Checks if the UI element's checkable property is currently true. - - - -
    - -
    - - - - - - boolean - - isChecked() - -
    - Check if the UI element's checked property is currently true - - - -
    - -
    - - - - - - boolean - - isClickable() - -
    - Checks if the UI element's clickable property is currently true. - - - -
    - -
    - - - - - - boolean - - isEnabled() - -
    - Checks if the UI element's enabled property is currently true. - - - -
    - -
    - - - - - - boolean - - isFocusable() - -
    - Check if the UI element's focusable property is currently true. - - - -
    - -
    - - - - - - boolean - - isFocused() - -
    - Check if the UI element's focused property is currently true - - - -
    - -
    - - - - - - boolean - - isLongClickable() - -
    - Check if the view's long-clickable property is currently true - - - -
    - -
    - - - - - - boolean - - isScrollable() - -
    - Check if the view's scrollable property is currently true - - - -
    - -
    - - - - - - boolean - - isSelected() - -
    - Checks if the UI element's selected property is currently true. - - - -
    - -
    - - - - - - boolean - - longClick() - -
    - Long clicks the center of the visible bounds of the UI element - - - -
    - -
    - - - - - - boolean - - longClickBottomRight() - -
    - Long clicks bottom and right corner of the UI element - - - -
    - -
    - - - - - - boolean - - longClickTopLeft() - -
    - Long clicks on the top and left corner of the UI element - - - -
    - -
    - - - - - - boolean - - performMultiPointerGesture(PointerCoords... touches) - -
    - Performs a multi-touch gesture. - - - -
    - -
    - - - - - - boolean - - performTwoPointerGesture(Point startPoint1, Point startPoint2, Point endPoint1, Point endPoint2, int steps) - -
    - Generates a two-pointer gesture with arbitrary starting and ending points. - - - -
    - -
    - - - - - - boolean - - pinchIn(int percent, int steps) - -
    - Performs a two-pointer gesture, where each pointer moves diagonally - toward the other, from the edges to the center of this UiObject . - - - -
    - -
    - - - - - - boolean - - pinchOut(int percent, int steps) - -
    - Performs a two-pointer gesture, where each pointer moves diagonally - opposite across the other, from the center out towards the edges of the - this UiObject. - - - -
    - -
    - - - - - - boolean - - setText(String text) - -
    - Sets the text in an editable field, after clearing the field's content. - - - -
    - -
    - - - - - - boolean - - swipeDown(int steps) - -
    - Performs the swipe down action on the UiObject. - - - -
    - -
    - - - - - - boolean - - swipeLeft(int steps) - -
    - Performs the swipe left action on the UiObject. - - - -
    - -
    - - - - - - boolean - - swipeRight(int steps) - -
    - Performs the swipe right action on the UiObject. - - - -
    - -
    - - - - - - boolean - - swipeUp(int steps) - -
    - Performs the swipe up action on the UiObject. - - - -
    - -
    - - - - - - boolean - - waitForExists(long timeout) - -
    - Waits a specified length of time for a view to become visible. - - - -
    - -
    - - - - - - boolean - - waitUntilGone(long timeout) - -
    - Waits a specified length of time for a view to become undetectable. - - - -
    - -
    - - - - - - - - - - - - - - - - -
    Protected Methods
    - - - - - - AccessibilityNodeInfo - - findAccessibilityNodeInfo(long timeout) - -
    - Finds a matching UI element in the accessibility hierarchy, by - using the selector for this UiObject. - - - -
    - -
    - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - -

    Constants

    - - - - - - -
    -

    - - protected - static - final - int - - FINGER_TOUCH_HALF_WIDTH -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - 20 - (0x00000014) - - -
    - -
    -
    - - - - - -
    -

    - - protected - static - final - int - - SWIPE_MARGIN_LIMIT -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - 5 - (0x00000005) - - -
    - -
    -
    - - - - - -
    -

    - - protected - static - final - long - - WAIT_FOR_EVENT_TMEOUT -

    -
    - - - - -
    -
    - - - -

    -

    - This constant is deprecated.
    - use setScrollAcknowledgmentTimeout(long) - -

    -

    - - -
    - Constant Value: - - - 3000 - (0x0000000000000bb8) - - -
    - -
    -
    - - - - - -
    -

    - - protected - static - final - long - - WAIT_FOR_SELECTOR_POLL -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - 1000 - (0x00000000000003e8) - - -
    - -
    -
    - - - - - -
    -

    - - protected - static - final - long - - WAIT_FOR_SELECTOR_TIMEOUT -

    -
    - - - - -
    -
    - - - -

    -

    - This constant is deprecated.
    - use setWaitForSelectorTimeout(long) - -

    -

    - - -
    - Constant Value: - - - 10000 - (0x0000000000002710) - - -
    - -
    -
    - - - - - -
    -

    - - protected - static - final - long - - WAIT_FOR_WINDOW_TMEOUT -

    -
    - - - - -
    -
    - - - - -

    - - -
    - Constant Value: - - - 5500 - (0x000000000000157c) - - -
    - -
    -
    - - - - - - - - - - - -

    Public Constructors

    - - - - - -
    -

    - - public - - - - - - - UiObject - (UiSelector selector) -

    -
    -
    - - - -
    -
    - - - -

    -

    - This constructor is deprecated.
    - Use findObject(UiSelector) instead. This version hides - UiObject's dependency on UiDevice and is prone to misuse. -

    -

    Constructs a UiObject to represent a view that matches the specified - selector criteria.

    - -
    -
    - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - - - - - void - - clearTextField - () -

    -
    -
    - - - -
    -
    - - - - -

    Clears the existing text contents in an editable field. - - The UiSelector of this object must reference a UI element that is editable. - - When you call this method, the method sets focus on the editable field, selects all of its - existing content, and clears it by sending a DELETE key press

    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - click - () -

    -
    -
    - - - -
    -
    - - - - -

    Performs a click at the center of the visible bounds of the UI element represented - by this UiObject.

    -
    -
    Returns
    -
    • true id successful else false
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - clickAndWaitForNewWindow - (long timeout) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a click at the center of the visible bounds of the UI element represented - by this UiObject and waits for window transitions. - - This method differ from click() only in that this method waits for a - a new window transition as a result of the click. Some examples of a window transition: -

  • launching a new activity
  • -
  • bringing up a pop-up menu
  • -
  • bringing up a dialog
  • -
    -
    Parameters
    - - - - -
    timeout - timeout before giving up on waiting for a new window
    -
    -
    -
    Returns
    -
    • true if the event was triggered, else false
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - clickAndWaitForNewWindow - () -

    -
    -
    - - - -
    -
    - - - - -

    Waits for window transitions that would typically take longer than the - usual default timeouts. - See clickAndWaitForNewWindow(long)

    -
    -
    Returns
    -
    • true if the event was triggered, else false
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - clickBottomRight - () -

    -
    -
    - - - -
    -
    - - - - -

    Clicks the bottom and right corner of the UI element

    -
    -
    Returns
    -
    • true on success
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - clickTopLeft - () -

    -
    -
    - - - -
    -
    - - - - -

    Clicks the top and left corner of the UI element

    -
    -
    Returns
    -
    • true on success
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - dragTo - (UiObject destObj, int steps) -

    -
    -
    - - - -
    -
    - - - - -

    Drags this object to a destination UiObject. - The number of steps specified in your input parameter can influence the - drag speed, and varying speeds may impact the results. Consider - evaluating different speeds when using this method in your tests.

    -
    -
    Parameters
    - - - - - - - -
    destObj - the destination UiObject.
    steps - usually 40 steps. You can increase or decrease the steps to change the speed.
    -
    -
    -
    Returns
    -
    • true if successful
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - dragTo - (int destX, int destY, int steps) -

    -
    -
    - - - -
    -
    - - - - -

    Drags this object to arbitrary coordinates. - The number of steps specified in your input parameter can influence the - drag speed, and varying speeds may impact the results. Consider - evaluating different speeds when using this method in your tests.

    -
    -
    Parameters
    - - - - - - - - - - -
    destX - the X-axis coordinate.
    destY - the Y-axis coordinate.
    steps - usually 40 steps. You can increase or decrease the steps to change the speed.
    -
    -
    -
    Returns
    -
    • true if successful
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - exists - () -

    -
    -
    - - - -
    -
    - - - - -

    Check if view exists. - - This methods performs a waitForExists(long) with zero timeout. This - basically returns immediately whether the view represented by this UiObject - exists or not. If you need to wait longer for this view, then see - waitForExists(long).

    -
    -
    Returns
    -
    • true if the view represented by this UiObject does exist
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - Rect - - getBounds - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the view's bounds property. See getVisibleBounds()

    -
    -
    Returns
    -
    • Rect
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiObject - - getChild - (UiSelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Creates a new UiObject for a child view that is under the present UiObject.

    -
    -
    Parameters
    - - - - -
    selector - for child view to match
    -
    -
    -
    Returns
    -
    • a new UiObject representing the child view
    -
    -
    -
    Throws
    - - - - -
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - int - - getChildCount - () -

    -
    -
    - - - -
    -
    - - - - -

    Counts the child views immediately under the present UiObject.

    -
    -
    Returns
    -
    • the count of child views.
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public + + - String - - getClassName - () -

    -
    -
    + + -
    -
    +

    Public methods

    + -

    Retrieves the className property of the UI element.

    -
    -
    Returns
    -
    • class name of the current node represented by this UiObject
    -
    -
    -
    Throws
    - - - - -
    UiObjectNotFoundException - if no match was found
    -
    +
    +

    clearTextField

    +
    +
    + +
    -
    - - - - -
    -

    - - public - - - - - String - - getContentDescription - () -

    -
    -
    - - - -
    -
    +
    +void clearTextField ()
    + + + +

    Clears the existing text contents in an editable field. + The UiSelector of this object must reference a UI element that is editable. - -

    Reads the content_desc property of the UI element

    -
    -
    Returns
    -
    • value of node attribute "content_desc"
    -
    -
    -
    Throws
    - + When you call this method, the method sets focus on the editable field, selects all of its + existing content, and clears it by sending a DELETE key press

    + +
    + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - - -
    -

    - - public - - - - - UiObject - - getFromParent - (UiSelector selector) -

    -
    -
    - - - -
    -
    - - - + -

    Creates a new UiObject for a sibling view or a child of the sibling view, - relative to the present UiObject.

    -
    -
    Parameters
    - - - - -
    selector - for a sibling view or children of the sibling view
    -
    -
    -
    Returns
    -
    • a new UiObject representing the matched view
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    +
    +

    click

    +
    +
    + +
    -
    - - - - -
    -

    - - public - - - - - String - - getPackageName - () -

    -
    -
    - - - -
    -
    - - - - -

    Reads the view's package property

    -
    -
    Returns
    -
    • true if it is else false
    -
    -
    -
    Throws
    - - - - +
    +boolean click ()
    + + + + +

    Performs a click at the center of the visible bounds of the UI element represented + by this UiObject.

    + +
    - UiObjectNotFoundException
    + + + + + +
    Returns
    booleantrue id successful else false
    + + - + + -
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    - -
    -
    - - - - -
    -

    - - public - - final - - - UiSelector - - getSelector - () -

    -
    -
    - - - -
    -
    - - - - -

    Debugging helper. A test can dump the properties of a selector as a string - to its logs if needed. getSelector().toString();

    -
    -
    Returns
    - -
    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getText - () -

    -
    -
    - - - -
    -
    - - - - -

    Reads the text property of the UI element

    -
    -
    Returns
    -
    • text value of the current node represented by this UiObject
    -
    -
    -
    Throws
    - - + +
    UiObjectNotFoundException - if no match could be foundUiObjectNotFoundException
    -
    + -
    - - -
    -

    - - public - - - - - Rect - - getVisibleBounds - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the visible bounds of the view. + - If a portion of the view is visible, only the bounds of the visible portion are - reported.

    -
    -
    Returns
    -
    • Rect
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    -
    -
    See Also
    - -
    +
    +

    clickAndWaitForNewWindow

    +
    +
    + +
    -
    - - - - -
    -

    - - public - +
    +boolean clickAndWaitForNewWindow ()
    + + - - - boolean -
    - isCheckable - () -

    -
    -
    - - - -
    -
    - - - - -

    Checks if the UI element's checkable property is currently true.

    -
    -
    Returns
    -
    • true if it is else false
    -
    -
    -
    Throws
    - - - - + +

    Waits for window transitions that would typically take longer than the + usual default timeouts. + See clickAndWaitForNewWindow(long)

    + +
    - UiObjectNotFoundException
    + + + + + +
    Returns
    booleantrue if the event was triggered, else false
    + + - + + -
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isChecked - () -

    -
    -
    - - - -
    -
    - - - - -

    Check if the UI element's checked property is currently true

    -
    -
    Returns
    -
    • true if it is else false
    -
    - + -
    - - -
    -

    - - public - - - - - boolean - - isClickable - () -

    -
    -
    - - - -
    -
    - - - + -

    Checks if the UI element's clickable property is currently true.

    -
    -
    Returns
    -
    • true if it is else false
    -
    -
    -
    Throws
    - - - - - - - -
    - UiObjectNotFoundException
    UiObjectNotFoundException -
    -
    +
    +

    clickAndWaitForNewWindow

    +
    +
    + +
    -
    - - - - -
    -

    - - public - - - - - boolean - - isEnabled - () -

    -
    -
    - - - -
    -
    - - +
    +boolean clickAndWaitForNewWindow (long timeout)
    + + + +

    Performs a click at the center of the visible bounds of the UI element represented + by this UiObject and waits for window transitions. -

    Checks if the UI element's enabled property is currently true.

    -
    -
    Returns
    -
    • true if it is else false
    -
    -
    -
    Throws
    - + This method differ from click() only in that this method waits for a + a new window transition as a result of the click. Some examples of a window transition: +
  • launching a new activity
  • +
  • bringing up a pop-up menu
  • +
  • bringing up a dialog
  • + +
    + + + + + +
    Parameters
    timeout + long: + timeout before giving up on waiting for a new window
    + + + + + + +
    Returns
    booleantrue if the event was triggered, else false
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isFocusable - () -

    -
    -
    - - + -
    -
    +
    + +
    +

    clickBottomRight

    +
    +
    + + -

    Check if the UI element's focusable property is currently true.

    -
    -
    Returns
    -
    • true if it is else false
    -
    -
    -
    Throws
    - + +
    +boolean clickBottomRight ()
    + + + + +

    Clicks the bottom and right corner of the UI element

    + +
    + + + + + +
    Returns
    booleantrue on success
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - + -
    -

    - - public +
    +

    clickTopLeft

    +
    +
    + + +
    +
    +boolean clickTopLeft ()
    + + + + +

    Clicks the top and left corner of the UI element

    + + + + + + + +
    Returns
    booleantrue on success
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + +
    - boolean -
    - isFocused - () -

    -
    -
    + +
    +

    dragTo

    +
    +
    + + +
    +
    +boolean dragTo (UiObject destObj, 
    +                int steps)
    + + + + +

    Drags this object to a destination UiObject. + The number of steps specified in your input parameter can influence the + drag speed, and varying speeds may impact the results. Consider + evaluating different speeds when using this method in your tests.

    + + + + + + + + + + + +
    Parameters
    destObj + UiObject: + the destination UiObject.
    steps + int: + usually 40 steps. You can increase or decrease the steps to change the speed.
    + + + + + + +
    Returns
    booleantrue if successful
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + -
    -
    +
    + +
    +

    dragTo

    +
    +
    + + -

    Check if the UI element's focused property is currently true

    -
    -
    Returns
    -
    • true if it is else false
    -
    -
    -
    Throws
    - + +
    +boolean dragTo (int destX, 
    +                int destY, 
    +                int steps)
    + + + + +

    Drags this object to arbitrary coordinates. + The number of steps specified in your input parameter can influence the + drag speed, and varying speeds may impact the results. Consider + evaluating different speeds when using this method in your tests.

    + +
    + + + + + + + + + + + + + +
    Parameters
    destX + int: + the X-axis coordinate.
    destY + int: + the Y-axis coordinate.
    steps + int: + usually 40 steps. You can increase or decrease the steps to change the speed.
    + + + + + + +
    Returns
    booleantrue if successful
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - - -
    -

    - - public - - + +
    +

    exists

    +
    +
    + + - boolean - - isLongClickable - () -

    -
    -
    +
    +
    +boolean exists ()
    + + + +

    Check if view exists. + This methods performs a waitForExists(long) with zero timeout. This + basically returns immediately whether the view represented by this UiObject + exists or not. If you need to wait longer for this view, then see + waitForExists(long).

    + + + + + + + +
    Returns
    booleantrue if the view represented by this UiObject does exist
    -
    -
    +
    + +
    +

    getBounds

    +
    +
    + + -

    Check if the view's long-clickable property is currently true

    -
    -
    Returns
    -
    • true if it is else false
    -
    -
    -
    Throws
    - + +
    +Rect getBounds ()
    + + + + +

    Returns the view's bounds property. See getVisibleBounds()

    + +
    + + + + + +
    Returns
    RectRect
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - + -
    -

    - - public +
    +

    getChild

    +
    +
    + + +
    +
    +UiObject getChild (UiSelector selector)
    + + + + +

    Creates a new UiObject for a child view that is under the present UiObject.

    + + + + + + + +
    Parameters
    selector + UiSelector: + for child view to match
    + + + + + + +
    Returns
    UiObjecta new UiObject representing the child view
    + + + + + + +
    Throws
    UiObjectNotFoundException
    + +
    - boolean -
    - isScrollable - () -

    -
    -
    + +
    +

    getChildCount

    +
    +
    + + +
    +
    +int getChildCount ()
    + + + + +

    Counts the child views immediately under the present UiObject.

    + + + + + + + +
    Returns
    intthe count of child views.
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + -
    -
    +
    + +
    +

    getClassName

    +
    +
    + + -

    Check if the view's scrollable property is currently true

    -
    -
    Returns
    -
    • true if it is else false
    -
    -
    -
    Throws
    - - - - + +
    +String getClassName ()
    + + + + +

    Retrieves the className property of the UI element.

    + +
    - UiObjectNotFoundException
    + + + + + +
    Returns
    Stringclass name of the current node represented by this UiObject
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundExceptionif no match was found
    -
    + -
    - + -
    -

    - - public +
    +

    getContentDescription

    +
    +
    + + +
    +
    +String getContentDescription ()
    + + + + +

    Reads the content_desc property of the UI element

    + + + + + + + +
    Returns
    Stringvalue of node attribute "content_desc"
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + +
    - boolean -
    - isSelected - () -

    -
    -
    + +
    +

    getFromParent

    +
    +
    + + +
    +
    +UiObject getFromParent (UiSelector selector)
    + + + + +

    Creates a new UiObject for a sibling view or a child of the sibling view, + relative to the present UiObject.

    + + + + + + + +
    Parameters
    selector + UiSelector: + for a sibling view or children of the sibling view
    + + + + + + +
    Returns
    UiObjecta new UiObject representing the matched view
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + -
    -
    +
    + +
    +

    getPackageName

    +
    +
    + + -

    Checks if the UI element's selected property is currently true.

    -
    -
    Returns
    -
    • true if it is else false
    -
    -
    -
    Throws
    - + +
    +String getPackageName ()
    + + + + +

    Reads the view's package property

    + +
    + + + + + +
    Returns
    Stringtrue if it is else false
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - + -
    -

    - - public +
    +

    getSelector

    +
    +
    + + +
    +
    +UiSelector getSelector ()
    + + + + +

    Debugging helper. A test can dump the properties of a selector as a string + to its logs if needed. getSelector().toString();

    + + + + + + + +
    Returns
    UiSelectorUiSelector
    + +
    + - boolean -
    - longClick - () -

    -
    -
    +
    +

    getText

    +
    +
    + + +
    +
    +String getText ()
    + + + + +

    Reads the text property of the UI element

    + + + + + + + +
    Returns
    Stringtext value of the current node represented by this UiObject
    + + + + + + +
    Throws
    UiObjectNotFoundExceptionif no match could be found
    + +
    -
    -
    + + +
    +

    getVisibleBounds

    +
    +
    + + +
    +
    +Rect getVisibleBounds ()
    + + + +

    Returns the visible bounds of the view. -

    Long clicks the center of the visible bounds of the UI element

    -
    -
    Returns
    -
    • true if operation was successful
    -
    -
    -
    Throws
    - + If a portion of the view is visible, only the bounds of the visible portion are + reported.

    + +
    + + + + + +
    Returns
    RectRect
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    + +
    +

    See also:

    +
    -
    - + -
    -

    - - public +
    +

    isCheckable

    +
    +
    + + +
    +
    +boolean isCheckable ()
    + + + + +

    Checks if the UI element's checkable property is currently true.

    + + + + + + + +
    Returns
    booleantrue if it is else false
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + +
    - boolean -
    - longClickBottomRight - () -

    -
    -
    + +
    +

    isChecked

    +
    +
    + + +
    +
    +boolean isChecked ()
    + + + + +

    Check if the UI element's checked property is currently true

    + + + + + + + +
    Returns
    booleantrue if it is else false
    + + + + + + +
    Throws
    UiObjectNotFoundException
    + -
    -
    +
    + +
    +

    isClickable

    +
    +
    + + -

    Long clicks bottom and right corner of the UI element

    -
    -
    Returns
    -
    • true if operation was successful
    -
    -
    -
    Throws
    - + +
    +boolean isClickable ()
    + + + + +

    Checks if the UI element's clickable property is currently true.

    + +
    + + + + + +
    Returns
    booleantrue if it is else false
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - + -
    -

    - - public +
    +

    isEnabled

    +
    +
    + + +
    +
    +boolean isEnabled ()
    + + + + +

    Checks if the UI element's enabled property is currently true.

    + + + + + + + +
    Returns
    booleantrue if it is else false
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + +
    - boolean -
    - longClickTopLeft - () -

    -
    -
    + +
    +

    isFocusable

    +
    +
    + + +
    +
    +boolean isFocusable ()
    + + + + +

    Check if the UI element's focusable property is currently true.

    + + + + + + + +
    Returns
    booleantrue if it is else false
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + -
    -
    +
    + +
    +

    isFocused

    +
    +
    + + -

    Long clicks on the top and left corner of the UI element

    -
    -
    Returns
    -
    • true if operation was successful
    -
    -
    -
    Throws
    - + +
    +boolean isFocused ()
    + + + + +

    Check if the UI element's focused property is currently true

    + +
    + + + + + +
    Returns
    booleantrue if it is else false
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - - -
    -

    - - public + +
    +

    isLongClickable

    +
    +
    + + +
    +
    +boolean isLongClickable ()
    + + + + +

    Check if the view's long-clickable property is currently true

    + + + + + + + +
    Returns
    booleantrue if it is else false
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + +
    - boolean -
    - performMultiPointerGesture - (PointerCoords... touches) -

    -
    -
    + +
    +

    isScrollable

    +
    +
    + + -
    -
    +
    +
    +boolean isScrollable ()
    + + + + +

    Check if the view's scrollable property is currently true

    + + + + + + + +
    Returns
    booleantrue if it is else false
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + +
    + -

    Performs a multi-touch gesture. You must specify touch coordinates for - at least 2 pointers. Each pointer must have all of its touch steps - defined in an array of MotionEvent.PointerCoords. You can use this method to - specify complex gestures, like circles and irregular shapes, where each - pointer may take a different path. +

    +

    isSelected

    +
    +
    + + - To create a single point on a pointer's touch path: - - PointerCoords p = new PointerCoords(); - p.x = stepX; - p.y = stepY; - p.pressure = 1; - p.size = 1; -

    -
    -
    Parameters
    - + +
    +boolean isSelected ()
    + + + + +

    Checks if the UI element's selected property is currently true.

    + +
    + + + + + +
    Returns
    booleantrue if it is else false
    + + - + + + + + +
    Throws
    touches - represents the pointers' paths. Each MotionEvent.PointerCoords - array represents a different pointer. Each MotionEvent.PointerCoords in an - array element represents a touch point on a pointer's path.UiObjectNotFoundException
    UiObjectNotFoundException
    -
    -
    -
    Returns
    -
    • true if all touch events for this gesture are injected successfully, - false otherwise
    -
    + -
    - + -
    -

    - - public +
    +

    longClick

    +
    +
    + + +
    +
    +boolean longClick ()
    + + + + +

    Long clicks the center of the visible bounds of the UI element

    + + + + + + + +
    Returns
    booleantrue if operation was successful
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + +
    - boolean -
    - performTwoPointerGesture - (Point startPoint1, Point startPoint2, Point endPoint1, Point endPoint2, int steps) -

    -
    -
    + +
    +

    longClickBottomRight

    +
    +
    + + +
    +
    +boolean longClickBottomRight ()
    + + + + +

    Long clicks bottom and right corner of the UI element

    + + + + + + + +
    Returns
    booleantrue if operation was successful
    + + + + + + + + + + +
    Throws
    UiObjectNotFoundException
    UiObjectNotFoundException
    + -
    -
    +
    + +
    +

    longClickTopLeft

    +
    +
    + + -

    Generates a two-pointer gesture with arbitrary starting and ending points.

    -
    -
    Parameters
    - - - - - - - - - - + +
    +boolean longClickTopLeft ()
    + + + + +

    Long clicks on the top and left corner of the UI element

    + +
    startPoint1 - start point of pointer 1
    startPoint2 - start point of pointer 2
    endPoint1 - end point of pointer 1
    + + + + + +
    Returns
    booleantrue if operation was successful
    + + - + + - + +
    Throws
    endPoint2 - end point of pointer 2UiObjectNotFoundException
    steps - the number of steps for the gesture. Steps are injected - about 5 milliseconds apart, so 100 steps may take around 0.5 seconds to complete.UiObjectNotFoundException
    -
    -
    -
    Returns
    -
    • true if all touch events for this gesture are injected successfully, - false otherwise
    -
    + -
    - + -
    -

    - - public +
    +

    performMultiPointerGesture

    +
    +
    + + + +
    +
    +boolean performMultiPointerGesture (PointerCoords... touches)
    + + + +

    Performs a multi-touch gesture. You must specify touch coordinates for + at least 2 pointers. Each pointer must have all of its touch steps + defined in an array of MotionEvent.PointerCoords. You can use this method to + specify complex gestures, like circles and irregular shapes, where each + pointer may take a different path. + To create a single point on a pointer's touch path: + + PointerCoords p = new PointerCoords(); + p.x = stepX; + p.y = stepY; + p.pressure = 1; + p.size = 1; +

    + + + + + + + +
    Parameters
    touches + PointerCoords: + represents the pointers' paths. Each MotionEvent.PointerCoords + array represents a different pointer. Each MotionEvent.PointerCoords in an + array element represents a touch point on a pointer's path.
    + + + + + + +
    Returns
    booleantrue if all touch events for this gesture are injected successfully, + false otherwise
    +
    - boolean -
    - pinchIn - (int percent, int steps) -

    -
    -
    + +
    +

    performTwoPointerGesture

    +
    +
    + + -
    -
    +
    +
    +boolean performTwoPointerGesture (Point startPoint1, 
    +                Point startPoint2, 
    +                Point endPoint1, 
    +                Point endPoint2, 
    +                int steps)
    + + + + +

    Generates a two-pointer gesture with arbitrary starting and ending points.

    + + + + + + + + + + + + + + + + + + + + + + + +
    Parameters
    startPoint1 + Point: + start point of pointer 1
    startPoint2 + Point: + start point of pointer 2
    endPoint1 + Point: + end point of pointer 1
    endPoint2 + Point: + end point of pointer 2
    steps + int: + the number of steps for the gesture. Steps are injected + about 5 milliseconds apart, so 100 steps may take around 0.5 seconds to complete.
    + + + + + + +
    Returns
    booleantrue if all touch events for this gesture are injected successfully, + false otherwise
    +
    + -

    Performs a two-pointer gesture, where each pointer moves diagonally - toward the other, from the edges to the center of this UiObject .

    -
    -
    Parameters
    - - - - - - - - + +
    +

    isSelected

    +
    +
    + + +
    +
    +boolean isSelected ()
    + + + + +

    Returns whether this object is selected.

    +
    percent - percentage of the object's diagonal length for the pinch gesture
    steps - the number of steps for the gesture. Steps are injected +
    +

    pinchIn

    +
    +
    + + + +
    +
    +boolean pinchIn (int percent, 
    +                int steps)
    + + + + +

    Performs a two-pointer gesture, where each pointer moves diagonally + toward the other, from the edges to the center of this UiObject .

    + + + + + + + + + + - -
    Parameters
    percent + int: + percentage of the object's diagonal length for the pinch gesture
    steps + int: + the number of steps for the gesture. Steps are injected about 5 milliseconds apart, so 100 steps may take around 0.5 seconds to complete.
    -
    -
    -
    Returns
    -
    • true if all touch events for this gesture are injected successfully, - false otherwise
    -
    -
    -
    Throws
    - + +
    + + + + + + +
    Returns
    booleantrue if all touch events for this gesture are injected successfully, + false otherwise
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + - -
    -

    - - public +
    +

    pinchOut

    +
    +
    + + - - - - boolean - - pinchOut - (int percent, int steps) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a two-pointer gesture, where each pointer moves diagonally +

    +
    +boolean pinchOut (int percent, 
    +                int steps)
    + + + + +

    Performs a two-pointer gesture, where each pointer moves diagonally opposite across the other, from the center out towards the edges of the - this UiObject.

    -
    -
    Parameters
    - - - - - - - - + +
    +

    isEnabled

    +
    +
    + + -
    - - + +
    +boolean isFocused ()
    + + + + +

    Returns whether this object is focused.

    +
    percent - percentage of the object's diagonal length for the pinch gesture
    steps - the number of steps for the gesture. Steps are injected + this UiObject.

    + + + + + + + + + + - -
    Parameters
    percent + int: + percentage of the object's diagonal length for the pinch gesture
    steps + int: + the number of steps for the gesture. Steps are injected about 5 milliseconds apart, so 100 steps may take around 0.5 seconds to complete.
    - -
    -
    Returns
    -
    • true if all touch events for this gesture are injected successfully, - false otherwise
    -
    -
    -
    Throws
    - + +
    + + + + + + +
    Returns
    booleantrue if all touch events for this gesture are injected successfully, + false otherwise
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + - -
    -

    - - public - - - - - boolean - - setText - (String text) -

    -
    -
    - - - -
    -
    - - +
    +

    setText

    +
    +
    + + +
    +
    +boolean setText (String text)
    + + -

    Sets the text in an editable field, after clearing the field's content. + +

    Sets the text in an editable field, after clearing the field's content.

    - The UiSelector selector of this object must reference a UI element that is editable. + The UiSelector selector of this object must reference a UI element that is editable.

    When you call this method, the method sets focus on the editable field, clears its existing content, then injects your specified text into the field.

    - If you want to capture the original contents of the field, call getText() first. + If you want to capture the original contents of the field, call getText() first. You can then modify the text and use this method to update the field.

    Improvements: Post API Level 19 (KitKat release), the underlying implementation is updated to a dedicated - set text accessibility action, and it also now supports Unicode.

    -
    -
    Parameters
    - - - - -
    text - string to set
    -
    -
    -
    Returns
    -
    • true if operation is successful
    -
    -
    -
    Throws
    - + set text accessibility action, and it also now supports Unicode.

    + +
    + + + + + +
    Parameters
    text + String: + string to set
    + + + + + + +
    Returns
    booleantrue if operation is successful
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    -
    -

    - - public - - - - - boolean - - swipeDown - (int steps) -

    -
    -
    - - - -
    -
    - - +
    +

    swipeDown

    +
    +
    + + +
    +
    +boolean swipeDown (int steps)
    + + -

    Performs the swipe down action on the UiObject. + +

    Performs the swipe down action on the UiObject. The swipe gesture can be performed over any surface. The targeted UI element does not need to be scrollable. See also:

    -
    -
    Parameters
    - - - - - + + - - - +
    +

    isCheckable

    +
    +
    + + +
    +
    +boolean isCheckable ()
    + + + + +

    Returns whether this object is checkable.

    +
    steps - indicates the number of injected move steps into the system. Steps are +
  • scrollToBeginning(int)
  • +
  • scrollToEnd(int)
  • +
  • scrollBackward()
  • +
  • scrollForward()
  • +

    + + + + + + - -
    Parameters
    steps + int: + indicates the number of injected move steps into the system. Steps are injected about 5ms apart. So a 100 steps may take about 1/2 second to complete.
    - -
    -
    Returns
    -
    • true if successful
    -
    -
    -
    Throws
    - + +
    + + + + + + +
    Returns
    booleantrue if successful
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + - -
    -

    - - public - - - - - boolean - - swipeLeft - (int steps) -

    -
    -
    - - - -
    -
    - - +
    +

    swipeLeft

    +
    +
    + + +
    +
    +boolean swipeLeft (int steps)
    + + -

    Performs the swipe left action on the UiObject. + +

    Performs the swipe left action on the UiObject. The swipe gesture can be performed over any surface. The targeted UI element does not need to be scrollable. See also:

    -
    -
    Parameters
    - - - - - + +
    +

    getText

    +
    +
    + + +
    +
    +String getText ()
    + + + + +

    Returns the text value for this object.

    +
    steps - indicates the number of injected move steps into the system. Steps are +
  • scrollToBeginning(int)
  • +
  • scrollToEnd(int)
  • +
  • scrollBackward()
  • +
  • scrollForward()
  • +

    + + + + + + - -
    Parameters
    steps + int: + indicates the number of injected move steps into the system. Steps are injected about 5ms apart. So a 100 steps may take about 1/2 second to complete.
    - -
    -
    Returns
    -
    • true if successful
    -
    -
    -
    Throws
    - + +
    + + + + + + +
    Returns
    booleantrue if successful
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + - -
    -

    - - public - - - - - boolean - - swipeRight - (int steps) -

    -
    -
    - - - -
    -
    - - +
    +

    swipeRight

    +
    +
    + + +
    +
    +boolean swipeRight (int steps)
    + + -

    Performs the swipe right action on the UiObject. + +

    Performs the swipe right action on the UiObject. The swipe gesture can be performed over any surface. The targeted UI element does not need to be scrollable. See also:

    -
    -
    Parameters
    - - - - - + +
    +

    getChildren

    +
    +
    + + -
    - - +
    +

    getContentDescription

    +
    +
    + + +
    +
    +String getContentDescription ()
    + + + + +

    Returns the content description for this object.

    +
    steps - indicates the number of injected move steps into the system. Steps are +
  • scrollToBeginning(int)
  • +
  • scrollToEnd(int)
  • +
  • scrollBackward()
  • +
  • scrollForward()
  • +

    + + + + + + - -
    Parameters
    steps + int: + indicates the number of injected move steps into the system. Steps are injected about 5ms apart. So a 100 steps may take about 1/2 second to complete.
    - -
    -
    Returns
    -
    • true if successful
    -
    -
    -
    Throws
    - + +
    + + + + + + +
    Returns
    booleantrue if successful
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + - -
    -

    - - public - - - - - boolean - - swipeUp - (int steps) -

    -
    -
    - - - -
    -
    - - +
    +

    swipeUp

    +
    +
    + + +
    +
    +boolean swipeUp (int steps)
    + + -

    Performs the swipe up action on the UiObject. + +

    Performs the swipe up action on the UiObject. See also:

    -
    -
    Parameters
    - - - - - + +
    +

    findObjects

    +
    +
    + + -
    - - +
    +

    fling

    +
    +
    + + +
    +
    +boolean fling (Direction direction)
    + + + + +

    Performs a fling gesture on this object.

    +
    steps - indicates the number of injected move steps into the system. Steps are +
  • scrollToBeginning(int)
  • +
  • scrollToEnd(int)
  • +
  • scrollBackward()
  • +
  • scrollForward()
  • +

    + + + + + + - -
    Parameters
    steps + int: + indicates the number of injected move steps into the system. Steps are injected about 5ms apart. So a 100 steps may take about 1/2 second to complete.
    - -
    -
    Returns
    -
    • true of successful
    -
    -
    -
    Throws
    - + +
    + + + + + + +
    Returns
    booleantrue of successful
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + - -
    -

    - - public - - - - - boolean - - waitForExists - (long timeout) -

    -
    -
    - - - -
    -
    - - +
    +

    waitForExists

    +
    +
    + + +
    +
    +boolean waitForExists (long timeout)
    + + -

    Waits a specified length of time for a view to become visible. + +

    Waits a specified length of time for a view to become visible. This method waits until the view becomes visible on the display, or until the timeout has elapsed. You can use this method in situations where - the content that you want to select is not immediately displayed.

    -
    -
    Parameters
    - - - - -
    timeout - the amount of time to wait (in milliseconds)
    -
    -
    -
    Returns
    -
    • true if the view is displayed, else false if timeout elapsed while waiting
    -
    + the content that you want to select is not immediately displayed.

    + + + + + + + +
    Parameters
    timeout + long: + the amount of time to wait (in milliseconds)
    + + + + + + +
    Returns
    booleantrue if the view is displayed, else false if timeout elapsed while waiting
    -
    -
    -

    - - public - - - - - boolean - - waitUntilGone - (long timeout) -

    -
    -
    - - - -
    -
    - - +
    +

    waitUntilGone

    +
    +
    + + +
    +
    +boolean waitUntilGone (long timeout)
    + + -

    Waits a specified length of time for a view to become undetectable. + +

    Waits a specified length of time for a view to become undetectable. This method waits until a view is no longer matchable, or until the timeout has elapsed. - A view becomes undetectable when the UiSelector of the object is + A view becomes undetectable when the UiSelector of the object is unable to find a match because the element has either changed its state or is no longer displayed. You can use this method when attempting to wait for some long operation - to compete, such as downloading a large file or connecting to a remote server.

    -
    -
    Parameters
    - - - - -
    timeout - time to wait (in milliseconds)
    -
    -
    -
    Returns
    -
    • true if the element is gone before timeout elapsed, else false if timeout elapsed - but a matching element is still found.
    -
    + to compete, such as downloading a large file or connecting to a remote server.

    + + + + + + + +
    Parameters
    timeout + long: + time to wait (in milliseconds)
    + + + + + + +
    Returns
    booleantrue if the element is gone before timeout elapsed, else false if timeout elapsed + but a matching element is still found.
    -
    @@ -4818,53 +4206,46 @@ From class -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - - - AccessibilityNodeInfo - - findAccessibilityNodeInfo - (long timeout) -

    -
    -
    - - - -
    -
    - - - - -

    Finds a matching UI element in the accessibility hierarchy, by - using the selector for this UiObject.

    -
    -
    Parameters
    - - - - -
    timeout - in milliseconds
    -
    -
    -
    Returns
    -
    • AccessibilityNodeInfo if found else null
    -
    +
    +

    findAccessibilityNodeInfo

    +
    +
    + +
    +
    +AccessibilityNodeInfo findAccessibilityNodeInfo (long timeout)
    + + + + +

    Finds a matching UI element in the accessibility hierarchy, by + using the selector for this UiObject.

    + + + + + + + +
    Parameters
    timeout + long: + in milliseconds
    + + + + + + +
    Returns
    AccessibilityNodeInfoAccessibilityNodeInfo if found else null
    +
    @@ -4872,193 +4253,59 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    + + diff --git a/docs/html/reference/android/support/test/uiautomator/UiObject2.html b/docs/html/reference/android/support/test/uiautomator/UiObject2.html index b2195bd925b6..c237af7c0eb3 100644 --- a/docs/html/reference/android/support/test/uiautomator/UiObject2.html +++ b/docs/html/reference/android/support/test/uiautomator/UiObject2.html @@ -1,4 +1,3 @@ - @@ -93,512 +92,85 @@ - - - - - - -UiObject2 | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +UiObject2 - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public +

    UiObject2

    +

    + + public + + + + class + UiObject2 + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.uiautomator.UiObject2 +
    + + - class -

    UiObject2

    +

    +

    A UiObject2 represents a UI element. Unlike UiObject, it is bound to a particular + view instance and can become stale if the underlying view object is destroyed. As a result, it + may be necessary to call findObject(BySelector) to obtain a new + UiObject2 instance if the UI changes significantly. +

    - extends Object
    +

    Summary

    @@ -660,29 +277,17 @@ Summary: -
    -
    -
    - - - - - - - - -
    java.lang.Object
       ↳android.support.test.uiautomator.UiObject2
    @@ -690,3074 +295,3138 @@ Summary: -
    -

    Class Overview

    -

    A UiObject2 represents a UI element. Unlike UiObject, it is bound to a particular - view instance and can become stale if the underlying view object is destroyed. As a result, it - may be necessary to call findObject(BySelector) to obtain a new - UiObject2 instance if the UI changes significantly. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + void + + + clear() + + +

    Clears the text content if this object is an editable field. + + +

    + +
    + + + + + + void + + + click() + + +

    Clicks on this object. + + +

    + +
    + + + + + + void + + + click(long duration) + + +

    Performs a click on this object that lasts for duration milliseconds. + +

    + +
    + + + + + <R> + R + + + clickAndWait(EventCondition<R> condition, long timeout) + + +

    Clicks on this object, and waits for the given condition to become true. + + +

    + +
    + + + + + + void + + + drag(Point dest) + + +

    Drags this object to the specified location. + + +

    + +
    + + + + + + void + + + drag(Point dest, int speed) + + +

    Drags this object to the specified location. + + +

    + +
    + + + + + + boolean + + + equals(Object object) + + +

    + + +

    + +
    + + + + + + UiObject2 + + + findObject(BySelector selector) + + +

    Searches all elements under this object and returns the first object to match the criteria. + + +

    + +
    + + + + + + List<UiObject2> + + + findObjects(BySelector selector) + + +

    Searches all elements under this object and returns all objects that match the criteria. + + +

    + +
    + + + + + + boolean + + + fling(Direction direction, int speed) + + +

    Performs a fling gesture on this object. + + +

    + +
    + + + + + + boolean + + + fling(Direction direction) + + +

    Performs a fling gesture on this object. + + +

    + +
    + + + + + + String + + + getApplicationPackage() + + +

    Returns the package name of the app that this object belongs to. + + +

    + +
    + + + + + + int + + + getChildCount() + + +

    Returns the number of child elements directly under this object. + + +

    + +
    + + + + + + List<UiObject2> + + + getChildren() + + +

    Returns a collection of the child elements directly under this object. + + +

    + +
    + + + + + + String + + + getClassName() + + +

    Returns the class name of the underlying View represented by this + object. + + +

    + +
    + + + + + + String + + + getContentDescription() + + +

    Returns the content description for this object. + + +

    + +
    + + + + + + UiObject2 + + + getParent() + + +

    Returns this object's parent. + + +

    + +
    + + + + + + String + + + getResourceName() + + +

    Returns the fully qualified resource name for this object's id. + + +

    + +
    + + + + + + String + + + getText() + + +

    Returns the text value for this object. + + +

    + +
    + + + + + + Rect + + + getVisibleBounds() + + +

    Returns the visible bounds of this object in screen coordinates. + + +

    + +
    + + + + + + Point + + + getVisibleCenter() + + +

    Returns a point in the center of the visible bounds of this object. + + +

    + +
    + + + + + + boolean + + + hasObject(BySelector selector) + + +

    Returns whether there is a match for the given criteria under this object. + + +

    + +
    + + + + + + int + + + hashCode() + + +

    + + +

    + +
    + + + + + + boolean + + + isCheckable() + + +

    Returns whether this object is checkable. + + +

    + +
    + + + + + + boolean + + + isChecked() + + +

    Returns whether this object is checked. + + +

    + +
    + + + + + + boolean + + + isClickable() + + +

    Returns whether this object is clickable. + + +

    + +
    + + + + + + boolean + + + isEnabled() + + +

    Returns whether this object is enabled. + + +

    + +
    + + + + + + boolean + + + isFocusable() + + +

    Returns whether this object is focusable. + + +

    + +
    + + + + + + boolean + + + isFocused() + + +

    Returns whether this object is focused. + + +

    + +
    + + + + + + boolean + + + isLongClickable() + + +

    Returns whether this object is long clickable. + + +

    + +
    + + + + + + boolean + + + isScrollable() + + +

    Returns whether this object is scrollable. + + +

    + +
    + + + + + + boolean + + + isSelected() + + +

    Returns whether this object is selected. + + +

    + +
    + + + + + + void + + + longClick() + + +

    Performs a long click on this object. + + +

    + +
    + + + + + + void + + + pinchClose(float percent) + + +

    Performs a pinch close gesture on this object. + + +

    + +
    + + + + + + void + + + pinchClose(float percent, int speed) + + +

    Performs a pinch close gesture on this object. + + +

    + +
    + + + + + + void + + + pinchOpen(float percent) + + +

    Performs a pinch open gesture on this object. + + +

    + +
    + + + + + + void + + + pinchOpen(float percent, int speed) + + +

    Performs a pinch open gesture on this object. + + +

    + +
    + + + + + + void + + + recycle() + + +

    Recycle this object. + + +

    + +
    + + + + + + boolean + + + scroll(Direction direction, float percent, int speed) + + +

    Performs a scroll gesture on this object. + + +

    + +
    + + + + + + boolean + + + scroll(Direction direction, float percent) + + +

    Performs a scroll gesture on this object. + + +

    + +
    + + + + + + void + + + setGestureMargin(int margin) + + +

    Sets the margins used for gestures in pixels. + + +

    + +
    + + + + + + void + + + setGestureMargins(int left, int top, int right, int bottom) + + +

    Sets the margins used for gestures in pixels. + + +

    + +
    + + + + + + void + + + setText(String text) + + +

    Sets the text content if this object is an editable field. + + +

    + +
    + + + + + + void + + + swipe(Direction direction, float percent, int speed) + + +

    Performs a swipe gesture on this object. + + +

    + +
    + + + + + + void + + + swipe(Direction direction, float percent) + + +

    Performs a swipe gesture on this object. + + +

    + +
    + + + + + <R> + R + + + wait(UiObject2Condition<R> condition, long timeout) + + +

    Waits for given the condition to be met. + + +

    + +
    + + + + + <R> + R + + + wait(SearchCondition<R> condition, long timeout) + + +

    Waits for given the condition to be met. + + +

    + +
    -

    + + + + + +

    Inherited methods

    + From +class + + + java.lang.Object + + +
    + + +
    +
    + + -
    + -

    Summary

    + + + + + + +

    Public methods

    + +
    +

    clear

    +
    +
    + + +
    +
    +void clear ()
    + + + +

    Clears the text content if this object is an editable field.

    +
    + +
    +

    click

    +
    +
    + + +
    +
    +void click ()
    + + + +

    Clicks on this object.

    +
    + +
    +

    click

    +
    +
    + + +
    +
    +void click (long duration)
    + + + + +

    Performs a click on this object that lasts for duration milliseconds.

    + + + + + + +
    Parameters
    duration + long +
    - - + + +
    +

    clickAndWait

    +
    +
    + + -
    - - + +
    +void drag (Point dest, 
    +                int speed)
    + + + + +

    Drags this object to the specified location.

    +
    Public Methods
    + +
    +R clickAndWait (EventCondition<R> condition, 
    +                long timeout)
    + + + + +

    Clicks on this object, and waits for the given condition to become true.

    + + + + + + + + + + +
    Parameters
    condition + EventCondition +
    timeout + long +
    + + + + + + +
    Returns
    R
    + + +
    +

    drag

    +
    +
    + + - void
    -
    - clear() + +
    +void drag (Point dest)
    + + + + +

    Drags this object to the specified location.

    + + + + + + +
    Parameters
    dest + Point: + The end point that this object should be dragged to. +
    -
    - Clears the text content if this object is an editable field. +
    + - +
    +

    drag

    +
    +
    + + -
    + + + + + + + + + +
    Parameters
    dest + Point: + The end point that this object should be dragged to.
    speed + int: + The speed at which to perform this gesture in pixels per second. +
    +
    -
    + +
    +

    equals

    +
    +
    + + +
    +
    +boolean equals (Object object)
    + + + + +

    + + + + + + +
    Parameters
    object + Object +
    + + + + + + +
    Returns
    boolean
    +
    - void
    -
    - click() + -
    - Clicks on this object. +
    +

    findObject

    +
    +
    + + +
    +
    +UiObject2 findObject (BySelector selector)
    + + + +

    Searches all elements under this object and returns the first object to match the criteria. +

    + + + + + + +
    Parameters
    selector + BySelector +
    + + + + + + +
    Returns
    UiObject2
    -
    +
    -
    + +
    +List<UiObject2> findObjects (BySelector selector)
    + + + + +

    Searches all elements under this object and returns all objects that match the criteria.

    + + + + + + +
    Parameters
    selector + BySelector +
    + + + + + + +
    Returns
    List<UiObject2>
    + + - <R> - R
    -
    - clickAndWait(EventCondition<R> condition, long timeout) +
    +

    fling

    +
    +
    + + -
    - Clicks on this object, and waits for the given condition to become true. +
    +
    +boolean fling (Direction direction, 
    +                int speed)
    + + + + +

    Performs a fling gesture on this object.

    + + + + + + + + + + +
    Parameters
    direction + Direction: + The direction in which to fling.
    speed + int: + The speed at which to perform this gesture in pixels per second.
    + + + + + + +
    Returns
    booleanWhether the object can still scroll in the given direction. +
    +
    -
    + -
    + + + + + +
    Parameters
    direction + Direction: + The direction in which to fling.
    + + + + + + +
    Returns
    booleanWhether the object can still scroll in the given direction. +
    +
    -
    + +
    +

    getApplicationPackage

    +
    +
    + + +
    +
    +String getApplicationPackage ()
    + + + + +

    Returns the package name of the app that this object belongs to.

    + + + + + + +
    Returns
    String
    +
    - void
    -
    - drag(Point dest, int speed) -
    - Drags this object to the specified location. + +
    +

    getChildCount

    +
    +
    + + +
    +
    +int getChildCount ()
    + + + + +

    Returns the number of child elements directly under this object.

    + + + + + + +
    Returns
    int
    -
    +
    -
    + +
    +List<UiObject2> getChildren ()
    + + + + +

    Returns a collection of the child elements directly under this object.

    + + + + + + +
    Returns
    List<UiObject2>
    + + +
    +

    getClassName

    +
    +
    + + - void
    -
    - drag(Point dest) + +
    +String getClassName ()
    + + -
    - Drags this object to the specified location. + +

    Returns the class name of the underlying View represented by this + object. +

    + + + + + + +
    Returns
    String
    +
    - + -
    + + + + + +
    Returns
    String
    +
    -
    + +
    +

    getParent

    +
    +
    + + +
    +
    +UiObject2 getParent ()
    + + + + +

    Returns this object's parent.

    + + + + + + +
    Returns
    UiObject2
    +
    - boolean
    -
    - equals(Object object) -
    + +
    +

    getResourceName

    +
    +
    + + +
    +
    +String getResourceName ()
    + + + + +

    Returns the fully qualified resource name for this object's id.

    + + + + + + +
    Returns
    String
    +
    -
    -
    + + + + + +
    Returns
    String
    -
    + + +
    +

    getVisibleBounds

    +
    +
    + + +
    +
    +Rect getVisibleBounds ()
    + + + + +

    Returns the visible bounds of this object in screen coordinates.

    + + + + + + +
    Returns
    Rect
    - UiObject2
    -
    - findObject(BySelector selector) + -
    - Searches all elements under this object and returns the first object to match the criteria. + +
    +

    getVisibleCenter

    +
    +
    + + -
    +
    +
    +Point getVisibleCenter ()
    + + + + +

    Returns a point in the center of the visible bounds of this object.

    + + + + + + +
    Returns
    Point
    -
    +
    +

    hasObject

    +
    +
    + + +
    +
    +boolean hasObject (BySelector selector)
    + + + + +

    Returns whether there is a match for the given criteria under this object.

    + + + + + + +
    Parameters
    selector + BySelector +
    + + + + + + +
    Returns
    boolean
    +
    + - List<UiObject2>
    -
    - findObjects(BySelector selector) +
    +

    hashCode

    +
    +
    + + -
    - Searches all elements under this object and returns all objects that match the criteria. +
    +
    +int hashCode ()
    + + + + +

    + + + + + + +
    Returns
    int
    +
    -
    + -
    + + + + + +
    Returns
    boolean
    +
    -
    + +
    +

    isChecked

    +
    +
    + + +
    +
    +boolean isChecked ()
    + + + + +

    Returns whether this object is checked.

    + + + + + + +
    Returns
    boolean
    +
    - boolean
    -
    - fling(Direction direction) -
    - Performs a fling gesture on this object. + +
    +

    isClickable

    +
    +
    + + +
    +
    +boolean isClickable ()
    + + + + +

    Returns whether this object is clickable.

    + + + + + + +
    Returns
    boolean
    -
    +
    -
    + +
    +boolean isEnabled ()
    + + + + +

    Returns whether this object is enabled.

    + + + + + + +
    Returns
    boolean
    + + +
    +

    isFocusable

    +
    +
    + + - boolean
    -
    - fling(Direction direction, int speed) + +
    +boolean isFocusable ()
    + + + + +

    Returns whether this object is focusable.

    + + + + + + +
    Returns
    boolean
    -
    - Performs a fling gesture on this object. +
    + - +
    +

    isFocused

    +
    +
    + + -
    + + + + + +
    Returns
    boolean
    +
    -
    + +
    +

    isLongClickable

    +
    +
    + + +
    +
    +boolean isLongClickable ()
    + + + + +

    Returns whether this object is long clickable.

    + + + + + + +
    Returns
    boolean
    +
    - String
    -
    - getApplicationPackage() + -
    - Returns the package name of the app that this object belongs to. +
    +

    isScrollable

    +
    +
    + + +
    +
    +boolean isScrollable ()
    + + + + +

    Returns whether this object is scrollable.

    + + + + + + +
    Returns
    boolean
    +
    -
    -
    + + + + + +
    Returns
    boolean
    - - +
    + +
    +

    longClick

    +
    +
    + + +
    +
    +void longClick ()
    + + - int
    - - - getChildCount() + +

    Performs a long click on this object.

    -
    - Returns the number of child elements directly under this object. +
    + -
    +
    +

    pinchClose

    +
    +
    + + - +
    +
    +void pinchClose (float percent)
    + + + + +

    Performs a pinch close gesture on this object.

    + + + + + + +
    Parameters
    percent + float: + The size of the pinch as a percentage of this object's size. +
    +
    - - + +
    +

    pinchClose

    +
    +
    + + +
    +
    +void pinchClose (float percent, 
    +                int speed)
    + + + + +

    Performs a pinch close gesture on this object.

    + + + + + + + + + + +
    Parameters
    percent + float: + The size of the pinch as a percentage of this object's size.
    speed + int: + The speed at which to perform this gesture in pixels per second. +
    +
    - List<UiObject2>
    - - - getChildren() + -
    - Returns a collection of the child elements directly under this object. +
    +

    pinchOpen

    +
    +
    + + +
    +
    +void pinchOpen (float percent)
    + + + + +

    Performs a pinch open gesture on this object.

    + + + + + + +
    Parameters
    percent + float: + The size of the pinch as a percentage of this object's size. +
    +
    -
    - + +
    +

    pinchOpen

    +
    +
    + + +
    +
    +void pinchOpen (float percent, 
    +                int speed)
    + + + + +

    Performs a pinch open gesture on this object.

    + + + + + + + + + + +
    Parameters
    percent + float: + The size of the pinch as a percentage of this object's size.
    speed + int: + The speed at which to perform this gesture in pixels per second. +
    - - +
    + +
    +

    recycle

    +
    +
    + + +
    +
    +void recycle ()
    + + - String
    - - - getClassName() + +

    Recycle this object.

    -
    - Returns the class name of the underlying View represented by this - object. - - - -
    - - - - - - - - - - - - - String - - - getContentDescription() - -
    - Returns the content description for this object. - - - -
    - - - - - - - - - - - - - UiObject2 - - - getParent() - -
    - Returns this object's parent. - - - -
    - - - - - - - - - - - - - String - - - getResourceName() - -
    - Returns the fully qualified resource name for this object's id. - - - -
    - - - - - - - - - - - - - String - - - getText() - -
    - Returns the text value for this object. - - - -
    - - - - - - - - - - - - - Rect - - - getVisibleBounds() - -
    - Returns the visible bounds of this object in screen coordinates. - - - -
    - - - - - - - - - - - - - Point - - - getVisibleCenter() - -
    - Returns a point in the center of the visible bounds of this object. - - - -
    - - - - - - - - - - - - - boolean - - - hasObject(BySelector selector) - -
    - Returns whether there is a match for the given criteria under this object. - - - -
    - - - - - - - - - - - - - int - - - hashCode() - -
    - - - - -
    - - - - - - - - - - - - - boolean - - - isCheckable() - -
    - Returns whether this object is checkable. - - - -
    - - - - - - - - - - - - - boolean - - - isChecked() - -
    - Returns whether this object is checked. - - - -
    - - - - - - - - - - - - - boolean - - - isClickable() - -
    - Returns whether this object is clickable. - - - -
    - - - - - - - - - - - - - boolean - - - isEnabled() - -
    - Returns whether this object is enabled. - - - -
    - - - - - - - - - - - - - boolean - - - isFocusable() - -
    - Returns whether this object is focusable. - - - -
    - - - - - - - - - - - - - boolean - - - isFocused() - -
    - Returns whether this object is focused. - - - -
    - - - - - - - - - - - - - boolean - - - isLongClickable() - -
    - Returns whether this object is long clickable. - - - -
    - - - - - - - - - - - - - boolean - - - isScrollable() - -
    - Returns whether this object is scrollable. - - - -
    - - - - - - - - - - - - - boolean - - - isSelected() - -
    - Returns whether this object is selected. - - - -
    - - - - - - - - - - - - - void - - - longClick() - -
    - Performs a long click on this object. - - - -
    - - - - - - - - - - - - - void - - - pinchClose(float percent, int speed) - -
    - Performs a pinch close gesture on this object. - - - -
    - - - - - - - - - - - - - void - - - pinchClose(float percent) - -
    - Performs a pinch close gesture on this object. - - - -
    - - - - - - - - - - - - - void - - - pinchOpen(float percent, int speed) - -
    - Performs a pinch open gesture on this object. - - - -
    - - - - - - - - - - - - - void - - - pinchOpen(float percent) - -
    - Performs a pinch open gesture on this object. - - - -
    - - - - - - - - - - - - - void - - - recycle() - -
    - Recycle this object. - - - -
    - - - - - - - - - - - - - boolean - - - scroll(Direction direction, float percent) - -
    - Performs a scroll gesture on this object. - - - -
    - - - - - - - - - - - - - boolean - - - scroll(Direction direction, float percent, int speed) - -
    - Performs a scroll gesture on this object. - - - -
    - - - - - - - - - - - - - void - - - setGestureMargin(int margin) - -
    - Sets the margins used for gestures in pixels. - - - -
    - - - - - - - - - - - - - void - - - setGestureMargins(int left, int top, int right, int bottom) - -
    - Sets the margins used for gestures in pixels. - - - -
    - - - - - - - - - - - - - void - - - setText(String text) - -
    - Sets the text content if this object is an editable field. - - - -
    - - - - - - - - - - - - - void - - - swipe(Direction direction, float percent, int speed) - -
    - Performs a swipe gesture on this object. - - - -
    - - - - - - - - - - - - - void - - - swipe(Direction direction, float percent) - -
    - Performs a swipe gesture on this object. - - - -
    - - - - - - - - - - - - <R> - R - - - wait(UiObject2Condition<R> condition, long timeout) - -
    - Waits for given the condition to be met. - - - -
    - - - - - - - - - - - - <R> - R - - - wait(SearchCondition<R> condition, long timeout) - -
    - Waits for given the condition to be met. - - - -
    - - - - - - - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - - - - - void - - clear - () -

    -
    -
    - - - -
    -
    - - - - -

    Clears the text content if this object is an editable field.

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - click - () -

    -
    -
    - - - -
    -
    - - - - -

    Clicks on this object.

    - -
    -
    - - - - -
    -

    - - public - - - - - R - - clickAndWait - (EventCondition<R> condition, long timeout) -

    -
    -
    - - - -
    -
    - - - - -

    Clicks on this object, and waits for the given condition to become true.

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - drag - (Point dest, int speed) -

    -
    -
    - - - -
    -
    - - - - -

    Drags this object to the specified location.

    -
    -
    Parameters
    - - - - - - - -
    dest - The end point that this object should be dragged to.
    speed - The speed at which to perform this gesture in pixels per second. -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - void - - drag - (Point dest) -

    -
    -
    - - - -
    -
    - - - - -

    Drags this object to the specified location.

    -
    -
    Parameters
    - - - - -
    dest - The end point that this object should be dragged to. -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - equals - (Object object) -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - UiObject2 - - findObject - (BySelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Searches all elements under this object and returns the first object to match the criteria. -

    - -
    -
    - - - - -
    -

    - - public - - - - - List<UiObject2> - - findObjects - (BySelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Searches all elements under this object and returns all objects that match the criteria.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - fling - (Direction direction) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a fling gesture on this object.

    -
    -
    Parameters
    - - - - -
    direction - The direction in which to fling.
    -
    -
    -
    Returns
    -
    • Whether the object can still scroll in the given direction. -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - fling - (Direction direction, int speed) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a fling gesture on this object.

    -
    -
    Parameters
    - - - - - - - -
    direction - The direction in which to fling.
    speed - The speed at which to perform this gesture in pixels per second.
    -
    -
    -
    Returns
    -
    • Whether the object can still scroll in the given direction. -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getApplicationPackage - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the package name of the app that this object belongs to.

    - -
    -
    - - - - -
    -

    - - public - - - - - int - - getChildCount - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the number of child elements directly under this object.

    - -
    -
    - - - - -
    -

    - - public - - - - - List<UiObject2> - - getChildren - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a collection of the child elements directly under this object.

    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getClassName - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the class name of the underlying View represented by this - object. -

    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getContentDescription - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the content description for this object.

    - -
    -
    - - - - -
    -

    - - public - - - - - UiObject2 - - getParent - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns this object's parent.

    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getResourceName - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the fully qualified resource name for this object's id.

    - -
    -
    - - - - -
    -

    - - public - - - - - String - - getText - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the text value for this object.

    - -
    -
    - - - - -
    -

    - - public - - - - - Rect - - getVisibleBounds - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns the visible bounds of this object in screen coordinates.

    - -
    -
    - - - - -
    -

    - - public - - - - - Point - - getVisibleCenter - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a point in the center of the visible bounds of this object.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - hasObject - (BySelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether there is a match for the given criteria under this object.

    - -
    -
    - - - - -
    -

    - - public - - - - - int - - hashCode - () -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isCheckable - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether this object is checkable.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isChecked - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether this object is checked.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isClickable - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether this object is clickable.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isEnabled - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether this object is enabled.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isFocusable - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether this object is focusable.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isFocused - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether this object is focused.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isLongClickable - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether this object is long clickable.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isScrollable - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether this object is scrollable.

    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - isSelected - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns whether this object is selected.

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - longClick - () -

    -
    -
    - - - -
    -
    - - - - -

    Performs a long click on this object.

    - -
    -
    - - - - -
    -

    - - public - - - - - void - - pinchClose - (float percent, int speed) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a pinch close gesture on this object.

    -
    -
    Parameters
    - - - - - - - -
    percent - The size of the pinch as a percentage of this object's size.
    speed - The speed at which to perform this gesture in pixels per second. -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - void - - pinchClose - (float percent) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a pinch close gesture on this object.

    -
    -
    Parameters
    - - - - -
    percent - The size of the pinch as a percentage of this object's size. -
    -
    - -
    - - -
    -

    - - public - - - - - void - - pinchOpen - (float percent, int speed) -

    -
    -
    - - - -
    -
    - - - + -

    Performs a pinch open gesture on this object.

    -
    -
    Parameters
    - - - - - - - -
    percent - The size of the pinch as a percentage of this object's size.
    speed - The speed at which to perform this gesture in pixels per second. -
    -
    +
    +

    scroll

    +
    +
    + +
    -
    - - - - -
    -

    - - public - - - - - void - - pinchOpen - (float percent) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a pinch open gesture on this object.

    -
    -
    Parameters
    - - - +
    percent - The size of the pinch as a percentage of this object's size. +
    +boolean scroll (Direction direction, 
    +                float percent, 
    +                int speed)
    + + + + +

    Performs a scroll gesture on this object.

    + + + + + + + + + + + + + + +
    Parameters
    direction + Direction: + The direction in which to scroll.
    percent + float: + The distance to scroll as a percentage of this object's visible size.
    speed + int: + The speed at which to perform this gesture in pixels per second.
    + + + + + - -
    Returns
    booleanWhether the object can still scroll in the given direction.
    - - - - - - - - -
    -

    - - public +

    - - - - void - - recycle - () - -
    -
    - - - -
    -
    - - - - -

    Recycle this object.

    - -
    -
    -

    - - public - - - - - boolean - - scroll - (Direction direction, float percent) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a scroll gesture on this object.

    -
    -
    Parameters
    - - - - - - - -
    direction - The direction in which to scroll.
    percent - The distance to scroll as a percentage of this object's visible size.
    -
    -
    -
    Returns
    -
    • Whether the object can still scroll in the given direction. -
    -
    +
    +

    scroll

    +
    +
    + +
    -
    - - - - -
    -

    - - public - - - - - boolean - - scroll - (Direction direction, float percent, int speed) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a scroll gesture on this object.

    -
    -
    Parameters
    - - - - - - - - - - -
    direction - The direction in which to scroll.
    percent - The distance to scroll as a percentage of this object's visible size.
    speed - The speed at which to perform this gesture in pixels per second.
    -
    -
    -
    Returns
    -
    • Whether the object can still scroll in the given direction. -
    -
    +
    +boolean scroll (Direction direction, 
    +                float percent)
    + + + + +

    Performs a scroll gesture on this object.

    + + + + + + + + + + +
    Parameters
    direction + Direction: + The direction in which to scroll.
    percent + float: + The distance to scroll as a percentage of this object's visible size.
    + + + + + + +
    Returns
    booleanWhether the object can still scroll in the given direction. +
    -
    -
    -

    - - public - - - - - void - - setGestureMargin - (int margin) -

    -
    -
    - - - -
    -
    - - - - -

    Sets the margins used for gestures in pixels.

    +
    +

    setGestureMargin

    +
    +
    + +
    +
    +void setGestureMargin (int margin)
    + + + + +

    Sets the margins used for gestures in pixels.

    + + + + + + +
    Parameters
    margin + int +
    +
    -
    -

    - - public - - - - - void - - setGestureMargins - (int left, int top, int right, int bottom) -

    -
    -
    - - - -
    -
    - - - - -

    Sets the margins used for gestures in pixels.

    +
    +

    setGestureMargins

    +
    +
    + +
    +
    +void setGestureMargins (int left, 
    +                int top, 
    +                int right, 
    +                int bottom)
    + + + + +

    Sets the margins used for gestures in pixels.

    + + + + + + + + + + + + + + + + + + +
    Parameters
    left + int +
    top + int +
    right + int +
    bottom + int +
    +
    -
    -

    - - public - - - - - void - - setText - (String text) -

    -
    -
    - - - -
    -
    - - - - -

    Sets the text content if this object is an editable field.

    +
    +

    setText

    +
    +
    + +
    +
    +void setText (String text)
    + + + + +

    Sets the text content if this object is an editable field.

    + + + + + + +
    Parameters
    text + String +
    +
    -
    -

    - - public - - - - - void - - swipe - (Direction direction, float percent, int speed) -

    -
    -
    - - - -
    -
    +
    +

    swipe

    +
    +
    + + - - - -

    Performs a swipe gesture on this object.

    -
    -
    Parameters
    - - - - - - - - - +
    direction - The direction in which to swipe.
    percent - The length of the swipe as a percentage of this object's size.
    speed - The speed at which to perform this gesture in pixels per second. + +
    +void swipe (Direction direction, 
    +                float percent, 
    +                int speed)
    + + + + +

    Performs a swipe gesture on this object.

    + + + + + + + + + + + + + - -
    Parameters
    direction + Direction: + The direction in which to swipe.
    percent + float: + The length of the swipe as a percentage of this object's size.
    speed + int: + The speed at which to perform this gesture in pixels per second.
    - +
    -
    -
    -

    - - public - - +
    +

    swipe

    +
    +
    + + - - void - - swipe - (Direction direction, float percent) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a swipe gesture on this object.

    -
    -
    Parameters
    - - - - - - +
    direction - The direction in which to swipe.
    percent - The length of the swipe as a percentage of this object's size. + +
    +void swipe (Direction direction, 
    +                float percent)
    + + + + +

    Performs a swipe gesture on this object.

    + + + + + + + + + - -
    Parameters
    direction + Direction: + The direction in which to swipe.
    percent + float: + The length of the swipe as a percentage of this object's size.
    - +
    -
    -
    -

    - - public - - - - - R - - wait - (UiObject2Condition<R> condition, long timeout) -

    -
    -
    - - - -
    -
    - - - - -

    Waits for given the condition to be met.

    -
    -
    Parameters
    - - - - - - - -
    condition - The UiObject2Condition to evaluate.
    timeout - Maximum amount of time to wait in milliseconds.
    -
    -
    -
    Returns
    -
    • The final result returned by the condition. -
    -
    +
    +

    wait

    +
    +
    + +
    +
    +R wait (UiObject2Condition<R> condition, 
    +                long timeout)
    + + + + +

    Waits for given the condition to be met.

    + + + + + + + + + + +
    Parameters
    condition + UiObject2Condition: + The UiObject2Condition to evaluate.
    timeout + long: + Maximum amount of time to wait in milliseconds.
    + + + + + + +
    Returns
    RThe final result returned by the condition. +
    +
    -
    -

    - - public - - - - - R - - wait - (SearchCondition<R> condition, long timeout) -

    -
    -
    - - - -
    -
    - - - - -

    Waits for given the condition to be met.

    -
    -
    Parameters
    - - - - - - - -
    condition - The SearchCondition to evaluate.
    timeout - Maximum amount of time to wait in milliseconds.
    -
    -
    -
    Returns
    -
    • The final result returned by the condition. -
    -
    +
    +

    wait

    +
    +
    + +
    +
    +R wait (SearchCondition<R> condition, 
    +                long timeout)
    + + + + +

    Waits for given the condition to be met.

    + + + + + + + + + + +
    Parameters
    condition + SearchCondition: + The SearchCondition to evaluate.
    timeout + long: + Maximum amount of time to wait in milliseconds.
    + + + + + + +
    Returns
    RThe final result returned by the condition. +
    +
    @@ -3769,193 +3438,59 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/uiautomator/UiObject2Condition.html b/docs/html/reference/android/support/test/uiautomator/UiObject2Condition.html index 99efb286adf5..2703ba7a34d4 100644 --- a/docs/html/reference/android/support/test/uiautomator/UiObject2Condition.html +++ b/docs/html/reference/android/support/test/uiautomator/UiObject2Condition.html @@ -1,4 +1,3 @@ - @@ -93,512 +92,85 @@ - - - - - - -UiObject2Condition | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +UiObject2Condition - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public - - - abstract - class -

    UiObject2Condition

    - - - - - extends Object
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - +

    UiObject2Condition

    +

    + + public + + + abstract + class + UiObject2Condition + +
    + + + + + extends Object + + + + + + + + + + + +

    java.lang.Object
       ↳android.support.test.uiautomator.UiObject2Condition<R>
    + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.uiautomator.UiObject2Condition<R> +
    + + +

    - - - -
    - - -

    Class Overview

    -

    A UiObject2Condition is a condition which is satisfied when a UiObject2 is in a +

    A UiObject2Condition is a condition which is satisfied when a UiObject2 is in a particular state.

    @@ -702,27 +265,9 @@ Summary: -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -747,25 +292,23 @@ Summary: - - - - - - - - - - - + - - - - - + - - - - - + +
    +

    UiScrollable

    +
    +
    + + -
    - - - - - - - - - + + +

    Public methods

    - - - - - + +
    +boolean flingBackward ()
    + + + +

    Performs a backwards fling action with the default number of fling + steps (5). If the swipe direction is set to vertical, + then the swipe will be performed from top to bottom. If the swipe + direction is set to horizontal, then the swipes will be performed from + left to right. Make sure to take into account devices configured with + right-to-left languages like Arabic and Hebrew.

    + +
    Public Constructors
    - - - + + - - - + + + + + + +

    Public constructors

    - UiObject2Condition() - -
    + + UiObject2Condition() + + +
    @@ -781,207 +324,276 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -990,16 +602,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    - - - - - - - - - - @@ -1017,39 +619,28 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - UiObject2Condition - () -

    -
    -
    - - - -
    -
    - - +
    +

    UiObject2Condition

    +
    +
    + + +
    +
    +UiObject2Condition ()
    + + -

    + +

    -
    @@ -1071,193 +662,59 @@ From class - -
    - -
    - -
    - - - - - - + + diff --git a/docs/html/reference/android/support/test/uiautomator/UiObjectNotFoundException.html b/docs/html/reference/android/support/test/uiautomator/UiObjectNotFoundException.html index 4548cb827e7d..ab1b0c668eaa 100644 --- a/docs/html/reference/android/support/test/uiautomator/UiObjectNotFoundException.html +++ b/docs/html/reference/android/support/test/uiautomator/UiObjectNotFoundException.html @@ -1,4 +1,3 @@ - @@ -93,529 +92,102 @@ - - - - - - -UiObjectNotFoundException | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +UiObjectNotFoundException - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - + + + + -
    - - - - -
    +
    -
    - public - - - - class -

    UiObjectNotFoundException

    - - - - - - - - - - - - - extends Exception
    - - - - - - - - - - - - -
    - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

    UiObjectNotFoundException

    +

    + + public + + + + class + UiObjectNotFoundException + +
    + + + + + + + + + + + + + + + + + extends Exception + + + + + + + + + + + +

    java.lang.Object
       ↳java.lang.Throwable
        ↳java.lang.Exception
         ↳android.support.test.uiautomator.UiObjectNotFoundException
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳java.lang.Throwable +
        ↳java.lang.Exception +
         ↳android.support.test.uiautomator.UiObjectNotFoundException +
    + + +

    - - - -
    - - -

    Class Overview

    -

    Generated in test runs when a UiSelector selector could not be matched +

    Generated in test runs when a UiSelector selector could not be matched to any UI element displayed.

    -
    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -793,57 +344,49 @@ Summary: - - - - - - - - - - - - - - - - - - - - - +
    Public Constructors
    - - - - - - - - UiObjectNotFoundException(String msg) - -
    - - - - - - - - UiObjectNotFoundException(String detailMessage, Throwable throwable) - -
    - - - - - - - - UiObjectNotFoundException(Throwable throwable) - -
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public constructors

    + + UiObjectNotFoundException(String msg) + + +
    + + UiObjectNotFoundException(String detailMessage, Throwable throwable) + + +
    + + UiObjectNotFoundException(Throwable throwable) + + +
    @@ -859,241 +402,322 @@ Summary: - +
    - [Expand] -
    Inherited Methods
    + - @@ -1101,201 +725,271 @@ From class - @@ -1306,16 +1000,6 @@ From class

    Inherited methods

    - -From class - - java.lang.Throwable + + From +class + + + java.lang.Throwable + +
    - -From class - - java.lang.Object + + From +class + + + java.lang.Object + +
    -
    - - - - - - - - - @@ -1333,103 +1017,107 @@ From class -

    Public Constructors

    +

    Public constructors

    -
    -

    - - public - - - - - - - UiObjectNotFoundException - (String msg) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    UiObjectNotFoundException

    +
    +
    + +
    +
    +UiObjectNotFoundException (String msg)
    + + + + +

    + + + + + + + +
    Parameters
    msg + String +
    +
    -
    -

    - - public - - - - - - - UiObjectNotFoundException - (String detailMessage, Throwable throwable) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    UiObjectNotFoundException

    +
    +
    + +
    +
    +UiObjectNotFoundException (String detailMessage, 
    +                Throwable throwable)
    + + + + +

    + + + + + + + + + + + +
    Parameters
    detailMessage + String +
    throwable + Throwable +
    +
    -
    -

    - - public - - - - - - - UiObjectNotFoundException - (Throwable throwable) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    UiObjectNotFoundException

    +
    +
    + +
    +
    +UiObjectNotFoundException (Throwable throwable)
    + + + + +

    + + + + + + + +
    Parameters
    throwable + Throwable +
    +
    @@ -1451,193 +1139,59 @@ From class - -
    - -
    - -
    - - - -
    -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/uiautomator/UiScrollable.html b/docs/html/reference/android/support/test/uiautomator/UiScrollable.html index a4a5973100bd..f7e07163323f 100644 --- a/docs/html/reference/android/support/test/uiautomator/UiScrollable.html +++ b/docs/html/reference/android/support/test/uiautomator/UiScrollable.html @@ -1,4 +1,3 @@ - @@ -93,528 +92,101 @@ - - - - - - -UiScrollable | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +UiScrollable - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - + + + + + + -
    - - - - -
    +
    -
    - public +

    UiScrollable

    +

    + + public + + + + class + UiScrollable + +
    + + + + + + + + + + + + + + + + + extends UiCollection + + + + + + + + + + + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.uiautomator.UiObject +
        ↳android.support.test.uiautomator.UiCollection +
         ↳android.support.test.uiautomator.UiScrollable +
    + + - class -

    UiScrollable

    +

    +

    UiScrollable is a UiCollection and provides support for searching + for items in scrollable layout elements. This class can be used with + horizontally or vertically scrollable controls.

    @@ -677,10 +328,10 @@ Summary: +

    Summary

    - extends UiCollection
    @@ -693,3823 +344,3905 @@ Summary: -
    -
    + + + -
    -

    Inherited constants

    - - + + - - - -
    - - -

    Class Overview

    -

    UiScrollable is a UiCollection and provides support for searching - for items in scrollable layout elements. This class can be used with - horizontally or vertically scrollable controls.

    - +
    java.lang.Object
    + + From + class + + android.support.test.uiautomator.UiObject + +
    + + +
    +
    -
    + + + + + + + + + + + + + +

    Public constructors

    + + UiScrollable(UiSelector container) + + +

    Constructor. + + +

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + boolean + + + flingBackward() + + +

    Performs a backwards fling action with the default number of fling + steps (5). + + +

    + +
    + + + + + + boolean + + + flingForward() + + +

    Performs a forward fling with the default number of fling steps (5). + + +

    + +
    + + + + + + boolean + + + flingToBeginning(int maxSwipes) + + +

    Performs a fling gesture to reach the beginning of a scrollable layout element. + + +

    + +
    + + + + + + boolean + + + flingToEnd(int maxSwipes) + + +

    Performs a fling gesture to reach the end of a scrollable layout element. + + +

    + +
    + + + + + + UiObject + + + getChildByDescription(UiSelector childPattern, String text) + + +

    Searches for a child element in the present scrollable container. + + +

    + +
    + + + + + + UiObject + + + getChildByDescription(UiSelector childPattern, String text, boolean allowScrollSearch) + + +

    Searches for a child element in the present scrollable container. + + +

    + +
    + + + + + + UiObject + + + getChildByInstance(UiSelector childPattern, int instance) + + +

    Searches for a child element in the present scrollable container that + matches the selector you provided. + + +

    + +
    + + + + + + UiObject + + + getChildByText(UiSelector childPattern, String text, boolean allowScrollSearch) + + +

    Searches for a child element in the present scrollable container. + + +

    + +
    + + + + + + UiObject + + + getChildByText(UiSelector childPattern, String text) + + +

    Searches for a child element in the present scrollable + container. + + +

    + +
    + + + + + + int + + + getMaxSearchSwipes() + + +

    Gets the maximum number of scrolls allowed when performing a + scroll action in search of a child element. + + +

    + +
    + + + + + + double + + + getSwipeDeadZonePercentage() + + +

    Returns the percentage of a widget's size that's considered as a no-touch + zone when swiping. + + +

    + +
    + + + + + + boolean + + + scrollBackward(int steps) + + +

    Performs a backward scroll. + + +

    + +
    + + + + + + boolean + + + scrollBackward() + + +

    Performs a backward scroll with the default number of scroll steps (55). + + +

    + +
    + + + + + + boolean + + + scrollDescriptionIntoView(String text) + + +

    Performs a forward scroll action on the scrollable layout element until + the content-description is found, or until swipe attempts have been exhausted. + + +

    + +
    + + + + + + boolean + + + scrollForward(int steps) + + +

    Performs a forward scroll. + + +

    + +
    + + + + + + boolean + + + scrollForward() + + +

    Performs a forward scroll with the default number of scroll steps (55). + + +

    + +
    + + + + + + boolean + + + scrollIntoView(UiSelector selector) + + +

    Perform a scroll forward action to move through the scrollable layout + element until a visible item that matches the selector is found. + + +

    + +
    + + + + + + boolean + + + scrollIntoView(UiObject obj) + + +

    Perform a forward scroll action to move through the scrollable layout element until + a visible item that matches the UiObject is found. + + +

    + +
    + + + + + + boolean + + + scrollTextIntoView(String text) + + +

    Performs a forward scroll action on the scrollable layout element until + the text you provided is visible, or until swipe attempts have been exhausted. + + +

    + +
    + + + + + + boolean + + + scrollToBeginning(int maxSwipes) + + +

    Scrolls to the beginning of a scrollable layout element. + + +

    + +
    + + + + + + boolean + + + scrollToBeginning(int maxSwipes, int steps) + + +

    Scrolls to the beginning of a scrollable layout element. + + +

    + +
    + + + + + + boolean + + + scrollToEnd(int maxSwipes) + + +

    Scrolls to the end of a scrollable layout element. + + +

    + +
    + + + + + + boolean + + + scrollToEnd(int maxSwipes, int steps) + + +

    Scrolls to the end of a scrollable layout element. + + +

    + +
    + + + + + + UiScrollable + + + setAsHorizontalList() + + +

    Set the direction of swipes to be horizontal when performing scroll actions. + + +

    + +
    + + + + + + UiScrollable + + + setAsVerticalList() + + +

    Set the direction of swipes to be vertical when performing scroll actions. + + +

    + +
    + + + + + + UiScrollable + + + setMaxSearchSwipes(int swipes) + + +

    Sets the maximum number of scrolls allowed when performing a + scroll action in search of a child element. + + +

    + +
    + + + + + + UiScrollable + + + setSwipeDeadZonePercentage(double swipeDeadZonePercentage) + + +

    Sets the percentage of a widget's size that's considered as no-touch + zone when swiping. + + +

    + +
    -
    -

    Summary

    + + + + + + + + + + + + + + + +

    Protected methods

    + + + + + + boolean + + + exists(UiSelector selector) + + +

    Used privately when performing swipe searches to decide if an element has become + visible or not. + + +

    + +
    + + + + + - -

    Inherited methods

    + From +class + + + android.support.test.uiautomator.UiCollection + + +
    + + +
    +
    + + - +
    - [Expand] -
    Inherited Constants
    + From +class + + + android.support.test.uiautomator.UiObject + + +
    + + +
    +
    + - From class -android.support.test.uiautomator.UiObject -
    -
    From +class + + + java.lang.Object + + +
    + - +
    +
    -
    intFINGER_TOUCH_HALF_WIDTH + -
    intSWIPE_MARGIN_LIMIT + + -
    longWAIT_FOR_EVENT_TMEOUT - - This constant is deprecated. - use setScrollAcknowledgmentTimeout(long) - + +

    Public constructors

    -
    longWAIT_FOR_SELECTOR_POLL + +
    +UiScrollable (UiSelector container)
    + + + + +

    Constructor.

    + + + + + + + +
    Parameters
    container + UiSelector: + a UiSelector selector to identify the scrollable + layout element.
    + -
    longWAIT_FOR_SELECTOR_TIMEOUT - - This constant is deprecated. - use setWaitForSelectorTimeout(long) - + + -
    longWAIT_FOR_WINDOW_TMEOUT + +
    +

    flingBackward

    +
    +
    + + -
    + + + + + +
    Returns
    booleantrue if scrolled, and false if can't scroll anymore
    + + + + + + +
    Throws
    UiObjectNotFoundException
    + - -
    - - - - - - + +
    +

    flingForward

    +
    +
    + + +
    +
    +boolean flingForward ()
    + + + +

    Performs a forward fling with the default number of fling steps (5). + If the swipe direction is set to vertical, then the swipes will be + performed from bottom to top. If the swipe + direction is set to horizontal, then the swipes will be performed from + right to left. Make sure to take into account devices configured with + right-to-left languages like Arabic and Hebrew.

    + + + + + + + +
    Returns
    booleantrue if scrolled, false if can't scroll anymore
    + + + + + + +
    Throws
    UiObjectNotFoundException
    + +
    + - - +
    +

    flingToBeginning

    +
    +
    + + +
    +
    +boolean flingToBeginning (int maxSwipes)
    + + + +

    Performs a fling gesture to reach the beginning of a scrollable layout element. + The beginning can be at the top-most edge in the case of vertical controls, or + the left-most edge for horizontal controls. Make sure to take into + account devices configured with right-to-left languages like Arabic and Hebrew.

    + +
    Public Constructors
    + + + + + +
    Returns
    booleantrue on scrolled else false
    + + + + + + +
    Throws
    UiObjectNotFoundException
    + +
    - - + +
    +

    flingToEnd

    +
    +
    + + +
    +
    +boolean flingToEnd (int maxSwipes)
    + + + +

    Performs a fling gesture to reach the end of a scrollable layout element. + The end can be at the bottom-most edge in the case of vertical controls, or + the right-most edge for horizontal controls. Make sure to take into + account devices configured with right-to-left languages like Arabic and Hebrew.

    + + + + + + + +
    Returns
    booleantrue on scrolled, else false
    + + + + + + +
    Throws
    UiObjectNotFoundException
    + -
    - - - UiScrollable(UiSelector container) +
    -
    - Constructor. + - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Public Methods
    - - - - - - boolean - - flingBackward() - -
    - Performs a backwards fling action with the default number of fling - steps (5). - - - -
    - -
    - - - - - - boolean - - flingForward() - -
    - Performs a forward fling with the default number of fling steps (5). - - - -
    - -
    - - - - - - boolean - - flingToBeginning(int maxSwipes) - -
    - Performs a fling gesture to reach the beginning of a scrollable layout element. - - - -
    - -
    - - - - - - boolean - - flingToEnd(int maxSwipes) - -
    - Performs a fling gesture to reach the end of a scrollable layout element. - - - -
    - -
    - - - - - - UiObject - - getChildByDescription(UiSelector childPattern, String text) - -
    - Searches for a child element in the present scrollable container. - - - -
    - -
    - - - - - - UiObject - - getChildByDescription(UiSelector childPattern, String text, boolean allowScrollSearch) - -
    - Searches for a child element in the present scrollable container. - - - -
    - -
    - - - - - - UiObject - - getChildByInstance(UiSelector childPattern, int instance) - -
    - Searches for a child element in the present scrollable container that - matches the selector you provided. - - - -
    - -
    - - - - - - UiObject - - getChildByText(UiSelector childPattern, String text) - -
    - Searches for a child element in the present scrollable - container. - - - -
    - -
    - - - - - - UiObject - - getChildByText(UiSelector childPattern, String text, boolean allowScrollSearch) - -
    - Searches for a child element in the present scrollable container. - - - -
    - -
    - - - - - - int - - getMaxSearchSwipes() - -
    - Gets the maximum number of scrolls allowed when performing a - scroll action in search of a child element. - - - -
    - -
    - - - - - - double - - getSwipeDeadZonePercentage() - -
    - Returns the percentage of a widget's size that's considered as a no-touch - zone when swiping. - - - -
    - -
    - - - - - - boolean - - scrollBackward(int steps) - -
    - Performs a backward scroll. - - - -
    - -
    - - - - - - boolean - - scrollBackward() - -
    - Performs a backward scroll with the default number of scroll steps (55). - - - -
    - -
    - - - - - - boolean - - scrollDescriptionIntoView(String text) - -
    - Performs a forward scroll action on the scrollable layout element until - the content-description is found, or until swipe attempts have been exhausted. - - - -
    - -
    - - - - - - boolean - - scrollForward() - -
    - Performs a forward scroll with the default number of scroll steps (55). - - - -
    - -
    - - - - - - boolean - - scrollForward(int steps) - -
    - Performs a forward scroll. - - - -
    - -
    - - - - - - boolean - - scrollIntoView(UiSelector selector) - -
    - Perform a scroll forward action to move through the scrollable layout - element until a visible item that matches the selector is found. - - - -
    - -
    - - - - - - boolean - - scrollIntoView(UiObject obj) - -
    - Perform a forward scroll action to move through the scrollable layout element until - a visible item that matches the UiObject is found. - - - -
    - -
    - - - - - - boolean - - scrollTextIntoView(String text) - -
    - Performs a forward scroll action on the scrollable layout element until - the text you provided is visible, or until swipe attempts have been exhausted. - - - -
    - -
    - - - - - - boolean - - scrollToBeginning(int maxSwipes) - -
    - Scrolls to the beginning of a scrollable layout element. - - - -
    - -
    - - - - - - boolean - - scrollToBeginning(int maxSwipes, int steps) - -
    - Scrolls to the beginning of a scrollable layout element. - - - -
    - -
    - - - - - - boolean - - scrollToEnd(int maxSwipes, int steps) - -
    - Scrolls to the end of a scrollable layout element. - - - -
    - -
    - - - - - - boolean - - scrollToEnd(int maxSwipes) - -
    - Scrolls to the end of a scrollable layout element. - - - -
    - -
    - - - - - - UiScrollable - - setAsHorizontalList() - -
    - Set the direction of swipes to be horizontal when performing scroll actions. - - - -
    - -
    - - - - - - UiScrollable - - setAsVerticalList() - -
    - Set the direction of swipes to be vertical when performing scroll actions. - - - -
    - -
    - - - - - - UiScrollable - - setMaxSearchSwipes(int swipes) - -
    - Sets the maximum number of scrolls allowed when performing a - scroll action in search of a child element. - - - -
    - -
    - - - - - - UiScrollable - - setSwipeDeadZonePercentage(double swipeDeadZonePercentage) - -
    - Sets the percentage of a widget's size that's considered as no-touch - zone when swiping. - - - -
    - -
    - - - - - - - - - - - - - - - - -
    Protected Methods
    - - - - - - boolean - - exists(UiSelector selector) - -
    - Used privately when performing swipe searches to decide if an element has become - visible or not. - - - -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - android.support.test.uiautomator.UiCollection - -
    - - -
    -
    - -From class - - android.support.test.uiautomator.UiObject - -
    - - -
    -
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Constructors

    - - - - - -
    -

    - - public - - - - - - - UiScrollable - (UiSelector container) -

    -
    -
    - - - -
    -
    - - - - -

    Constructor.

    -
    -
    Parameters
    - - - - -
    container - a UiSelector selector to identify the scrollable - layout element.
    -
    - -
    -
    - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - - - - - boolean - - flingBackward - () -

    -
    -
    - - - -
    -
    - - - - -

    Performs a backwards fling action with the default number of fling - steps (5). If the swipe direction is set to vertical, - then the swipe will be performed from top to bottom. If the swipe - direction is set to horizontal, then the swipes will be performed from - left to right. Make sure to take into account devices configured with - right-to-left languages like Arabic and Hebrew.

    -
    -
    Returns
    -
    • true if scrolled, and false if can't scroll anymore
    -
    -
    -
    Throws
    - - - - -
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - flingForward - () -

    -
    -
    - - - -
    -
    - - - - -

    Performs a forward fling with the default number of fling steps (5). - If the swipe direction is set to vertical, then the swipes will be - performed from bottom to top. If the swipe - direction is set to horizontal, then the swipes will be performed from - right to left. Make sure to take into account devices configured with - right-to-left languages like Arabic and Hebrew.

    -
    -
    Returns
    -
    • true if scrolled, false if can't scroll anymore
    -
    -
    -
    Throws
    - - - - -
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - flingToBeginning - (int maxSwipes) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a fling gesture to reach the beginning of a scrollable layout element. - The beginning can be at the top-most edge in the case of vertical controls, or - the left-most edge for horizontal controls. Make sure to take into - account devices configured with right-to-left languages like Arabic and Hebrew.

    -
    -
    Returns
    -
    • true on scrolled else false
    -
    -
    -
    Throws
    - - - - -
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - flingToEnd - (int maxSwipes) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a fling gesture to reach the end of a scrollable layout element. - The end can be at the bottom-most edge in the case of vertical controls, or - the right-most edge for horizontal controls. Make sure to take into - account devices configured with right-to-left languages like Arabic and Hebrew.

    -
    -
    Returns
    -
    • true on scrolled, else false
    -
    -
    -
    Throws
    - - - - -
    UiObjectNotFoundException -
    -
    +
    +

    getChildByDescription

    +
    +
    + +
    -
    - - - - -
    -

    - - public - - - - - UiObject - - getChildByDescription - (UiSelector childPattern, String text) -

    -
    -
    - - - -
    -
    - - - - -

    Searches for a child element in the present scrollable container. +

    +UiObject getChildByDescription (UiSelector childPattern, 
    +                String text)
    + + + + +

    Searches for a child element in the present scrollable container. The search first looks for a child element that matches the selector you provided, then looks for the content-description in its children elements. If both search conditions are fulfilled, the method returns a {@ link UiObject} representing the element matching the selector (not the child element in its subhierarchy containing the content-description). By default, this method performs a scroll search. - See getChildByDescription(UiSelector, String, boolean)

    -
    -
    Parameters
    - - - - - - - - +
    +

    longClickable

    +
    +
    + + +
    +
    +UiSelector longClickable (boolean val)
    + + + +

    Set the search criteria to match widgets that are long-clickable. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    childPattern - UiSelector for a child in a scollable layout element
    text - Content-description to find in the children of + See getChildByDescription(UiSelector, String, boolean)

    + + + + + + + + + + - -
    Parameters
    childPattern + UiSelector: + UiSelector for a child in a scollable layout element
    text + String: + Content-description to find in the children of the childPattern match
    - -
    -
    Returns
    -
    • UiObject representing the child element that matches the search conditions
    -
    -
    -
    Throws
    - + +
    + + + + + + +
    Returns
    UiObjectUiObject representing the child element that matches the search conditions
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + - -
    -

    - - public - +
    +

    getChildByDescription

    +
    +
    + + - - - UiObject - - getChildByDescription - (UiSelector childPattern, String text, boolean allowScrollSearch) -

    -
    -
    - - - -
    -
    - - - - -

    Searches for a child element in the present scrollable container. +

    +
    +UiObject getChildByDescription (UiSelector childPattern, 
    +                String text, 
    +                boolean allowScrollSearch)
    + + + + +

    Searches for a child element in the present scrollable container. The search first looks for a child element that matches the selector you provided, then looks for the content-description in its children elements. If both search conditions are fulfilled, the method returns a {@ link UiObject} representing the element matching the selector (not the child element in its - subhierarchy containing the content-description).

    -
    -
    Parameters
    - - - - - - - - +
    +

    focusable

    +
    +
    + + +
    +
    +UiSelector focusable (boolean val)
    + + + +

    Set the search criteria to match widgets that are focusable. -

    - - + + - - - + The index value must be 0 or greater. + Using the index can be unreliable and should only + be used as a last resort for matching. Instead, + consider using the instance(int) method.

    + +
    childPattern - UiSelector for a child in a scollable layout element
    text - Content-description to find in the children of + subhierarchy containing the content-description).

    + + + + + + + + + + - - - - -
    Parameters
    childPattern + UiSelector: + UiSelector for a child in a scollable layout element
    text + String: + Content-description to find in the children of the childPattern match (may be a partial match)
    allowScrollSearch - set to true if scrolling is allowed
    - -
    -
    Returns
    -
    • UiObject representing the child element that matches the search conditions
    -
    -
    -
    Throws
    - + + + + + +
    allowScrollSearch + boolean: + set to true if scrolling is allowed
    + + + + + + +
    Returns
    UiObjectUiObject representing the child element that matches the search conditions
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + - -
    -

    - - public - - - +
    +

    getChildByInstance

    +
    +
    + + - UiObject - - getChildByInstance - (UiSelector childPattern, int instance) -

    -
    -
    - - - -
    -
    - - - - -

    Searches for a child element in the present scrollable container that +

    +
    +UiObject getChildByInstance (UiSelector childPattern, 
    +                int instance)
    + + + + +

    Searches for a child element in the present scrollable container that matches the selector you provided. The search is performed without - scrolling and only on visible elements.

    -
    -
    Parameters
    - - - - - - - - + +
    +UiSelector description (String desc)
    + + + +

    Set the search criteria to match the content-description + property for a widget. + The content-description is typically used + by the Android Accessibility framework to + provide an audio prompt for the widget when + the widget is selected. The content-description + for the widget must match exactly + with the string in your input argument. -

    - - + +
    +

    descriptionMatches

    +
    +
    + + -
    - - + The content-description is typically used + by the Android Accessibility framework to + provide an audio prompt for the widget when + the widget is selected. The content-description + for the widget must start + with the string in your input argument. + Matching is case-insensitive.

    + +
    childPattern - UiSelector for a child in a scollable layout element
    instance - int number representing the occurance of + scrolling and only on visible elements.

    + + + + + + + + + + - -
    Parameters
    childPattern + UiSelector: + UiSelector for a child in a scollable layout element
    instance + int: + int number representing the occurance of a childPattern match
    - -
    -
    Returns
    -
    • UiObject representing the child element that matches the search conditions
    -
    -
    -
    Throws
    - + +
    + + + + + + +
    Returns
    UiObjectUiObject representing the child element that matches the search conditions
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + - - - -
    -

    - - public - - - - - UiObject - - getChildByText - (UiSelector childPattern, String text) -

    -
    -
    - - - -
    -
    - - + +
    +

    getChildByText

    +
    +
    + + -

    Searches for a child element in the present scrollable - container. The search first looks for a child element that matches the +

    +
    +UiObject getChildByText (UiSelector childPattern, 
    +                String text, 
    +                boolean allowScrollSearch)
    + + + + +

    Searches for a child element in the present scrollable container. The + search first looks for a child element that matches the selector you provided, then looks for the text in its children elements. If both search conditions are fulfilled, the method returns a {@ link UiObject} representing the element matching the selector (not the child element in its - subhierarchy containing the text). By default, this method performs a - scroll search. - See getChildByText(UiSelector, String, boolean)

    -
    -
    Parameters
    - - - - - - - -
    childPattern - UiSelector selector for a child in a scrollable layout element
    text - String to find in the children of the childPattern match
    -
    -
    -
    Returns
    -
    • UiObject representing the child element that matches the search conditions
    -
    -
    -
    Throws
    - + subhierarchy containing the text).

    + +
    + + + + + + + + + + + + + +
    Parameters
    childPattern + UiSelector: + UiSelector selector for a child in a scrollable layout element
    text + String: + String to find in the children of the childPattern match
    allowScrollSearch + boolean: + set to true if scrolling is allowed
    + + + + + + +
    Returns
    UiObjectUiObject representing the child element that matches the search conditions
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - - -
    -

    - - public - - - - - UiObject - - getChildByText - (UiSelector childPattern, String text, boolean allowScrollSearch) -

    -
    -
    - - - -
    -
    - - + +
    +

    getChildByText

    +
    +
    + + -

    Searches for a child element in the present scrollable container. The - search first looks for a child element that matches the +

    +
    +UiObject getChildByText (UiSelector childPattern, 
    +                String text)
    + + + + +

    Searches for a child element in the present scrollable + container. The search first looks for a child element that matches the selector you provided, then looks for the text in its children elements. If both search conditions are fulfilled, the method returns a {@ link UiObject} representing the element matching the selector (not the child element in its - subhierarchy containing the text).

    -
    -
    Parameters
    - - - - - - - - - - -
    childPattern - UiSelector selector for a child in a scrollable layout element
    text - String to find in the children of the childPattern match
    allowScrollSearch - set to true if scrolling is allowed
    -
    -
    -
    Returns
    -
    • UiObject representing the child element that matches the search conditions
    -
    -
    -
    Throws
    - + subhierarchy containing the text). By default, this method performs a + scroll search. + See getChildByText(UiSelector, String, boolean)

    + +
    + + + + + + + + + +
    Parameters
    childPattern + UiSelector: + UiSelector selector for a child in a scrollable layout element
    text + String: + String to find in the children of the childPattern match
    + + + + + + +
    Returns
    UiObjectUiObject representing the child element that matches the search conditions
    + + - + + - + +
    Throws
    - UiObjectNotFoundExceptionUiObjectNotFoundException
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    -
    -

    - - public - - - - - int - - getMaxSearchSwipes - () -

    -
    -
    - - - -
    -
    - - +
    +

    getMaxSearchSwipes

    +
    +
    + + +
    +
    +int getMaxSearchSwipes ()
    + + -

    Gets the maximum number of scrolls allowed when performing a + +

    Gets the maximum number of scrolls allowed when performing a scroll action in search of a child element. - See getChildByDescription(UiSelector, String) and - getChildByText(UiSelector, String).

    -
    -
    Returns
    -
    • max the number of search swipes to perform until giving up
    -
    + See getChildByDescription(UiSelector, String) and + getChildByText(UiSelector, String).

    + + + + + + + +
    Returns
    intmax the number of search swipes to perform until giving up
    -
    -
    -

    - - public - - - - - double - - getSwipeDeadZonePercentage - () -

    -
    -
    - - - -
    -
    - - +
    +

    getSwipeDeadZonePercentage

    +
    +
    + + +
    +
    +double getSwipeDeadZonePercentage ()
    + + -

    Returns the percentage of a widget's size that's considered as a no-touch + +

    Returns the percentage of a widget's size that's considered as a no-touch zone when swiping. The no-touch zone is set as a percentage of a widget's total width or height, denoting a margin around the swipable area of the widget. Swipes must start and end inside this margin. This is important when the widget being swiped may not respond to the swipe if started at a point - too near to the edge. The default is 10% from either edge.

    -
    -
    Returns
    -
    • a value between 0 and 1
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - scrollBackward - (int steps) -

    -
    -
    - - - -
    -
    - - - - -

    Performs a backward scroll. If the swipe direction is set to vertical, - then the swipes will be performed from top to bottom. If the swipe - direction is set to horizontal, then the swipes will be performed from - left to right. Make sure to take into account devices configured with - right-to-left languages like Arabic and Hebrew.

    -
    -
    Parameters
    - - - - -
    steps - number of steps. Use this to control the speed of the scroll action.
    -
    -
    -
    Returns
    -
    • true if scrolled, false if can't scroll anymore
    -
    -
    -
    Throws
    - - - - -
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - scrollBackward - () -

    -
    -
    - - - -
    -
    - - - - -

    Performs a backward scroll with the default number of scroll steps (55). - If the swipe direction is set to vertical, - then the swipes will be performed from top to bottom. If the swipe - direction is set to horizontal, then the swipes will be performed from - left to right. Make sure to take into account devices configured with - right-to-left languages like Arabic and Hebrew.

    -
    -
    Returns
    -
    • true if scrolled, and false if can't scroll anymore
    -
    -
    -
    Throws
    - - - - -
    UiObjectNotFoundException -
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - boolean - - scrollDescriptionIntoView - (String text) -

    -
    -
    - - - -
    -
    - - - + too near to the edge. The default is 10% from either edge.

    + + + + + + + +
    Returns
    doublea value between 0 and 1
    -

    Performs a forward scroll action on the scrollable layout element until - the content-description is found, or until swipe attempts have been exhausted. - See setMaxSearchSwipes(int)

    -
    -
    Parameters
    - - - - -
    text - content-description to find within the contents of this scrollable layout element.
    -
    -
    -
    Returns
    -
    • true if item is found; else, false
    -
    -
    -
    Throws
    - - - - -
    UiObjectNotFoundException -
    -
    - -
    - - -
    -

    - - public - - + +
    +

    scrollBackward

    +
    +
    + + - boolean - - scrollForward - () -

    -
    -
    +
    +
    +boolean scrollBackward (int steps)
    + + + +

    Performs a backward scroll. If the swipe direction is set to vertical, + then the swipes will be performed from top to bottom. If the swipe + direction is set to horizontal, then the swipes will be performed from + left to right. Make sure to take into account devices configured with + right-to-left languages like Arabic and Hebrew.

    + + + + + + + +
    Parameters
    steps + int: + number of steps. Use this to control the speed of the scroll action.
    + + + + + + +
    Returns
    booleantrue if scrolled, false if can't scroll anymore
    + + + + + + +
    Throws
    UiObjectNotFoundException
    + +
    -
    -
    + +
    +

    scrollBackward

    +
    +
    + + +
    +
    +boolean scrollBackward ()
    + + -

    Performs a forward scroll with the default number of scroll steps (55). + +

    Performs a backward scroll with the default number of scroll steps (55). If the swipe direction is set to vertical, - then the swipes will be performed from bottom to top. If the swipe + then the swipes will be performed from top to bottom. If the swipe direction is set to horizontal, then the swipes will be performed from - right to left. Make sure to take into account devices configured with - right-to-left languages like Arabic and Hebrew.

    -
    -
    Returns
    -
    • true if scrolled, false if can't scroll anymore
    -
    -
    -
    Throws
    - + left to right. Make sure to take into account devices configured with + right-to-left languages like Arabic and Hebrew.

    + +
    + + + + + +
    Returns
    booleantrue if scrolled, and false if can't scroll anymore
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - - -
    -

    - - public - - + +
    +

    scrollDescriptionIntoView

    +
    +
    + + - boolean - - scrollForward - (int steps) -

    -
    -
    +
    +
    +boolean scrollDescriptionIntoView (String text)
    + + + +

    Performs a forward scroll action on the scrollable layout element until + the content-description is found, or until swipe attempts have been exhausted. + See setMaxSearchSwipes(int)

    + + + + + + + +
    Parameters
    text + String: + content-description to find within the contents of this scrollable layout element.
    + + + + + + +
    Returns
    booleantrue if item is found; else, false
    + + + + + + +
    Throws
    UiObjectNotFoundException
    + +
    -
    -
    + +
    +

    scrollForward

    +
    +
    + + +
    +
    +boolean scrollForward (int steps)
    + + -

    Performs a forward scroll. If the swipe direction is set to vertical, + +

    Performs a forward scroll. If the swipe direction is set to vertical, then the swipes will be performed from bottom to top. If the swipe direction is set to horizontal, then the swipes will be performed from right to left. Make sure to take into account devices configured with - right-to-left languages like Arabic and Hebrew.

    -
    -
    Parameters
    - - - - -
    steps - number of steps. Use this to control the speed of the scroll action
    -
    -
    -
    Returns
    -
    • true if scrolled, false if can't scroll anymore
    -
    -
    -
    Throws
    - + right-to-left languages like Arabic and Hebrew.

    + +
    + + + + + +
    Parameters
    steps + int: + number of steps. Use this to control the speed of the scroll action
    + + + + + + +
    Returns
    booleantrue if scrolled, false if can't scroll anymore
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - - -
    -

    - - public - - + +
    +

    scrollForward

    +
    +
    + + - boolean - - scrollIntoView - (UiSelector selector) -

    -
    -
    +
    +
    +boolean scrollForward ()
    + + + +

    Performs a forward scroll with the default number of scroll steps (55). + If the swipe direction is set to vertical, + then the swipes will be performed from bottom to top. If the swipe + direction is set to horizontal, then the swipes will be performed from + right to left. Make sure to take into account devices configured with + right-to-left languages like Arabic and Hebrew.

    + + + + + + + +
    Returns
    booleantrue if scrolled, false if can't scroll anymore
    + + + + + + +
    Throws
    UiObjectNotFoundException
    + +
    -
    -
    + +
    +

    scrollIntoView

    +
    +
    + + +
    +
    +boolean scrollIntoView (UiSelector selector)
    + + -

    Perform a scroll forward action to move through the scrollable layout + +

    Perform a scroll forward action to move through the scrollable layout element until a visible item that matches the selector is found. - See scrollDescriptionIntoView(String) and scrollTextIntoView(String).

    -
    -
    Parameters
    - - - - -
    selector - UiSelector selector
    -
    -
    -
    Returns
    -
    • true if the item was found and now is in view; else, false
    -
    -
    -
    Throws
    - + See scrollDescriptionIntoView(String) and scrollTextIntoView(String).

    + +
    + + + + + +
    Parameters
    selector + UiSelector: + UiSelector selector
    + + + + + + +
    Returns
    booleantrue if the item was found and now is in view; else, false
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    -
    -

    - - public - - - +
    +

    scrollIntoView

    +
    +
    + + - boolean - - scrollIntoView - (UiObject obj) -

    -
    -
    - - - -
    -
    - - - - -

    Perform a forward scroll action to move through the scrollable layout element until - a visible item that matches the UiObject is found.

    -
    -
    Parameters
    - - - - -
    obj - UiObject
    -
    -
    -
    Returns
    -
    • true if the item was found and now is in view else false
    -
    -
    -
    Throws
    - + +
    +boolean scrollIntoView (UiObject obj)
    + + + + +

    Perform a forward scroll action to move through the scrollable layout element until + a visible item that matches the UiObject is found.

    + +
    + + + + + +
    Parameters
    obj + UiObject: + UiObject
    + + + + + + +
    Returns
    booleantrue if the item was found and now is in view else false
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    -
    -

    - - public - - - - - boolean - - scrollTextIntoView - (String text) -

    -
    -
    - - - -
    -
    - - +
    +

    scrollTextIntoView

    +
    +
    + + +
    +
    +boolean scrollTextIntoView (String text)
    + + -

    Performs a forward scroll action on the scrollable layout element until + +

    Performs a forward scroll action on the scrollable layout element until the text you provided is visible, or until swipe attempts have been exhausted. - See setMaxSearchSwipes(int)

    -
    -
    Parameters
    - - - - -
    text - test to look for
    -
    -
    -
    Returns
    -
    • true if item is found; else, false
    -
    -
    -
    Throws
    - + See setMaxSearchSwipes(int)

    + +
    + + + + + +
    Parameters
    text + String: + test to look for
    + + + + + + +
    Returns
    booleantrue if item is found; else, false
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    -
    -

    - - public - - - - - boolean - - scrollToBeginning - (int maxSwipes) -

    -
    -
    - - - -
    -
    - - +
    +

    scrollToBeginning

    +
    +
    + + +
    +
    +boolean scrollToBeginning (int maxSwipes)
    + + -

    Scrolls to the beginning of a scrollable layout element. The beginning + +

    Scrolls to the beginning of a scrollable layout element. The beginning can be at the top-most edge in the case of vertical controls, or the left-most edge for horizontal controls. Make sure to take into account - devices configured with right-to-left languages like Arabic and Hebrew.

    -
    -
    Returns
    -
    • true on scrolled else false
    -
    -
    -
    Throws
    - + devices configured with right-to-left languages like Arabic and Hebrew.

    + +
    + + + + + +
    Returns
    booleantrue on scrolled else false
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    -
    -

    - - public - - - +
    +

    scrollToBeginning

    +
    +
    + + - boolean - - scrollToBeginning - (int maxSwipes, int steps) -

    -
    -
    - - - -
    -
    - - - - -

    Scrolls to the beginning of a scrollable layout element. The beginning +

    +
    +boolean scrollToBeginning (int maxSwipes, 
    +                int steps)
    + + + + +

    Scrolls to the beginning of a scrollable layout element. The beginning can be at the top-most edge in the case of vertical controls, or the left-most edge for horizontal controls. Make sure to take into account - devices configured with right-to-left languages like Arabic and Hebrew.

    -
    -
    Parameters
    - + devices configured with right-to-left languages like Arabic and Hebrew.

    + +
    + + + + + + + + + +
    Parameters
    maxSwipes + int +
    steps + int: + use steps to control the speed, so that it may be a scroll, or fling
    + + + + + + +
    Returns
    booleantrue on scrolled else false
    + + - + +
    Throws
    steps - use steps to control the speed, so that it may be a scroll, or flingUiObjectNotFoundException
    -
    -
    -
    Returns
    -
    • true on scrolled else false
    -
    -
    -
    Throws
    - - - - -
    UiObjectNotFoundException -
    -
    + -
    - - -
    -

    - - public - - - - - boolean - - scrollToEnd - (int maxSwipes, int steps) -

    -
    -
    - - - -
    -
    - + +
    +

    scrollToEnd

    +
    +
    + + +
    +
    +boolean scrollToEnd (int maxSwipes)
    + + -

    Scrolls to the end of a scrollable layout element. The end can be at the + +

    Scrolls to the end of a scrollable layout element. The end can be at the bottom-most edge in the case of vertical controls, or the right-most edge for horizontal controls. Make sure to take into account devices configured with - right-to-left languages like Arabic and Hebrew.

    -
    -
    Parameters
    - - - - -
    steps - use steps to control the speed, so that it may be a scroll, or fling
    -
    -
    -
    Returns
    -
    • true on scrolled else false
    -
    -
    -
    Throws
    - + right-to-left languages like Arabic and Hebrew.

    + +
    + + + + + +
    Returns
    booleantrue on scrolled, else false
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    - - -
    -

    - - public - - - - - boolean - - scrollToEnd - (int maxSwipes) -

    -
    -
    - - - -
    -
    - - + +
    +

    scrollToEnd

    +
    +
    + + -

    Scrolls to the end of a scrollable layout element. The end can be at the +

    +
    +boolean scrollToEnd (int maxSwipes, 
    +                int steps)
    + + + + +

    Scrolls to the end of a scrollable layout element. The end can be at the bottom-most edge in the case of vertical controls, or the right-most edge for horizontal controls. Make sure to take into account devices configured with - right-to-left languages like Arabic and Hebrew.

    -
    -
    Returns
    -
    • true on scrolled, else false
    -
    -
    -
    Throws
    - + right-to-left languages like Arabic and Hebrew.

    + +
    + + + + + + + + + +
    Parameters
    maxSwipes + int +
    steps + int: + use steps to control the speed, so that it may be a scroll, or fling
    + + + + + + +
    Returns
    booleantrue on scrolled else false
    + + - + +
    Throws
    UiObjectNotFoundException - UiObjectNotFoundException
    -
    + -
    -
    -

    - - public - - - - - UiScrollable - - setAsHorizontalList - () -

    -
    -
    - - - -
    -
    - - - - -

    Set the direction of swipes to be horizontal when performing scroll actions.

    -
    -
    Returns
    -
    • reference to itself
    -
    +
    +

    setAsHorizontalList

    +
    +
    + +
    +
    +UiScrollable setAsHorizontalList ()
    + + + + +

    Set the direction of swipes to be horizontal when performing scroll actions.

    + + + + + + + +
    Returns
    UiScrollablereference to itself
    +
    -
    -

    - - public - - - - - UiScrollable - - setAsVerticalList - () -

    -
    -
    - - - -
    -
    - - - - -

    Set the direction of swipes to be vertical when performing scroll actions.

    -
    -
    Returns
    -
    • reference to itself
    -
    +
    +

    setAsVerticalList

    +
    +
    + +
    +
    +UiScrollable setAsVerticalList ()
    + + + + +

    Set the direction of swipes to be vertical when performing scroll actions.

    + + + + + + + +
    Returns
    UiScrollablereference to itself
    +
    -
    -

    - - public - - - - - UiScrollable - - setMaxSearchSwipes - (int swipes) -

    -
    -
    - - - -
    -
    - - +
    +

    setMaxSearchSwipes

    +
    +
    + + +
    +
    +UiScrollable setMaxSearchSwipes (int swipes)
    + + -

    Sets the maximum number of scrolls allowed when performing a + +

    Sets the maximum number of scrolls allowed when performing a scroll action in search of a child element. - See getChildByDescription(UiSelector, String) and - getChildByText(UiSelector, String).

    -
    -
    Parameters
    - - - - -
    swipes - the number of search swipes to perform until giving up
    -
    -
    -
    Returns
    -
    • reference to itself
    -
    + See getChildByDescription(UiSelector, String) and + getChildByText(UiSelector, String).

    + + + + + + + +
    Parameters
    swipes + int: + the number of search swipes to perform until giving up
    + + + + + + +
    Returns
    UiScrollablereference to itself
    -
    -
    -

    - - public - - - - - UiScrollable - - setSwipeDeadZonePercentage - (double swipeDeadZonePercentage) -

    -
    -
    - - - -
    -
    - - +
    +

    setSwipeDeadZonePercentage

    +
    +
    + + +
    +
    +UiScrollable setSwipeDeadZonePercentage (double swipeDeadZonePercentage)
    + + -

    Sets the percentage of a widget's size that's considered as no-touch + +

    Sets the percentage of a widget's size that's considered as no-touch zone when swiping. The no-touch zone is set as percentage of a widget's total width or height, denoting a margin around the swipable area of the widget. Swipes must always start and end inside this margin. This is important when the widget being swiped may not respond to the swipe if started at a point - too near to the edge. The default is 10% from either edge.

    -
    -
    Parameters
    - - - - -
    swipeDeadZonePercentage - is a value between 0 and 1
    -
    -
    -
    Returns
    -
    • reference to itself
    -
    + too near to the edge. The default is 10% from either edge.

    + + + + + + + +
    Parameters
    swipeDeadZonePercentage + double: + is a value between 0 and 1
    + + + + + + +
    Returns
    UiScrollablereference to itself
    -
    @@ -4518,44 +4251,37 @@ From class -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - - - boolean - - exists - (UiSelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Used privately when performing swipe searches to decide if an element has become - visible or not.

    -
    -
    Returns
    -
    • true if found else false
    -
    +
    +

    exists

    +
    +
    + +
    +
    +boolean exists (UiSelector selector)
    + + + + +

    Used privately when performing swipe searches to decide if an element has become + visible or not.

    + + + + + + + +
    Returns
    booleantrue if found else false
    +
    @@ -4563,193 +4289,59 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/uiautomator/UiSelector.html b/docs/html/reference/android/support/test/uiautomator/UiSelector.html index 9670a8b6b7bc..5c9e23f17c29 100644 --- a/docs/html/reference/android/support/test/uiautomator/UiSelector.html +++ b/docs/html/reference/android/support/test/uiautomator/UiSelector.html @@ -1,4 +1,3 @@ - @@ -93,512 +92,85 @@ - - - - - - -UiSelector | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +UiSelector - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public +

    UiSelector

    +

    + + public + + + + class + UiSelector + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.uiautomator.UiSelector +
    + + - class -

    UiSelector

    +

    +

    Specifies the elements in the layout hierarchy for tests to target, filtered + by properties such as text value, content-description, class name, and state + information. You can also target an element by its location in a layout + hierarchy.

    - extends Object
    +

    Summary

    @@ -666,2257 +282,2195 @@ Summary: -
    -
    -
    - - - - - - - - -
    java.lang.Object
       ↳android.support.test.uiautomator.UiSelector
    + + + -
    + +
    + + + + + -

    Class Overview

    -

    Specifies the elements in the layout hierarchy for tests to target, filtered - by properties such as text value, content-description, class name, and state - information. You can also target an element by its location in a layout - hierarchy.

    +

    Public constructors

    + + UiSelector() + + +
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + + + + UiSelector + + + checkable(boolean val) + + +

    Set the search criteria to match widgets that are checkable. + + +

    + +
    + + + + + + UiSelector + + + checked(boolean val) + + +

    Set the search criteria to match widgets that + are currently checked (usually for checkboxes). + + +

    + +
    + + + + + + UiSelector + + + childSelector(UiSelector selector) + + +

    Adds a child UiSelector criteria to this selector. + + +

    + +
    + + + + + + UiSelector + + + className(String className) + + +

    Set the search criteria to match the class property + for a widget (for example, "android.widget.Button"). + + +

    + +
    + + + + + <T> + UiSelector + + + className(Class<T> type) + + +

    Set the search criteria to match the class property + for a widget (for example, "android.widget.Button"). + + +

    + +
    + + + + + + UiSelector + + + classNameMatches(String regex) + + +

    Set the search criteria to match the class property + for a widget, using a regular expression. + + +

    + +
    + + + + + + UiSelector + + + clickable(boolean val) + + +

    Set the search criteria to match widgets that are clickable. + + +

    + +
    + + + + + + UiSelector + + + description(String desc) + + +

    Set the search criteria to match the content-description + property for a widget. + + +

    + +
    + + + + + + UiSelector + + + descriptionContains(String desc) + + +

    Set the search criteria to match the content-description + property for a widget. + + +

    + +
    + + + + + + UiSelector + + + descriptionMatches(String regex) + + +

    Set the search criteria to match the content-description + property for a widget. + + +

    + +
    + + + + + + UiSelector + + + descriptionStartsWith(String desc) + + +

    Set the search criteria to match the content-description + property for a widget. + + +

    + +
    + + + + + + UiSelector + + + enabled(boolean val) + + +

    Set the search criteria to match widgets that are enabled. + + +

    + +
    + + + + + + UiSelector + + + focusable(boolean val) + + +

    Set the search criteria to match widgets that are focusable. + + +

    + +
    + + + + + + UiSelector + + + focused(boolean val) + + +

    Set the search criteria to match widgets that have focus. + + +

    + +
    + + + + + + UiSelector + + + fromParent(UiSelector selector) + + +

    Adds a child UiSelector criteria to this selector which is used to + start search from the parent widget. + + +

    + +
    + + + + + + UiSelector + + + index(int index) + + +

    Set the search criteria to match the widget by its node + index in the layout hierarchy. + + +

    + +
    + + + + + + UiSelector + + + instance(int instance) + + +

    Set the search criteria to match the + widget by its instance number. + + +

    + +
    + + + + + + UiSelector + + + longClickable(boolean val) + + +

    Set the search criteria to match widgets that are long-clickable. + + +

    + +
    + + + + + + UiSelector + + + packageName(String name) + + +

    Set the search criteria to match the package name + of the application that contains the widget. + + +

    + +
    + + + + + + UiSelector + + + packageNameMatches(String regex) + + +

    Set the search criteria to match the package name + of the application that contains the widget. + + +

    + +
    + + + + + + UiSelector + + + resourceId(String id) + + +

    Set the search criteria to match the given resource ID. + + +

    + +
    + + + + + + UiSelector + + + resourceIdMatches(String regex) + + +

    Set the search criteria to match the resource ID + of the widget, using a regular expression. + + +

    + +
    + + + + + + UiSelector + + + scrollable(boolean val) + + +

    Set the search criteria to match widgets that are scrollable. + + +

    + +
    + + + + + + UiSelector + + + selected(boolean val) + + +

    Set the search criteria to match widgets that + are currently selected. + + +

    + +
    + + + + + + UiSelector + + + text(String text) + + +

    Set the search criteria to match the visible text displayed + in a widget (for example, the text label to launch an app). + + +

    + +
    + + + + + + UiSelector + + + textContains(String text) + + +

    Set the search criteria to match the visible text in a widget + where the visible text must contain the string in your input argument. + + +

    + +
    + + + + + + UiSelector + + + textMatches(String regex) + + +

    Set the search criteria to match the visible text displayed in a layout + element, using a regular expression. + + +

    + +
    + + + + + + UiSelector + + + textStartsWith(String text) + + +

    Set the search criteria to match visible text in a widget that is + prefixed by the text parameter. + + +

    + +
    + + + + + + String + + + toString() + + +
    + + + + + + + + + + + + + + + +

    Protected methods

    + + + + + + UiSelector + + + cloneSelector() + + +
    + + + -
    +
    + +

    Inherited methods

    -

    Summary

    + From +class + + + java.lang.Object + + +
    + + +
    +
    + + + + + + +

    Public constructors

    + +
    +

    UiSelector

    +
    +
    + + +
    +
    +UiSelector ()
    + + + +

    + +
    - - - - - + +
    +

    checkable

    +
    +
    + + -
    Public Constructors
    + + + + +

    Public methods

    -
    -
    - UiSelector() -
    +
    +
    +UiSelector checkable (boolean val)
    + + + +

    Set the search criteria to match widgets that are checkable. + Typically, using this search criteria alone is not useful. + You should also include additional criteria, such as text, + content-description, or the class name for a widget. + If no other search criteria is specified, and there is more + than one matching widget, the first widget in the tree + is selected.

    + + + + + + + +
    Parameters
    val + boolean: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    +
    - - + +
    +

    checked

    +
    +
    + + +
    +
    +UiSelector checked (boolean val)
    + + + +

    Set the search criteria to match widgets that + are currently checked (usually for checkboxes). -

    - - + +
    +

    className

    +
    +
    + + -
    - - + +
    +UiSelector classNameMatches (String regex)
    + + + + +

    Set the search criteria to match the class property + for a widget, using a regular expression.

    + +
    Public Methods
    + Typically, using this search criteria alone is not useful. + You should also include additional criteria, such as text, + content-description, or the class name for a widget. + If no other search criteria is specified, and there is more + than one matching widget, the first widget in the tree + is selected.

    + + + + + + + +
    Parameters
    val + boolean: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    + + - UiSelector
    -
    - checkable(boolean val) +
    +

    childSelector

    +
    +
    + + -
    - Set the search criteria to match widgets that are checkable. +
    +
    +UiSelector childSelector (UiSelector selector)
    + + + +

    Adds a child UiSelector criteria to this selector. + Use this selector to narrow the search scope to + child widgets under a specific parent widget.

    + + + + + + + +
    Returns
    UiSelectorUiSelector with this added search criterion
    -
    +
    -
    + +
    +UiSelector className (String className)
    + + + + +

    Set the search criteria to match the class property + for a widget (for example, "android.widget.Button").

    + + + + + + + +
    Parameters
    className + String: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    + + +
    +

    className

    +
    +
    + + - UiSelector
    -
    - checked(boolean val) + +
    +UiSelector className (Class<T> type)
    + + + + +

    Set the search criteria to match the class property + for a widget (for example, "android.widget.Button").

    + + + + + + + +
    Parameters
    type + Class: + type
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    - Set the search criteria to match widgets that - are currently checked (usually for checkboxes). +
    + - +
    +

    classNameMatches

    +
    +
    + + -
    + + + + + +
    Parameters
    regex + String: + a regular expression
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    +
    -
    + +
    +

    clickable

    +
    +
    + + +
    +
    +UiSelector clickable (boolean val)
    + + + +

    Set the search criteria to match widgets that are clickable. + Typically, using this search criteria alone is not useful. + You should also include additional criteria, such as text, + content-description, or the class name for a widget. - UiSelector -

    - childSelector(UiSelector selector) + If no other search criteria is specified, and there is more + than one matching widget, the first widget in the tree + is selected.

    + + + + + + + +
    Parameters
    val + boolean: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    - Adds a child UiSelector criteria to this selector. +
    + - +
    +

    description

    +
    +
    + + -
    + Matching is case-sensitive.

    + + + + + + + +
    Parameters
    desc + String: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    + + +
    +

    descriptionContains

    +
    +
    + + - UiSelector
    -
    - className(String className) + +
    +UiSelector descriptionContains (String desc)
    + + -
    - Set the search criteria to match the class property - for a widget (for example, "android.widget.Button"). + +

    Set the search criteria to match the content-description + property for a widget. + The content-description is typically used + by the Android Accessibility framework to + provide an audio prompt for the widget when + the widget is selected. The content-description + for the widget must contain + the string in your input argument. + Matching is case-insensitive.

    + + + + + + + +
    Parameters
    desc + String: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    + -
    + +
    +UiSelector descriptionMatches (String regex)
    + + + +

    Set the search criteria to match the content-description + property for a widget. + The content-description is typically used + by the Android Accessibility framework to + provide an audio prompt for the widget when + the widget is selected. The content-description + for the widget must match exactly + with the string in your input argument.

    + + + + + + + +
    Parameters
    regex + String: + a regular expression
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    + - <T> - UiSelector
    -
    - className(Class<T> type) -
    - Set the search criteria to match the class property - for a widget (for example, "android.widget.Button"). + +
    +

    descriptionStartsWith

    +
    +
    + + +
    +
    +UiSelector descriptionStartsWith (String desc)
    + + -
    + +

    Set the search criteria to match the content-description + property for a widget. -

    + + + + + +
    Parameters
    desc + String: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    +
    -
    + +
    +

    enabled

    +
    +
    + + +
    +
    +UiSelector enabled (boolean val)
    + + + +

    Set the search criteria to match widgets that are enabled. - UiSelector -

    - classNameMatches(String regex) + Typically, using this search criteria alone is not useful. + You should also include additional criteria, such as text, + content-description, or the class name for a widget. -
    - Set the search criteria to match the class property - for a widget, using a regular expression. + If no other search criteria is specified, and there is more + than one matching widget, the first widget in the tree + is selected.

    + + + + + + + +
    Parameters
    val + boolean: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    +
    - + -
    + Typically, using this search criteria alone is not useful. + You should also include additional criteria, such as text, + content-description, or the class name for a widget. + If no other search criteria is specified, and there is more + than one matching widget, the first widget in the tree + is selected.

    + + + + + + + +
    Parameters
    val + boolean: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    + + - UiSelector
    -
    - clickable(boolean val) +
    +

    focused

    +
    +
    + + -
    - Set the search criteria to match widgets that are clickable. +
    +
    +UiSelector focused (boolean val)
    + + + +

    Set the search criteria to match widgets that have focus. + Typically, using this search criteria alone is not useful. + You should also include additional criteria, such as text, + content-description, or the class name for a widget. -

    + If no other search criteria is specified, and there is more + than one matching widget, the first widget in the tree + is selected.

    + + + + + + + +
    Parameters
    val + boolean: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    +
    +

    fromParent

    +
    +
    + + +
    +
    +UiSelector fromParent (UiSelector selector)
    + + + +

    Adds a child UiSelector criteria to this selector which is used to + start search from the parent widget. + Use this selector to narrow the search scope to + sibling widgets as well all child widgets under a parent.

    + + + + + + + +
    Returns
    UiSelectorUiSelector with this added search criterion
    +
    - UiSelector
    -
    - description(String desc) -
    - Set the search criteria to match the content-description - property for a widget. + +
    +

    index

    +
    +
    + + +
    +
    +UiSelector index (int index)
    + + -
    + +

    Set the search criteria to match the widget by its node + index in the layout hierarchy. -

    + + + + + +
    Parameters
    index + int: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    +
    -
    + +
    +

    instance

    +
    +
    + + +
    +
    +UiSelector instance (int instance)
    + + + +

    Set the search criteria to match the + widget by its instance number. - UiSelector -

    - descriptionContains(String desc) + The instance value must be 0 or greater, where + the first instance is 0. -
    - Set the search criteria to match the content-description - property for a widget. + For example, to simulate a user click on + the third image that is enabled in a UI screen, you + could specify a a search criteria where the instance is + 2, the className(String) matches the image + widget class, and enabled(boolean) is true. + The code would look like this: + + new UiSelector().className("android.widget.ImageView") + .enabled(true).instance(2); +

    + + + + + + + +
    Parameters
    instance + int: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    +
    - + -
    - - - - - - UiSelector - - descriptionMatches(String regex) - -
    - Set the search criteria to match the content-description - property for a widget. - - - -
    - -
    - - - - - - UiSelector - - descriptionStartsWith(String desc) - -
    - Set the search criteria to match the content-description - property for a widget. - - - -
    - -
    - - - - - - UiSelector - - enabled(boolean val) - -
    - Set the search criteria to match widgets that are enabled. - - - -
    - -
    - - - - - - UiSelector - - focusable(boolean val) - -
    - Set the search criteria to match widgets that are focusable. - - - -
    - -
    - - - - - - UiSelector - - focused(boolean val) - -
    - Set the search criteria to match widgets that have focus. - - - -
    - -
    - - - - - - UiSelector - - fromParent(UiSelector selector) - -
    - Adds a child UiSelector criteria to this selector which is used to - start search from the parent widget. - - - -
    - -
    - - - - - - UiSelector - - index(int index) - -
    - Set the search criteria to match the widget by its node - index in the layout hierarchy. - - - -
    - -
    - - - - - - UiSelector - - instance(int instance) - -
    - Set the search criteria to match the - widget by its instance number. - - - -
    - -
    - - - - - - UiSelector - - longClickable(boolean val) - -
    - Set the search criteria to match widgets that are long-clickable. - - - -
    - -
    - - - - - - UiSelector - - packageName(String name) - -
    - Set the search criteria to match the package name - of the application that contains the widget. - - - -
    - -
    - - - - - - UiSelector - - packageNameMatches(String regex) - -
    - Set the search criteria to match the package name - of the application that contains the widget. - - - -
    - -
    - - - - - - UiSelector - - resourceId(String id) - -
    - Set the search criteria to match the given resource ID. - - - -
    - -
    - - - - - - UiSelector - - resourceIdMatches(String regex) - -
    - Set the search criteria to match the resource ID - of the widget, using a regular expression. - - - -
    - -
    - - - - - - UiSelector - - scrollable(boolean val) - -
    - Set the search criteria to match widgets that are scrollable. - - - -
    - -
    - - - - - - UiSelector - - selected(boolean val) - -
    - Set the search criteria to match widgets that - are currently selected. - - - -
    - -
    - - - - - - UiSelector - - text(String text) - -
    - Set the search criteria to match the visible text displayed - in a widget (for example, the text label to launch an app). - - - -
    - -
    - - - - - - UiSelector - - textContains(String text) - -
    - Set the search criteria to match the visible text in a widget - where the visible text must contain the string in your input argument. - - - -
    - -
    - - - - - - UiSelector - - textMatches(String regex) - -
    - Set the search criteria to match the visible text displayed in a layout - element, using a regular expression. - - - -
    - -
    - - - - - - UiSelector - - textStartsWith(String text) - -
    - Set the search criteria to match visible text in a widget that is - prefixed by the text parameter. - - - -
    - -
    - - - - - - String - - toString() - -
    - - - - - - - - - - - - - - - - -
    Protected Methods
    - - - - - - UiSelector - - cloneSelector() - -
    - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Constructors

    - - - - - -
    -

    - - public - - - - - - - UiSelector - () -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - - - - - UiSelector - - checkable - (boolean val) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match widgets that are checkable. - - Typically, using this search criteria alone is not useful. - You should also include additional criteria, such as text, - content-description, or the class name for a widget. - - If no other search criteria is specified, and there is more - than one matching widget, the first widget in the tree - is selected.

    -
    -
    Parameters
    - - - - -
    val - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - checked - (boolean val) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match widgets that - are currently checked (usually for checkboxes). - - Typically, using this search criteria alone is not useful. - You should also include additional criteria, such as text, - content-description, or the class name for a widget. - - If no other search criteria is specified, and there is more - than one matching widget, the first widget in the tree - is selected.

    -
    -
    Parameters
    - - - - -
    val - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - childSelector - (UiSelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Adds a child UiSelector criteria to this selector. - - Use this selector to narrow the search scope to - child widgets under a specific parent widget.

    -
    -
    Returns
    -
    • UiSelector with this added search criterion
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - className - (String className) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the class property - for a widget (for example, "android.widget.Button").

    -
    -
    Parameters
    - - - - -
    className - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - className - (Class<T> type) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the class property - for a widget (for example, "android.widget.Button").

    -
    -
    Parameters
    - - - - -
    type - type
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - classNameMatches - (String regex) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the class property - for a widget, using a regular expression.

    -
    -
    Parameters
    - - - - -
    regex - a regular expression
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - clickable - (boolean val) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match widgets that are clickable. - - Typically, using this search criteria alone is not useful. - You should also include additional criteria, such as text, - content-description, or the class name for a widget. - - If no other search criteria is specified, and there is more - than one matching widget, the first widget in the tree - is selected.

    -
    -
    Parameters
    - - - - -
    val - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - description - (String desc) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the content-description - property for a widget. - - The content-description is typically used - by the Android Accessibility framework to - provide an audio prompt for the widget when - the widget is selected. The content-description - for the widget must match exactly - with the string in your input argument. - - Matching is case-sensitive.

    -
    -
    Parameters
    - - - - -
    desc - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - descriptionContains - (String desc) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the content-description - property for a widget. - - The content-description is typically used - by the Android Accessibility framework to - provide an audio prompt for the widget when - the widget is selected. The content-description - for the widget must contain - the string in your input argument. - - Matching is case-insensitive.

    -
    -
    Parameters
    - - - - -
    desc - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - descriptionMatches - (String regex) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the content-description - property for a widget. - - The content-description is typically used - by the Android Accessibility framework to - provide an audio prompt for the widget when - the widget is selected. The content-description - for the widget must match exactly - with the string in your input argument.

    -
    -
    Parameters
    - - - - -
    regex - a regular expression
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - descriptionStartsWith - (String desc) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the content-description - property for a widget. - - The content-description is typically used - by the Android Accessibility framework to - provide an audio prompt for the widget when - the widget is selected. The content-description - for the widget must start - with the string in your input argument. - - Matching is case-insensitive.

    -
    -
    Parameters
    - - - - -
    desc - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - enabled - (boolean val) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match widgets that are enabled. - - Typically, using this search criteria alone is not useful. - You should also include additional criteria, such as text, - content-description, or the class name for a widget. - - If no other search criteria is specified, and there is more - than one matching widget, the first widget in the tree - is selected.

    -
    -
    Parameters
    - - - - -
    val - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - focusable - (boolean val) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match widgets that are focusable. - - Typically, using this search criteria alone is not useful. - You should also include additional criteria, such as text, - content-description, or the class name for a widget. - - If no other search criteria is specified, and there is more - than one matching widget, the first widget in the tree - is selected.

    -
    -
    Parameters
    - - - - -
    val - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - focused - (boolean val) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match widgets that have focus. - - Typically, using this search criteria alone is not useful. - You should also include additional criteria, such as text, - content-description, or the class name for a widget. - - If no other search criteria is specified, and there is more - than one matching widget, the first widget in the tree - is selected.

    -
    -
    Parameters
    - - - - -
    val - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - fromParent - (UiSelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Adds a child UiSelector criteria to this selector which is used to - start search from the parent widget. - - Use this selector to narrow the search scope to - sibling widgets as well all child widgets under a parent.

    -
    -
    Returns
    -
    • UiSelector with this added search criterion
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - index - (int index) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the widget by its node - index in the layout hierarchy. - - The index value must be 0 or greater. - - Using the index can be unreliable and should only - be used as a last resort for matching. Instead, - consider using the instance(int) method.

    -
    -
    Parameters
    - - - - -
    index - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - instance - (int instance) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the - widget by its instance number. - - The instance value must be 0 or greater, where - the first instance is 0. - - For example, to simulate a user click on - the third image that is enabled in a UI screen, you - could specify a a search criteria where the instance is - 2, the className(String) matches the image - widget class, and enabled(boolean) is true. - The code would look like this: - - new UiSelector().className("android.widget.ImageView") - .enabled(true).instance(2); -

    -
    -
    Parameters
    - - - - -
    instance - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    - -
    -
    - - - - -
    -

    - - public - - - - - UiSelector - - longClickable - (boolean val) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match widgets that are long-clickable. - - Typically, using this search criteria alone is not useful. - You should also include additional criteria, such as text, - content-description, or the class name for a widget. + Typically, using this search criteria alone is not useful. + You should also include additional criteria, such as text, + content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree - is selected.

    -
    -
    Parameters
    - - - - -
    val - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    + is selected.

    + + + + + + + +
    Parameters
    val + boolean: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    -
    -

    - - public - - - - - UiSelector - - packageName - (String name) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the package name - of the application that contains the widget.

    -
    -
    Parameters
    - - - - -
    name - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    +
    +

    packageName

    +
    +
    + +
    +
    +UiSelector packageName (String name)
    + + + + +

    Set the search criteria to match the package name + of the application that contains the widget.

    + + + + + + + +
    Parameters
    name + String: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    +
    -
    -

    - - public - - - - - UiSelector - - packageNameMatches - (String regex) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the package name - of the application that contains the widget.

    -
    -
    Parameters
    - - - - -
    regex - a regular expression
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    +
    +

    packageNameMatches

    +
    +
    + +
    +
    +UiSelector packageNameMatches (String regex)
    + + + + +

    Set the search criteria to match the package name + of the application that contains the widget.

    + + + + + + + +
    Parameters
    regex + String: + a regular expression
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    +
    -
    -

    - - public - - - - - UiSelector - - resourceId - (String id) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the given resource ID.

    -
    -
    Parameters
    - - - - -
    id - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    +
    +

    resourceId

    +
    +
    + +
    +
    +UiSelector resourceId (String id)
    + + + + +

    Set the search criteria to match the given resource ID.

    + + + + + + + +
    Parameters
    id + String: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    +
    -
    -

    - - public - - - - - UiSelector - - resourceIdMatches - (String regex) -

    -
    -
    - - - -
    -
    - - - - -

    Set the search criteria to match the resource ID - of the widget, using a regular expression.

    -
    -
    Parameters
    - - - - -
    regex - a regular expression
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    +
    +

    resourceIdMatches

    +
    +
    + +
    +
    +UiSelector resourceIdMatches (String regex)
    + + + + +

    Set the search criteria to match the resource ID + of the widget, using a regular expression.

    + + + + + + + +
    Parameters
    regex + String: + a regular expression
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    +
    -
    -

    - - public - - - - - UiSelector - - scrollable - (boolean val) -

    -
    -
    - - - -
    -
    - - +
    +

    scrollable

    +
    +
    + + +
    +
    +UiSelector scrollable (boolean val)
    + + -

    Set the search criteria to match widgets that are scrollable. + +

    Set the search criteria to match widgets that are scrollable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, @@ -2924,52 +2478,45 @@ From class If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree - is selected.

    -
    -
    Parameters
    - - - - -
    val - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    + is selected.

    + + + + + + + +
    Parameters
    val + boolean: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    -
    -

    - - public - - - - - UiSelector - - selected - (boolean val) -

    -
    -
    - - - -
    -
    - - +
    +

    selected

    +
    +
    + + +
    +
    +UiSelector selected (boolean val)
    + + -

    Set the search criteria to match widgets that + +

    Set the search criteria to match widgets that are currently selected. Typically, using this search criteria alone is not useful. @@ -2978,248 +2525,219 @@ From class If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree - is selected.

    -
    -
    Parameters
    - - - - -
    val - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    + is selected.

    + + + + + + + +
    Parameters
    val + boolean: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    -
    -

    - - public - - - - - UiSelector - - text - (String text) -

    -
    -
    - - - -
    -
    - - +
    +

    text

    +
    +
    + + +
    +
    +UiSelector text (String text)
    + + -

    Set the search criteria to match the visible text displayed + +

    Set the search criteria to match the visible text displayed in a widget (for example, the text label to launch an app). The text for the element must match exactly with the string in your input - argument. Matching is case-sensitive.

    -
    -
    Parameters
    - - - - -
    text - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    + argument. Matching is case-sensitive.

    + + + + + + + +
    Parameters
    text + String: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    -
    -

    - - public - - - - - UiSelector - - textContains - (String text) -

    -
    -
    - - - -
    -
    - - +
    +

    textContains

    +
    +
    + + +
    +
    +UiSelector textContains (String text)
    + + -

    Set the search criteria to match the visible text in a widget + +

    Set the search criteria to match the visible text in a widget where the visible text must contain the string in your input argument. - The matching is case-sensitive.

    -
    -
    Parameters
    - - - - -
    text - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    + The matching is case-sensitive.

    + + + + + + + +
    Parameters
    text + String: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    -
    -

    - - public - - - - - UiSelector - - textMatches - (String regex) -

    -
    -
    - - - -
    -
    - - +
    +

    textMatches

    +
    +
    + + +
    +
    +UiSelector textMatches (String regex)
    + + -

    Set the search criteria to match the visible text displayed in a layout + +

    Set the search criteria to match the visible text displayed in a layout element, using a regular expression. The text in the widget must match exactly with the string in your - input argument.

    -
    -
    Parameters
    - - - - -
    regex - a regular expression
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    + input argument.

    + + + + + + + +
    Parameters
    regex + String: + a regular expression
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    -
    -

    - - public - - - - - UiSelector - - textStartsWith - (String text) -

    -
    -
    - - - -
    -
    - - +
    +

    textStartsWith

    +
    +
    + + +
    +
    +UiSelector textStartsWith (String text)
    + + -

    Set the search criteria to match visible text in a widget that is + +

    Set the search criteria to match visible text in a widget that is prefixed by the text parameter. - The matching is case-insensitive.

    -
    -
    Parameters
    - - - - -
    text - Value to match
    -
    -
    -
    Returns
    -
    • UiSelector with the specified search criteria
    -
    + The matching is case-insensitive.

    + + + + + + + +
    Parameters
    text + String: + Value to match
    + + + + + + +
    Returns
    UiSelectorUiSelector with the specified search criteria
    -
    -
    -

    - - public - - - - - String - - toString - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    toString

    +
    +
    + +
    +
    +String toString ()
    + + + + +

    + + + + + + +
    Returns
    String
    +
    @@ -3228,39 +2746,36 @@ From class -

    Protected Methods

    +

    Protected methods

    -
    -

    - - protected - - - - - UiSelector - - cloneSelector - () -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    cloneSelector

    +
    +
    + +
    +
    +UiSelector cloneSelector ()
    + + + + +

    + + + + + + + +
    Returns
    UiSelector
    +
    @@ -3268,193 +2783,59 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/uiautomator/UiWatcher.html b/docs/html/reference/android/support/test/uiautomator/UiWatcher.html index bd116268dbf3..91fe670f17c1 100644 --- a/docs/html/reference/android/support/test/uiautomator/UiWatcher.html +++ b/docs/html/reference/android/support/test/uiautomator/UiWatcher.html @@ -1,5 +1,3 @@ - - @@ -93,566 +91,128 @@ - - - - - - -UiWatcher | Android Developers - - - - - - - - - - - - - - - - - - - - - - - -
    - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    + + + + -
    + + + + + + - -
    + + + -
    -
    - +UiWatcher - -
    - public + + + - interface -

    UiWatcher

    +
    +
    +
    + + + +
    + +
    +
    -
    + -
    +

    UiWatcher

    +

    + + public + + + + interface + UiWatcher + +
    -

    - + + + + + - +

    - - + + + + +
    android.support.test.uiautomator.UiWatcher
    android.support.test.uiautomator.UiWatcher +
    + + +

    - - - -
    - - -

    Class Overview

    -

    See registerWatcher(String, UiWatcher) on how to register a +

    See registerWatcher(String, UiWatcher) on how to register a a condition watcher to be called by the automation library. The automation library will invoke checkForCondition() only when a regular API call is in retry mode because it is unable to locate its selector yet. Only during this time, the watchers are invoked to check if there is @@ -662,27 +222,9 @@ type="text/css"> -

    - - - - - - - - - - - - - - -
    - - -

    Summary

    +

    Summary

    @@ -711,38 +253,43 @@ type="text/css"> - - - - - - -
    Public Methods
    - abstract + + - - boolean - - + + + + + - + + +

    + + + +

    Public methods

    - checkForCondition() - -
    - Custom handler that is automatically called when the testing framework is unable to - find a match using the UiSelector - - When the framework is in the process of matching a UiSelector and it + +
    + abstract + + + + + boolean + + + checkForCondition() + + +

    Custom handler that is automatically called when the testing framework is unable to + find a match using the UiSelector + + When the framework is in the process of matching a UiSelector and it is unable to match any widget based on the specified criteria in the selector, the framework will perform retries for a predetermined time, waiting for the display to update and show the desired widget. - - - - - -

    @@ -753,16 +300,6 @@ type="text/css"> - - - - - - - - - - @@ -788,40 +325,30 @@ type="text/css"> -

    Public Methods

    +

    Public methods

    -
    -

    - - public - - - abstract - - boolean - - checkForCondition - () -

    -
    -
    - - - -
    -
    - - +
    +

    checkForCondition

    +
    +
    + + +
    +
    +boolean checkForCondition ()
    + + -

    Custom handler that is automatically called when the testing framework is unable to - find a match using the UiSelector + +

    Custom handler that is automatically called when the testing framework is unable to + find a match using the UiSelector - When the framework is in the process of matching a UiSelector and it + When the framework is in the process of matching a UiSelector and it is unable to match any widget based on the specified criteria in the selector, the framework will perform retries for a predetermined time, waiting for the display to update and show the desired widget. While the framework is in this state, it will call @@ -831,13 +358,16 @@ type="text/css"> An example usage would be to look for dialogs popped due to other background processes requesting user attention and have nothing to do with the application - currently under test.

    -
    -
    Returns
    -
    • true to indicate a matched condition or false for nothing was matched
    -
    + currently under test.

    + + + + + + + +
    Returns
    booleantrue to indicate a matched condition or false for nothing was matched
    -
    @@ -849,193 +379,59 @@ type="text/css"> - -
    - -
    - -
    - - - - - - - + + diff --git a/docs/html/reference/android/support/test/uiautomator/Until.html b/docs/html/reference/android/support/test/uiautomator/Until.html index 8af2f9610349..852cb89f985c 100644 --- a/docs/html/reference/android/support/test/uiautomator/Until.html +++ b/docs/html/reference/android/support/test/uiautomator/Until.html @@ -1,4 +1,3 @@ - @@ -93,512 +92,85 @@ - - - - - - -Until | Android Developers - - - - - - - - - - - - - - - - - - - -
    - +Until - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    +
    + + + +
    - - - - - + + + + + + -
    - - - - -
    +
    -
    - public +

    Until

    +

    + + public + + + + class + Until + +
    + + + + + extends Object + + + + + + + + + + + +

    + + + + + + + + + + + + + + + +
    java.lang.Object +
       ↳android.support.test.uiautomator.Until +
    + + - class -

    Until

    +

    +

    The Until class provides factory methods for constructing common conditions. +

    - extends Object
    +

    Summary

    @@ -663,55 +277,822 @@ Summary: -
    -
    -
    - - - - - - - - -
    java.lang.Object
       ↳android.support.test.uiautomator.Until
    + + + -
    + +
    + + + + + -

    Class Overview

    -

    The Until class provides factory methods for constructing common conditions. -

    +

    Public constructors

    + + Until() + + +
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Public methods

    + + + static + + + UiObject2Condition<Boolean> + + + checkable(boolean isCheckable) + + +

    Returns a condition that depends on a UiObject2's checkable state. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + checked(boolean isChecked) + + +

    Returns a condition that depends on a UiObject2's checked state. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + clickable(boolean isClickable) + + +

    Returns a condition that depends on a UiObject2's clickable state. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + descContains(String substring) + + +

    Returns a condition that is satisfied when the object's content description contains the + given string. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + descEndsWith(String substring) + + +

    Returns a condition that is satisfied when the object's content description ends with the + given string. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + descEquals(String contentDescription) + + +

    Returns a condition that is satisfied when the object's content description exactly matches + the given string. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + descMatches(String regex) + + +

    Returns a condition that is satisfied when the object's content description matches the given + regex. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + descMatches(Pattern regex) + + +

    Returns a condition that is satisfied when the object's content description matches the given + regex. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + descStartsWith(String substring) + + +

    Returns a condition that is satisfied when the object's content description starts with the + given string. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + enabled(boolean isEnabled) + + +

    Returns a condition that depends on a UiObject2's enabled state. + + +

    + +
    + + + static + + + SearchCondition<UiObject2> + + + findObject(BySelector selector) + + +

    Returns a SearchCondition that is satisfied when at least one element matching the + selector can be found. + + +

    + +
    + + + static + + + SearchCondition<List<UiObject2>> + + + findObjects(BySelector selector) + + +

    Returns a SearchCondition that is satisfied when at least one element matching the + selector can be found. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + focusable(boolean isFocusable) + + +

    Returns a condition that depends on a UiObject2's focusable state. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + focused(boolean isFocused) + + +

    Returns a condition that depends on a UiObject2's focused state. + + +

    + +
    + + + static + + + SearchCondition<Boolean> + + + gone(BySelector selector) + + +

    Returns a SearchCondition that is satisfied when no elements matching the selector + can be found. + + +

    + +
    + + + static + + + SearchCondition<Boolean> + + + hasObject(BySelector selector) + + +

    Returns a SearchCondition that is satisfied when at least one element matching the + selector can be found. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + longClickable(boolean isLongClickable) + + +

    Returns a condition that depends on a UiObject2's long clickable state. + + +

    + +
    + + + static + + + EventCondition<Boolean> + + + newWindow() + + +

    Returns a condition that depends on a new window having appeared. + + +

    + +
    + + + static + + + EventCondition<Boolean> + + + scrollFinished(Direction direction) + + +

    Returns a condition that depends on a scroll having reached the end in the given + direction. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + scrollable(boolean isScrollable) + + +

    Returns a condition that depends on a UiObject2's scrollable state. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + selected(boolean isSelected) + + +

    Returns a condition that depends on a UiObject2's selected state. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + textContains(String substring) + + +

    Returns a condition that is satisfied when the object's text value contains the given string. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + textEndsWith(String substring) + + +

    Returns a condition that is satisfied when the object's text value ends with the given + string. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + textEquals(String text) + + +

    Returns a condition that is satisfied when the object's text value exactly matches the given + string. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + textMatches(String regex) + + +

    Returns a condition that is satisfied when the object's text value matches the given regex. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + textMatches(Pattern regex) + + +

    Returns a condition that is satisfied when the object's text value matches the given regex. + + +

    + +
    + + + static + + + UiObject2Condition<Boolean> + + + textNotEquals(String text) + + +
    + + + static + + + UiObject2Condition<Boolean> + + + textStartsWith(String substring) + + +

    Returns a condition that is satisfied when the object's text value starts with the given + string. + + +

    + +
    @@ -719,2040 +1100,1406 @@ Summary: + + + -
    +
    + -

    Summary

    +

    Inherited methods

    + From +class + + + java.lang.Object + + +
    + + +
    +
    + + + + + + +

    Public constructors

    + +
    +

    Until

    +
    +
    + + +
    +
    +Until ()
    + + + +

    +
    - - + + - - - + +
    +

    checkable

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> checkable (boolean isCheckable)
    + + + + +

    Returns a condition that depends on a UiObject2's checkable state.

    +
    Public Constructors
    + + +

    Public methods

    -
    -
    - Until() -
    + + + + + +
    Parameters
    isCheckable + boolean: + Whether the object should be checkable to satisfy this condition. +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    -
    +
    + +
    +

    checked

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> checked (boolean isChecked)
    + + + + +

    Returns a condition that depends on a UiObject2's checked state.

    + + + + + + +
    Parameters
    isChecked + boolean: + Whether the object should be checked to satisfy this condition. +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    +
    - - + +
    +

    clickable

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> clickable (boolean isClickable)
    + + + + +

    Returns a condition that depends on a UiObject2's clickable state.

    +
    Public Methods
    + + + + + +
    Parameters
    isClickable + boolean: + Whether the object should be clickable to satisfy this condition. +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    - - +
    + - static +
    +

    descContains

    +
    +
    + + - UiObject2Condition<Boolean>
    - - - checkable(boolean isCheckable) +
    +
    +UiObject2Condition<Boolean> descContains (String substring)
    + + -
    - Returns a condition that depends on a UiObject2's checkable state. + +

    Returns a condition that is satisfied when the object's content description contains the + given string. +

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    +
    -
    + - +
    +

    descEndsWith

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> descEndsWith (String substring)
    + + + +

    Returns a condition that is satisfied when the object's content description ends with the + given string. +

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    - - +
    + - static +
    +

    descEquals

    +
    +
    + + - UiObject2Condition<Boolean>
    - - - checked(boolean isChecked) +
    +
    +UiObject2Condition<Boolean> descEquals (String contentDescription)
    + + -
    - Returns a condition that depends on a UiObject2's checked state. + +

    Returns a condition that is satisfied when the object's content description exactly matches + the given string. +

    + + + + + + +
    Parameters
    contentDescription + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    +
    -
    + - +
    +

    descMatches

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> descMatches (String regex)
    + + + +

    Returns a condition that is satisfied when the object's content description matches the given + regex. +

    + + + + + + +
    Parameters
    regex + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    - - +
    + - static +
    +

    descMatches

    +
    +
    + + - UiObject2Condition<Boolean>
    - - - clickable(boolean isClickable) +
    +
    +UiObject2Condition<Boolean> descMatches (Pattern regex)
    + + -
    - Returns a condition that depends on a UiObject2's clickable state. + +

    Returns a condition that is satisfied when the object's content description matches the given + regex. +

    + + + + + + +
    Parameters
    regex + Pattern +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    +
    -
    + - +
    +

    descStartsWith

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> descStartsWith (String substring)
    + + + +

    Returns a condition that is satisfied when the object's content description starts with the + given string. +

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    - - +
    + - static +
    +

    enabled

    +
    +
    + + - UiObject2Condition<Boolean>
    - - - descContains(String substring) +
    +
    +UiObject2Condition<Boolean> enabled (boolean isEnabled)
    + + + + +

    Returns a condition that depends on a UiObject2's enabled state.

    + + + + + + +
    Parameters
    isEnabled + boolean: + Whether the object should be enabled to satisfy this condition. +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    -
    - Returns a condition that is satisfied when the object's content description contains the - given string. +
    + -
    +
    +

    findObject

    +
    +
    + + - +
    +
    +SearchCondition<UiObject2> findObject (BySelector selector)
    + + + +

    Returns a SearchCondition that is satisfied when at least one element matching the + selector can be found. The condition will return the first matching element. +

    + + + + + + +
    Parameters
    selector + BySelector +
    + + + + + + +
    Returns
    SearchCondition<UiObject2>
    +
    - - + +
    +

    findObjects

    +
    +
    + + - static +
    +
    +SearchCondition<List<UiObject2>> findObjects (BySelector selector)
    + + - UiObject2Condition<Boolean>
    - - - descEndsWith(String substring) + +

    Returns a SearchCondition that is satisfied when at least one element matching the + selector can be found. The condition will return all matching elements. +

    + + + + + + +
    Parameters
    selector + BySelector +
    + + + + + + +
    Returns
    SearchCondition<List<UiObject2>>
    -
    - Returns a condition that is satisfied when the object's content description ends with the - given string. +
    + -
    +
    +

    focusable

    +
    +
    + + - +
    +
    +UiObject2Condition<Boolean> focusable (boolean isFocusable)
    + + + + +

    Returns a condition that depends on a UiObject2's focusable state.

    + + + + + + +
    Parameters
    isFocusable + boolean: + Whether the object should be focusable to satisfy this condition. +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    +
    - - + +
    +

    focused

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> focused (boolean isFocused)
    + + + + +

    Returns a condition that depends on a UiObject2's focused state.

    + + + + + + +
    Parameters
    isFocused + boolean: + Whether the object should be focused to satisfy this condition. +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    - static +
    - UiObject2Condition<Boolean>
    - - - descEquals(String contentDescription) -
    - Returns a condition that is satisfied when the object's content description exactly matches - the given string. + +
    +

    gone

    +
    +
    + + +
    +
    +SearchCondition<Boolean> gone (BySelector selector)
    + + -
    + +

    Returns a SearchCondition that is satisfied when no elements matching the selector + can be found. +

    + + + + + + +
    Parameters
    selector + BySelector +
    + + + + + + +
    Returns
    SearchCondition<Boolean>
    - +
    + - - +
    +

    hasObject

    +
    +
    + + +
    +
    +SearchCondition<Boolean> hasObject (BySelector selector)
    + + + +

    Returns a SearchCondition that is satisfied when at least one element matching the + selector can be found. +

    + + + + + + +
    Parameters
    selector + BySelector +
    + + + + + + +
    Returns
    SearchCondition<Boolean>
    - static +
    - UiObject2Condition<Boolean>
    - - - descMatches(Pattern regex) -
    - Returns a condition that is satisfied when the object's content description matches the given - regex. + +
    +

    longClickable

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> longClickable (boolean isLongClickable)
    + + + + +

    Returns a condition that depends on a UiObject2's long clickable state.

    + + + + + + +
    Parameters
    isLongClickable + boolean: + Whether the object should be long clickable to satisfy this condition. +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    -
    +
    - + +
    +

    newWindow

    +
    +
    + + - - +
    +
    +EventCondition<Boolean> newWindow ()
    + + + + +

    Returns a condition that depends on a new window having appeared.

    + + + + + + +
    Returns
    EventCondition<Boolean>
    +
    - static + - UiObject2Condition<Boolean> - - - descMatches(String regex) +
    +

    scrollFinished

    +
    +
    + + -
    - Returns a condition that is satisfied when the object's content description matches the given - regex. +
    +
    +EventCondition<Boolean> scrollFinished (Direction direction)
    + + + + +

    Returns a condition that depends on a scroll having reached the end in the given + direction.

    + + + + + + +
    Parameters
    direction + Direction: + The direction of the scroll. +
    + + + + + + +
    Returns
    EventCondition<Boolean>
    +
    -
    + - +
    +

    scrollable

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> scrollable (boolean isScrollable)
    + + + + +

    Returns a condition that depends on a UiObject2's scrollable state.

    + + + + + + +
    Parameters
    isScrollable + boolean: + Whether the object should be scrollable to satisfy this condition. +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    - - - - - - - static - - UiObject2Condition<Boolean> - - - descStartsWith(String substring) - -
    - Returns a condition that is satisfied when the object's content description starts with the - given string. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - enabled(boolean isEnabled) - -
    - Returns a condition that depends on a UiObject2's enabled state. - - - -
    - - - - - - - - - - - static - - SearchCondition<UiObject2> - - - findObject(BySelector selector) - -
    - Returns a SearchCondition that is satisfied when at least one element matching the - selector can be found. - - - -
    - - - - - - - - - - - static - - SearchCondition<List<UiObject2>> - - - findObjects(BySelector selector) - -
    - Returns a SearchCondition that is satisfied when at least one element matching the - selector can be found. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - focusable(boolean isFocusable) - -
    - Returns a condition that depends on a UiObject2's focusable state. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - focused(boolean isFocused) - -
    - Returns a condition that depends on a UiObject2's focused state. - - - -
    - - - - - - - - - - - static - - SearchCondition<Boolean> - - - gone(BySelector selector) - -
    - Returns a SearchCondition that is satisfied when no elements matching the selector - can be found. - - - -
    - - - - - - - - - - - static - - SearchCondition<Boolean> - - - hasObject(BySelector selector) - -
    - Returns a SearchCondition that is satisfied when at least one element matching the - selector can be found. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - longClickable(boolean isLongClickable) - -
    - Returns a condition that depends on a UiObject2's long clickable state. - - - -
    - - - - - - - - - - - static - - EventCondition<Boolean> - - - newWindow() - -
    - Returns a condition that depends on a new window having appeared. - - - -
    - - - - - - - - - - - static - - EventCondition<Boolean> - - - scrollFinished(Direction direction) - -
    - Returns a condition that depends on a scroll having reached the end in the given - direction. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - scrollable(boolean isScrollable) - -
    - Returns a condition that depends on a UiObject2's scrollable state. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - selected(boolean isSelected) - -
    - Returns a condition that depends on a UiObject2's selected state. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - textContains(String substring) - -
    - Returns a condition that is satisfied when the object's text value contains the given string. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - textEndsWith(String substring) - -
    - Returns a condition that is satisfied when the object's text value ends with the given - string. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - textEquals(String text) - -
    - Returns a condition that is satisfied when the object's text value exactly matches the given - string. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - textMatches(String regex) - -
    - Returns a condition that is satisfied when the object's text value matches the given regex. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - textMatches(Pattern regex) - -
    - Returns a condition that is satisfied when the object's text value matches the given regex. - - - -
    - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - textNotEquals(String text) - - - - - - - - - - - static - - UiObject2Condition<Boolean> - - - textStartsWith(String substring) - -
    - Returns a condition that is satisfied when the object's text value starts with the given - string. - - - -
    - - - - - - - - - - - - - - - - - - - - - -
    - [Expand] -
    Inherited Methods
    - -From class - - java.lang.Object - -
    - - -
    -
    - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Public Constructors

    - - - - - -
    -

    - - public - - - - - - - Until - () -

    -
    -
    - - - -
    -
    - - - - -

    - -
    -
    - - - - - - - - - - - - - -

    Public Methods

    - - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - checkable - (boolean isCheckable) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that depends on a UiObject2's checkable state.

    -
    -
    Parameters
    - - - - -
    isCheckable - Whether the object should be checkable to satisfy this condition. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - checked - (boolean isChecked) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that depends on a UiObject2's checked state.

    -
    -
    Parameters
    - - - - -
    isChecked - Whether the object should be checked to satisfy this condition. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - clickable - (boolean isClickable) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that depends on a UiObject2's clickable state.

    -
    -
    Parameters
    - - - - -
    isClickable - Whether the object should be clickable to satisfy this condition. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - descContains - (String substring) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that is satisfied when the object's content description contains the - given string. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - descEndsWith - (String substring) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that is satisfied when the object's content description ends with the - given string. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - descEquals - (String contentDescription) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that is satisfied when the object's content description exactly matches - the given string. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - descMatches - (Pattern regex) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that is satisfied when the object's content description matches the given - regex. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - descMatches - (String regex) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that is satisfied when the object's content description matches the given - regex. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - descStartsWith - (String substring) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that is satisfied when the object's content description starts with the - given string. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - enabled - (boolean isEnabled) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that depends on a UiObject2's enabled state.

    -
    -
    Parameters
    - - - - -
    isEnabled - Whether the object should be enabled to satisfy this condition. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - SearchCondition<UiObject2> - - findObject - (BySelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a SearchCondition that is satisfied when at least one element matching the - selector can be found. The condition will return the first matching element. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - SearchCondition<List<UiObject2>> - - findObjects - (BySelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a SearchCondition that is satisfied when at least one element matching the - selector can be found. The condition will return all matching elements. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - focusable - (boolean isFocusable) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that depends on a UiObject2's focusable state.

    -
    -
    Parameters
    - - - - -
    isFocusable - Whether the object should be focusable to satisfy this condition. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - focused - (boolean isFocused) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that depends on a UiObject2's focused state.

    -
    -
    Parameters
    - - - - -
    isFocused - Whether the object should be focused to satisfy this condition. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - SearchCondition<Boolean> - - gone - (BySelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a SearchCondition that is satisfied when no elements matching the selector - can be found. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - SearchCondition<Boolean> - - hasObject - (BySelector selector) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a SearchCondition that is satisfied when at least one element matching the - selector can be found. -

    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - longClickable - (boolean isLongClickable) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that depends on a UiObject2's long clickable state.

    -
    -
    Parameters
    - - - - -
    isLongClickable - Whether the object should be long clickable to satisfy this condition. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - EventCondition<Boolean> - - newWindow - () -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that depends on a new window having appeared.

    - -
    -
    - - - - -
    -

    - - public - static - - - - EventCondition<Boolean> - - scrollFinished - (Direction direction) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that depends on a scroll having reached the end in the given - direction.

    -
    -
    Parameters
    - - - - -
    direction - The direction of the scroll. -
    -
    - -
    -
    - - - - -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - scrollable - (boolean isScrollable) -

    -
    -
    - - - -
    -
    - - - - -

    Returns a condition that depends on a UiObject2's scrollable state.

    -
    -
    Parameters
    - - - - -
    isScrollable - Whether the object should be scrollable to satisfy this condition. -
    -
    - -
    -
    +
    -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - selected - (boolean isSelected) -

    -
    -
    - - - -
    -
    - +
    +

    selected

    +
    +
    + + - - -

    Returns a condition that depends on a UiObject2's selected state.

    -
    -
    Parameters
    - - - +
    isSelected - Whether the object should be selected to satisfy this condition. + +
    +UiObject2Condition<Boolean> selected (boolean isSelected)
    + + + + +

    Returns a condition that depends on a UiObject2's selected state.

    + + + + + - -
    Parameters
    isSelected + boolean: + Whether the object should be selected to satisfy this condition.
    - +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    -
    -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - textContains - (String substring) -

    -
    -
    - - - -
    -
    - - +
    +

    textContains

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> textContains (String substring)
    + + -

    Returns a condition that is satisfied when the object's text value contains the given string. -

    + +

    Returns a condition that is satisfied when the object's text value contains the given string. +

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    -
    -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - textEndsWith - (String substring) -

    -
    -
    - - - -
    -
    - - +
    +

    textEndsWith

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> textEndsWith (String substring)
    + + -

    Returns a condition that is satisfied when the object's text value ends with the given + +

    Returns a condition that is satisfied when the object's text value ends with the given string. -

    +

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    -
    -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - textEquals - (String text) -

    -
    -
    - - - -
    -
    - - +
    +

    textEquals

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> textEquals (String text)
    + + -

    Returns a condition that is satisfied when the object's text value exactly matches the given + +

    Returns a condition that is satisfied when the object's text value exactly matches the given string. -

    +

    + + + + + + +
    Parameters
    text + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    -
    -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - textMatches - (String regex) -

    -
    -
    - - - -
    -
    - - +
    +

    textMatches

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> textMatches (String regex)
    + + -

    Returns a condition that is satisfied when the object's text value matches the given regex. -

    + +

    Returns a condition that is satisfied when the object's text value matches the given regex. +

    + + + + + + +
    Parameters
    regex + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    -
    -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - textMatches - (Pattern regex) -

    -
    -
    - - - -
    -
    - - +
    +

    textMatches

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> textMatches (Pattern regex)
    + + -

    Returns a condition that is satisfied when the object's text value matches the given regex. -

    + +

    Returns a condition that is satisfied when the object's text value matches the given regex. +

    + + + + + + +
    Parameters
    regex + Pattern +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    -
    -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - textNotEquals - (String text) -

    -
    -
    - - - -
    -
    - - - - -

    +
    +

    textNotEquals

    +
    +
    + +
    +
    +UiObject2Condition<Boolean> textNotEquals (String text)
    + + + + +

    + + + + + + +
    Parameters
    text + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    +
    -
    -

    - - public - static - - - - UiObject2Condition<Boolean> - - textStartsWith - (String substring) -

    -
    -
    - - - -
    -
    - - +
    +

    textStartsWith

    +
    +
    + + +
    +
    +UiObject2Condition<Boolean> textStartsWith (String substring)
    + + -

    Returns a condition that is satisfied when the object's text value starts with the given + +

    Returns a condition that is satisfied when the object's text value starts with the given string. -

    +

    + + + + + + +
    Parameters
    substring + String +
    + + + + + + +
    Returns
    UiObject2Condition<Boolean>
    -
    @@ -2764,193 +2511,59 @@ From class - -
    - -
    - -
    - - -
    - -
    -
    +
    + diff --git a/docs/html/reference/android/support/test/uiautomator/package-summary.html b/docs/html/reference/android/support/test/uiautomator/package-summary.html index 6ea3ad118d41..07af2b66bd2f 100644 --- a/docs/html/reference/android/support/test/uiautomator/package-summary.html +++ b/docs/html/reference/android/support/test/uiautomator/package-summary.html @@ -1,4 +1,3 @@ - @@ -93,1007 +92,405 @@ - - - - - - -android.support.test.uiautomator | Android Developers - - - - + + + + + + + - - + + + + - - - - - + + + - + - +android.support.test.uiautomator - - - - - - - - - - -
    - - - -
    - - - - - - - - - - - -
    -
    -
    -
    -
    - -
    - -
    -
    -
    Android APIs
    -
    - - - - -
    -
    - - - - - - -
    +
    - - - + + +
    +
    -
    - package -

    android.support.test.uiautomator

    -
    - -
    - -
    - - +

    android.support.test.uiautomator

    + +

    Interfaces

    -
    - - + + - + - + - - + + - + - - + +
    IAutomationSupportIAutomationSupport Provides auxiliary support for running test cases  - - + +
    UiWatcherUiWatcher - See registerWatcher(String, UiWatcher) on how to register a + See registerWatcher(String, UiWatcher) on how to register a a condition watcher to be called by the automation library.  - - + +
    -
    - - + +

    Classes

    -
    - - + + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + +
    ByBy -

    By is a utility class which enables the creation of BySelectors in a concise +

    By is a utility class which enables the creation of BySelectors in a concise manner.  - - + +

    BySelectorBySelector - A BySelector specifies criteria for matching UI elements during a call to - findObject(BySelector).  - - + A BySelector specifies criteria for matching UI elements during a call to + findObject(BySelector).  + +
    ConfiguratorConfigurator Allows you to set key parameters for running uiautomator tests.  - - + +
    EventCondition<R>EventCondition<R> - An EventCondition is a condition which depends on an event or series of events having + An EventCondition is a condition which depends on an event or series of events having occurred.  - - + +
    SearchCondition<R>SearchCondition<R> - A SearchCondition is a condition that is satisfied by searching for UI elements.  - - + A SearchCondition is a condition that is satisfied by searching for UI elements.  + +
    UiAutomatorInstrumentationTestRunnerUiAutomatorInstrumentationTestRunner - Test runner for UiAutomatorTestCases.  - - + Test runner for UiAutomatorTestCases.  + +
    UiAutomatorTestCaseUiAutomatorTestCase This class is deprecated. It is no longer necessary to extend UiAutomatorTestCase. You can use - getInstance(Instrumentation) from any test class as long as you have access to - an Instrumentation instance. + getInstance(Instrumentation) from any test class as long as you have access to + an Instrumentation instance.   - - + +
    UiCollectionUiCollection Used to enumerate a container's UI elements for the purpose of counting, or targeting a sub elements by a child's text or description.  - - + +
    UiDeviceUiDevice UiDevice provides access to state information about the device.  - - + +
    UiObjectUiObject A UiObject is a representation of a view.  - - + +
    UiObject2UiObject2 - A UiObject2 represents a UI element.  - - + A UiObject2 represents a UI element.  + +
    UiObject2Condition<R>UiObject2Condition<R> - A UiObject2Condition is a condition which is satisfied when a UiObject2 is in a + A UiObject2Condition is a condition which is satisfied when a UiObject2 is in a particular state.  - - + +
    UiScrollableUiScrollable - UiScrollable is a UiCollection and provides support for searching + UiScrollable is a UiCollection and provides support for searching for items in scrollable layout elements.  - - + +
    UiSelectorUiSelector Specifies the elements in the layout hierarchy for tests to target, filtered by properties such as text value, content-description, class name, and state information.  - - + +
    UntilUntil - The Until class provides factory methods for constructing common conditions.  - - + The Until class provides factory methods for constructing common conditions.  + +
    -
    - - + +

    Enums

    -
    - - + + - + - + - - + +
    DirectionDirection An enumeration used to specify the primary direction of certain gestures.  - - + +
    -
    - - + +

    Exceptions

    -
    - - + + - + - + - - + + - + + + +
    StaleObjectExceptionStaleObjectException - A StaleObjectException exception is thrown when a UiObject2 is used after the - underlying View has been destroyed.  - - + A StaleObjectException exception is thrown when a UiObject2 is used after the + underlying View has been destroyed.  + +
    UiObjectNotFoundExceptionUiObjectNotFoundException - Generated in test runs when a UiSelector selector could not be matched + Generated in test runs when a UiSelector selector could not be matched to any UI element displayed.  - - + +
    + - -
    - - - - - - -
    - -
    - -
    - - - -
    - -
    -
    + +
    + + -- GitLab