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 17 package io.appium.droiddriver.finders; 18 19 import io.appium.droiddriver.UiElement; 20 import io.appium.droiddriver.exceptions.ElementNotFoundException; 21 22 /** 23 * Interface for finding UiElement. 24 */ 25 public interface Finder { 26 /** 27 * Returns the matching UiElement. The implementing finder should not poll. 28 * <p> 29 * Invisible UiElements are skipped. 30 * 31 * @param context The starting UiElement, used as search context 32 * @return The first matching element on the current context 33 * @throws ElementNotFoundException If no matching elements are found 34 */ 35 UiElement find(UiElement context); 36 37 /** 38 * {@inheritDoc} 39 * 40 * <p> 41 * It is recommended that this method return the description of the finder, 42 * for example, "{text=OK}". 43 */ 44 @Override 45 String toString(); 46 } 47
