diff options
Diffstat (limited to 'src/io/appium/droiddriver/finders/Finder.java')
-rw-r--r-- | src/io/appium/droiddriver/finders/Finder.java | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/src/io/appium/droiddriver/finders/Finder.java b/src/io/appium/droiddriver/finders/Finder.java new file mode 100644 index 0000000..fef83ae --- /dev/null +++ b/src/io/appium/droiddriver/finders/Finder.java @@ -0,0 +1,46 @@ +/* + * 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.finders; + +import io.appium.droiddriver.UiElement; +import io.appium.droiddriver.exceptions.ElementNotFoundException; + +/** + * Interface for finding UiElement. + */ +public interface Finder { + /** + * Returns the matching UiElement. The implementing finder should not poll. + * <p> + * Invisible UiElements are skipped. + * + * @param context The starting UiElement, used as search context + * @return The first matching element on the current context + * @throws ElementNotFoundException If no matching elements are found + */ + UiElement find(UiElement context); + + /** + * {@inheritDoc} + * + * <p> + * It is recommended that this method return the description of the finder, + * for example, "{text=OK}". + */ + @Override + String toString(); +} |