1 /*
2  * Copyright (C) 2017 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 package com.android.launcher3.search;
17 
18 /**
19  * An interface for handling search.
20  *
21  * @param <T> Search Result type
22  */
23 public interface SearchAlgorithm<T> {
24 
25     /**
26      * Performs search and sends the result to {@link SearchCallback}.
27      */
doSearch(String query, SearchCallback<T> callback)28     void doSearch(String query, SearchCallback<T> callback);
29 
30     /**
31      * Performs search with {@code query} and the {@code suggestedQueries}/
32      */
doSearch(String query, String[] suggestedQueries, SearchCallback<T> callback)33     default void doSearch(String query, String[] suggestedQueries, SearchCallback<T> callback) {
34         doSearch(query, callback);
35     }
36 
37     /**
38      * Cancels any active request.
39      */
cancel(boolean interruptActiveRequests)40     void cancel(boolean interruptActiveRequests);
41 
42     /**
43      * Cleans up after search is no longer needed.
44      */
destroy()45     default void destroy() {};
46 }
47