blob: 511d717015738db6ef04ac1ef15190185f736803 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
/*
* Copyright 2020 The Android Open Source Project
*
* 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 android.app.appsearch;
import android.annotation.NonNull;
import com.google.common.util.concurrent.ListenableFuture;
import java.io.Closeable;
import java.util.List;
/**
* Encapsulates results of a search operation.
*
* <p>Each {@link AppSearchSessionShim#search} operation returns a list of {@link SearchResult}
* objects, referred to as a "page", limited by the size configured by {@link
* SearchSpec.Builder#setResultCountPerPage}.
*
* <p>To fetch a page of results, call {@link #getNextPageAsync()}.
*
* <p>All instances of {@link SearchResultsShim} must call {@link SearchResultsShim#close()} after
* the results are fetched.
*
* <p>This class is not thread safe.
*/
public interface SearchResultsShim extends Closeable {
/**
* Retrieves the next page of {@link SearchResult} objects.
*
* <p>The page size is configured by {@link SearchSpec.Builder#setResultCountPerPage}.
*
* <p>Continue calling this method to access results until it returns an empty list, signifying
* there are no more results.
*
* @return a {@link ListenableFuture} which resolves to a list of {@link SearchResult} objects.
*/
@NonNull
ListenableFuture<List<SearchResult>> getNextPageAsync();
@Override
void close();
}
|
