1 /*
2  * Copyright 2024 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.pdf.data;
18 
19 import androidx.annotation.RestrictTo;
20 
21 import org.jspecify.annotations.NonNull;
22 
23 /**
24  * Supply a value that may take a long time to complete.
25  *
26  * @param <T> The type of the value to be supplied.
27  */
28 @RestrictTo(RestrictTo.Scope.LIBRARY)
29 public interface Supplier<T> {
30 
31     /**
32      * A blocking call to supply the value or throw an Exception.
33      *
34      * @param progress Used to report the progress of supplying the value.
35      * @return The value to be passed to {@link FutureValue.Callback#available(Object)} on the main
36      * thread.
37      * @throws Exception Any exception thrown will be {@link FutureValue.Callback#failed(Throwable)}
38      */
supply(@onNull Progress progress)39     T supply(@NonNull Progress progress) throws Exception;
40 }
41