BaseDroidDriver.java revision e4de29ac873c9e0ffaec34832dcc8b120850d8f7 
1/*
2 * Copyright (C) 2013 DroidDriver committers
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.google.android.droiddriver.base;
18
19import com.google.android.droiddriver.DroidDriver;
20import com.google.android.droiddriver.Poller;
21import com.google.android.droiddriver.UiElement;
22import com.google.android.droiddriver.exceptions.ElementNotFoundException;
23import com.google.android.droiddriver.exceptions.TimeoutException;
24import com.google.android.droiddriver.finders.ByXPath;
25import com.google.android.droiddriver.finders.Finder;
26import com.google.android.droiddriver.util.Logs;
27
28/**
29 * Abstract implementation of DroidDriver that does the common actions, and
30 * should not differ in implementations of {@link DroidDriver}.
31 */
32public abstract class BaseDroidDriver implements DroidDriver {
33
34  private Poller poller = new DefaultPoller();
35  private BaseUiElement rootElement;
36
37  @Override
38  public UiElement find(Finder finder) {
39    Logs.call(this, "find", finder);
40    return finder.find(getRootElement());
41  }
42
43  @Override
44  public boolean has(Finder finder) {
45    try {
46      refreshUiElementTree();
47      find(finder);
48      return true;
49    } catch (ElementNotFoundException enfe) {
50      return false;
51    }
52  }
53
54  @Override
55  public boolean has(Finder finder, long timeoutMillis) {
56    try {
57      getPoller().pollFor(this, finder, Poller.EXISTS, timeoutMillis);
58      return true;
59    } catch (TimeoutException e) {
60      return false;
61    }
62  }
63
64  @Override
65  public UiElement on(Finder finder) {
66    Logs.call(this, "on", finder);
67    return getPoller().pollFor(this, finder, Poller.EXISTS);
68  }
69
70  @Override
71  public void checkExists(Finder finder) {
72    Logs.call(this, "checkExists", finder);
73    getPoller().pollFor(this, finder, Poller.EXISTS);
74  }
75
76  @Override
77  public void checkGone(Finder finder) {
78    Logs.call(this, "checkGone", finder);
79    getPoller().pollFor(this, finder, Poller.GONE);
80  }
81
82  @Override
83  public Poller getPoller() {
84    return poller;
85  }
86
87  @Override
88  public void setPoller(Poller poller) {
89    this.poller = poller;
90  }
91
92  protected abstract BaseUiElement getNewRootElement();
93
94  protected abstract DroidDriverContext getContext();
95
96  protected BaseUiElement getRootElement() {
97    if (rootElement == null) {
98      refreshUiElementTree();
99    }
100    return rootElement;
101  }
102
103  @Override
104  public void refreshUiElementTree() {
105    getContext().clearData();
106    rootElement = getNewRootElement();
107  }
108
109  @Override
110  public boolean dumpUiElementTree(String path) {
111    Logs.call(this, "dumpUiElementTree", path);
112    return ByXPath.dumpDom(path, getRootElement());
113  }
114}
115