aboutsummaryrefslogtreecommitdiff
path: root/src/io/appium/droiddriver/actions/Action.java
diff options
context:
space:
mode:
authorKevin Jin <kjin@google.com>2015-02-20 09:35:39 -0800
committerKevin Jin <kjin@google.com>2015-02-20 14:37:53 -0800
commit4b31201b5a2dbf8036da5a8d089a68a39cc1dc44 (patch)
tree0a4a6d976ca45f3b87433927d57d50cb3cd51b41 /src/io/appium/droiddriver/actions/Action.java
parent85a1731f32032690e528a6ca1084aa148200569b (diff)
downloaddroiddriver-4b31201b5a2dbf8036da5a8d089a68a39cc1dc44.tar.gz
rename package 'com.google.android' to 'io.appium'
Change-Id: I2c7c96cd6a6971806e2ea7b06cd6c2c6666e4340
Diffstat (limited to 'src/io/appium/droiddriver/actions/Action.java')
-rw-r--r--src/io/appium/droiddriver/actions/Action.java55
1 files changed, 55 insertions, 0 deletions
diff --git a/src/io/appium/droiddriver/actions/Action.java b/src/io/appium/droiddriver/actions/Action.java
new file mode 100644
index 0000000..34d1562
--- /dev/null
+++ b/src/io/appium/droiddriver/actions/Action.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright (C) 2013 DroidDriver committers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appium.droiddriver.actions;
+
+import io.appium.droiddriver.UiElement;
+
+/**
+ * Interface for performing action on a UiElement. An action is a high-level
+ * user interaction that can be performed in various ways, for example, via
+ * synthesized events, or the Accessibility API.
+ */
+public interface Action {
+ /**
+ * Performs the action.
+ *
+ * @param element the Ui element to perform the action on
+ * @return Whether the action is successful. Some actions throw exceptions in
+ * case of failure, when that behavior is more appropriate. For
+ * example, if event injection returns false.
+ */
+ boolean perform(UiElement element);
+
+ /**
+ * Gets the timeout to wait for an indicator that the action has been carried
+ * out. Different DroidDriver implementations use this value in different
+ * ways. For example, UiAutomationDriver waits for AccessibilityEvent up to
+ * this value. InstrumentationDriver ignores this value because it
+ * synchronizes on the event loop.
+ */
+ long getTimeoutMillis();
+
+ /**
+ * {@inheritDoc}
+ *
+ * <p>
+ * It is recommended that this method return the description of the action,
+ * for example, "SwipeAction{DOWN}".
+ */
+ @Override
+ String toString();
+}