1 /*
2  * Copyright 2023 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.paging
18 
19 /**
20  * Interface for a factory that generates [PagingSource].
21  *
22  * The factory extending this interface can be used to instantiate a [Pager] as the
23  * pagingSourceFactory.
24  */
25 public fun interface PagingSourceFactory<Key : Any, Value : Any> : () -> PagingSource<Key, Value> {
26     /**
27      * Returns a new PagingSource instance.
28      *
29      * This function can be invoked by calling pagingSourceFactory() or pagingSourceFactory::invoke.
30      */
invokenull31     public override operator fun invoke(): PagingSource<Key, Value>
32 }
33