1 /*
2  * Copyright (C) 2014 The Android Open Source Project
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 androidx.test.uiautomator;
18 
19 import org.jspecify.annotations.NonNull;
20 
21 import java.util.List;
22 
23 /** The Searchable interface represents an object that can be searched for matching UI elements. */
24 interface Searchable {
25 
26     /** Returns whether there is a match for the given {@code selector} criteria. */
hasObject(@onNull BySelector selector)27     boolean hasObject(@NonNull BySelector selector);
28 
29     /** Returns the first object to match the {@code selector} criteria. */
findObject(@onNull BySelector selector)30     UiObject2 findObject(@NonNull BySelector selector);
31 
32     /** Returns all objects that match the {@code selector} criteria. */
findObjects(@onNull BySelector selector)33     @NonNull List<UiObject2> findObjects(@NonNull BySelector selector);
34 }
35