[go: nahoru, domu]
Google Git
Sign in
android / platform / frameworks / support / cfd1258a8911348898cd07d1b02b00d14917159d / . / paging / common / api / current.txt
blob: 03b61f80d083cadf6b9cd03c3751c62e5a28cc3d [file] [log] [blame]
Aurimas Liutikas3aa5a202020-10-05 09:42:14 -0700[diff] [blame]1// Signature format: 4.0
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]2package androidx.paging {
3
Dustin Lamc019a722020-01-10 13:37:18 -0800[diff] [blame]4 public final class CachedPagingDataKt {
Chris Craik1933a6a2020-03-11 12:11:30 -0700[diff] [blame]5 method @CheckResult public static <T> kotlinx.coroutines.flow.Flow<androidx.paging.PagingData<T>> cachedIn(kotlinx.coroutines.flow.Flow<androidx.paging.PagingData<T>>, kotlinx.coroutines.CoroutineScope scope);
Yigit Boyarc77bc772019-12-20 13:14:12 -0800[diff] [blame]6 }
7
Dustin Lambfb40382020-01-14 15:17:18 -0800[diff] [blame]8 public final class CancelableChannelFlowKt {
9 }
10
Chris Craike8cdbf12020-05-14 16:17:01 -0700[diff] [blame]11 public final class CombinedLoadStates {
Dustin Lamb03819f2020-11-25 17:18:32 -0800[diff] [blame]12 ctor public CombinedLoadStates(androidx.paging.LoadState refresh, androidx.paging.LoadState prepend, androidx.paging.LoadState append, androidx.paging.LoadStates source, androidx.paging.LoadStates? mediator);
Chris Craike8cdbf12020-05-14 16:17:01 -0700[diff] [blame]13 method public androidx.paging.LoadState getAppend();
14 method public androidx.paging.LoadStates? getMediator();
15 method public androidx.paging.LoadState getPrepend();
16 method public androidx.paging.LoadState getRefresh();
17 method public androidx.paging.LoadStates getSource();
18 property public final androidx.paging.LoadState append;
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]19 property public final androidx.paging.LoadStates? mediator;
Chris Craike8cdbf12020-05-14 16:17:01 -0700[diff] [blame]20 property public final androidx.paging.LoadState prepend;
21 property public final androidx.paging.LoadState refresh;
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]22 property public final androidx.paging.LoadStates source;
Chris Craike8cdbf12020-05-14 16:17:01 -0700[diff] [blame]23 }
24
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]25 public abstract class DataSource<Key, Value> {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]26 method @AnyThread public void addInvalidatedCallback(androidx.paging.DataSource.InvalidatedCallback onInvalidatedCallback);
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]27 method @AnyThread public void invalidate();
28 method @WorkerThread public boolean isInvalid();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]29 method public <ToValue> androidx.paging.DataSource<Key,ToValue> map(androidx.arch.core.util.Function<Value,ToValue> function);
30 method public <ToValue> androidx.paging.DataSource<Key,ToValue> mapByPage(androidx.arch.core.util.Function<java.util.List<Value>,java.util.List<ToValue>> function);
31 method @AnyThread public void removeInvalidatedCallback(androidx.paging.DataSource.InvalidatedCallback onInvalidatedCallback);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]32 property @WorkerThread public boolean isInvalid;
33 }
34
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]35 public abstract static class DataSource.Factory<Key, Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]36 ctor public DataSource.Factory();
Aurimas Liutikas3aa5a202020-10-05 09:42:14 -0700[diff] [blame]37 method public final kotlin.jvm.functions.Function0<androidx.paging.PagingSource<Key,Value>> asPagingSourceFactory(optional kotlinx.coroutines.CoroutineDispatcher fetchDispatcher);
Dustin Lamcaee0ab2020-01-10 15:59:37 -0800[diff] [blame]38 method public final kotlin.jvm.functions.Function0<androidx.paging.PagingSource<Key,Value>> asPagingSourceFactory();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]39 method public abstract androidx.paging.DataSource<Key,Value> create();
40 method public <ToValue> androidx.paging.DataSource.Factory<Key,ToValue> map(androidx.arch.core.util.Function<Value,ToValue> function);
41 method public <ToValue> androidx.paging.DataSource.Factory<Key,ToValue> mapByPage(androidx.arch.core.util.Function<java.util.List<Value>,java.util.List<ToValue>> function);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]42 }
43
Dustin Lam0680b892020-09-03 20:19:24 -0700[diff] [blame]44 public static fun interface DataSource.InvalidatedCallback {
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]45 method @AnyThread public void onInvalidated();
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]46 }
47
Aurimas Liutikas3ec16722020-05-27 13:08:04 -0700[diff] [blame]48 @kotlin.RequiresOptIn public @interface ExperimentalPagingApi {
Dustin Lam34f31e42020-04-28 23:45:46 -0700[diff] [blame]49 }
50
Clara F5ac03b42020-11-19 21:07:43 -0500[diff] [blame]51 public abstract class InvalidatingPagingSourceFactory<Key, Value> implements kotlin.jvm.functions.Function0<androidx.paging.PagingSource<Key,Value>> {
52 ctor public InvalidatingPagingSourceFactory(kotlin.jvm.functions.Function0<? extends androidx.paging.PagingSource<Key,Value>> pagingSourceFactory);
53 method public final void invalidate();
54 method public final androidx.paging.PagingSource<Key,Value> invoke();
55 }
56
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]57 @Deprecated public abstract class ItemKeyedDataSource<Key, Value> extends androidx.paging.DataSource<Key,Value> {
58 ctor @Deprecated public ItemKeyedDataSource();
59 method @Deprecated public abstract Key getKey(Value item);
60 method @Deprecated public abstract void loadAfter(androidx.paging.ItemKeyedDataSource.LoadParams<Key> params, androidx.paging.ItemKeyedDataSource.LoadCallback<Value> callback);
61 method @Deprecated public abstract void loadBefore(androidx.paging.ItemKeyedDataSource.LoadParams<Key> params, androidx.paging.ItemKeyedDataSource.LoadCallback<Value> callback);
62 method @Deprecated public abstract void loadInitial(androidx.paging.ItemKeyedDataSource.LoadInitialParams<Key> params, androidx.paging.ItemKeyedDataSource.LoadInitialCallback<Value> callback);
63 method @Deprecated public final <ToValue> androidx.paging.ItemKeyedDataSource<Key,ToValue> map(androidx.arch.core.util.Function<Value,ToValue> function);
64 method @Deprecated public final <ToValue> androidx.paging.ItemKeyedDataSource<Key,ToValue> map(kotlin.jvm.functions.Function1<? super Value,? extends ToValue> function);
65 method @Deprecated public final <ToValue> androidx.paging.ItemKeyedDataSource<Key,ToValue> mapByPage(androidx.arch.core.util.Function<java.util.List<Value>,java.util.List<ToValue>> function);
66 method @Deprecated public final <ToValue> androidx.paging.ItemKeyedDataSource<Key,ToValue> mapByPage(kotlin.jvm.functions.Function1<? super java.util.List<? extends Value>,? extends java.util.List<? extends ToValue>> function);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]67 }
68
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]69 @Deprecated public abstract static class ItemKeyedDataSource.LoadCallback<Value> {
70 ctor @Deprecated public ItemKeyedDataSource.LoadCallback();
71 method @Deprecated public abstract void onResult(java.util.List<? extends Value> data);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]72 }
73
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]74 @Deprecated public abstract static class ItemKeyedDataSource.LoadInitialCallback<Value> extends androidx.paging.ItemKeyedDataSource.LoadCallback<Value> {
75 ctor @Deprecated public ItemKeyedDataSource.LoadInitialCallback();
76 method @Deprecated public abstract void onResult(java.util.List<? extends Value> data, int position, int totalCount);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]77 }
78
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]79 @Deprecated public static class ItemKeyedDataSource.LoadInitialParams<Key> {
80 ctor @Deprecated public ItemKeyedDataSource.LoadInitialParams(Key? requestedInitialKey, int requestedLoadSize, boolean placeholdersEnabled);
81 field @Deprecated public final boolean placeholdersEnabled;
82 field @Deprecated public final Key? requestedInitialKey;
83 field @Deprecated public final int requestedLoadSize;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]84 }
85
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]86 @Deprecated public static class ItemKeyedDataSource.LoadParams<Key> {
87 ctor @Deprecated public ItemKeyedDataSource.LoadParams(Key key, int requestedLoadSize);
88 field @Deprecated public final Key key;
89 field @Deprecated public final int requestedLoadSize;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]90 }
91
Dustin Lamcf7bd952020-07-23 19:26:03 -0700[diff] [blame]92 public final class ItemSnapshotList<T> extends kotlin.collections.AbstractList<T> {
Aurimas Liutikasa3bfa992020-08-05 16:32:56 -0700[diff] [blame]93 ctor public ItemSnapshotList(@IntRange(from=0) int placeholdersBefore, @IntRange(from=0) int placeholdersAfter, java.util.List<? extends T> items);
Dustin Lamcf7bd952020-07-23 19:26:03 -0700[diff] [blame]94 method public T? get(int index);
95 method public java.util.List<T> getItems();
96 method public int getPlaceholdersAfter();
97 method public int getPlaceholdersBefore();
98 method public int getSize();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]99 property public final java.util.List<T> items;
100 property public final int placeholdersAfter;
101 property public final int placeholdersBefore;
Dustin Lamcf7bd952020-07-23 19:26:03 -0700[diff] [blame]102 property public int size;
103 }
104
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]105 public abstract sealed class LoadState {
Dustin Lamcc1dd3d2020-04-13 23:56:45 -0700[diff] [blame]106 method public final boolean getEndOfPaginationReached();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]107 property public final boolean endOfPaginationReached;
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]108 }
109
110 public static final class LoadState.Error extends androidx.paging.LoadState {
Chris Craike8cdbf12020-05-14 16:17:01 -0700[diff] [blame]111 ctor public LoadState.Error(Throwable error);
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]112 method public Throwable getError();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]113 property public final Throwable error;
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]114 }
115
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]116 public static final class LoadState.Loading extends androidx.paging.LoadState {
Aurimas Liutikasafd4a792020-06-22 13:35:25 -0700[diff] [blame]117 field public static final androidx.paging.LoadState.Loading INSTANCE;
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]118 }
119
Dustin Lamcc1dd3d2020-04-13 23:56:45 -0700[diff] [blame]120 public static final class LoadState.NotLoading extends androidx.paging.LoadState {
Chris Craike8cdbf12020-05-14 16:17:01 -0700[diff] [blame]121 ctor public LoadState.NotLoading(boolean endOfPaginationReached);
122 }
123
124 public final class LoadStates {
125 ctor public LoadStates(androidx.paging.LoadState refresh, androidx.paging.LoadState prepend, androidx.paging.LoadState append);
126 method public androidx.paging.LoadState component1();
127 method public androidx.paging.LoadState component2();
128 method public androidx.paging.LoadState component3();
129 method public androidx.paging.LoadStates copy(androidx.paging.LoadState refresh, androidx.paging.LoadState prepend, androidx.paging.LoadState append);
130 method public androidx.paging.LoadState getAppend();
131 method public androidx.paging.LoadState getPrepend();
132 method public androidx.paging.LoadState getRefresh();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]133 property public final androidx.paging.LoadState append;
134 property public final androidx.paging.LoadState prepend;
135 property public final androidx.paging.LoadState refresh;
Dustin Lamcc1dd3d2020-04-13 23:56:45 -0700[diff] [blame]136 }
137
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]138 public enum LoadType {
Dustin Lam9c713672020-04-21 13:28:58 -0700[diff] [blame]139 enum_constant public static final androidx.paging.LoadType APPEND;
140 enum_constant public static final androidx.paging.LoadType PREPEND;
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]141 enum_constant public static final androidx.paging.LoadType REFRESH;
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]142 }
143
Dustin Lam190a76e2020-09-28 13:54:08 -0700[diff] [blame]144 public final class PageFetcherSnapshotKt {
145 }
146
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]147 @Deprecated public abstract class PageKeyedDataSource<Key, Value> extends androidx.paging.DataSource<Key,Value> {
148 ctor @Deprecated public PageKeyedDataSource();
149 method @Deprecated public abstract void loadAfter(androidx.paging.PageKeyedDataSource.LoadParams<Key> params, androidx.paging.PageKeyedDataSource.LoadCallback<Key,Value> callback);
150 method @Deprecated public abstract void loadBefore(androidx.paging.PageKeyedDataSource.LoadParams<Key> params, androidx.paging.PageKeyedDataSource.LoadCallback<Key,Value> callback);
151 method @Deprecated public abstract void loadInitial(androidx.paging.PageKeyedDataSource.LoadInitialParams<Key> params, androidx.paging.PageKeyedDataSource.LoadInitialCallback<Key,Value> callback);
152 method @Deprecated public final <ToValue> androidx.paging.PageKeyedDataSource<Key,ToValue> map(androidx.arch.core.util.Function<Value,ToValue> function);
153 method @Deprecated public final <ToValue> androidx.paging.PageKeyedDataSource<Key,ToValue> map(kotlin.jvm.functions.Function1<? super Value,? extends ToValue> function);
154 method @Deprecated public final <ToValue> androidx.paging.PageKeyedDataSource<Key,ToValue> mapByPage(androidx.arch.core.util.Function<java.util.List<Value>,java.util.List<ToValue>> function);
155 method @Deprecated public final <ToValue> androidx.paging.PageKeyedDataSource<Key,ToValue> mapByPage(kotlin.jvm.functions.Function1<? super java.util.List<? extends Value>,? extends java.util.List<? extends ToValue>> function);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]156 }
157
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]158 @Deprecated public abstract static class PageKeyedDataSource.LoadCallback<Key, Value> {
159 ctor @Deprecated public PageKeyedDataSource.LoadCallback();
160 method @Deprecated public abstract void onResult(java.util.List<? extends Value> data, Key? adjacentPageKey);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]161 }
162
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]163 @Deprecated public abstract static class PageKeyedDataSource.LoadInitialCallback<Key, Value> {
164 ctor @Deprecated public PageKeyedDataSource.LoadInitialCallback();
165 method @Deprecated public abstract void onResult(java.util.List<? extends Value> data, int position, int totalCount, Key? previousPageKey, Key? nextPageKey);
166 method @Deprecated public abstract void onResult(java.util.List<? extends Value> data, Key? previousPageKey, Key? nextPageKey);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]167 }
168
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]169 @Deprecated public static class PageKeyedDataSource.LoadInitialParams<Key> {
170 ctor @Deprecated public PageKeyedDataSource.LoadInitialParams(int requestedLoadSize, boolean placeholdersEnabled);
171 field @Deprecated public final boolean placeholdersEnabled;
172 field @Deprecated public final int requestedLoadSize;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]173 }
174
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]175 @Deprecated public static class PageKeyedDataSource.LoadParams<Key> {
176 ctor @Deprecated public PageKeyedDataSource.LoadParams(Key key, int requestedLoadSize);
177 field @Deprecated public final Key key;
178 field @Deprecated public final int requestedLoadSize;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]179 }
180
Dustin Lam74ee0172020-02-10 17:17:19 -0800[diff] [blame]181 @Deprecated public abstract class PagedList<T> extends java.util.AbstractList<T> {
Chris Craikc5178fb2019-08-30 09:58:53 -0700[diff] [blame]182 method @Deprecated public final void addWeakCallback(java.util.List<? extends T>? previousSnapshot, androidx.paging.PagedList.Callback callback);
Dustin Lam74ee0172020-02-10 17:17:19 -0800[diff] [blame]183 method @Deprecated public final void addWeakCallback(androidx.paging.PagedList.Callback callback);
184 method @Deprecated public final void addWeakLoadStateListener(kotlin.jvm.functions.Function2<? super androidx.paging.LoadType,? super androidx.paging.LoadState,kotlin.Unit> listener);
185 method @Deprecated public abstract void detach();
186 method @Deprecated public T? get(int index);
187 method @Deprecated public final androidx.paging.PagedList.Config getConfig();
Dustin Lam5cab6ee2019-07-17 09:49:04 -0700[diff] [blame]188 method @Deprecated public final androidx.paging.DataSource<?,T> getDataSource();
Dustin Lam74ee0172020-02-10 17:17:19 -0800[diff] [blame]189 method @Deprecated public abstract Object? getLastKey();
190 method @Deprecated public final int getLoadedCount();
191 method @Deprecated public final int getPositionOffset();
192 method @Deprecated public int getSize();
193 method @Deprecated public abstract boolean isDetached();
194 method @Deprecated public boolean isImmutable();
195 method @Deprecated public final void loadAround(int index);
196 method @Deprecated public final void removeWeakCallback(androidx.paging.PagedList.Callback callback);
197 method @Deprecated public final void removeWeakLoadStateListener(kotlin.jvm.functions.Function2<? super androidx.paging.LoadType,? super androidx.paging.LoadState,kotlin.Unit> listener);
198 method @Deprecated public void retry();
199 method @Deprecated public final java.util.List<T> snapshot();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]200 property public final androidx.paging.PagedList.Config config;
Dustin Lam5cab6ee2019-07-17 09:49:04 -0700[diff] [blame]201 property @Deprecated public final androidx.paging.DataSource<?,T> dataSource;
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]202 property public abstract boolean isDetached;
203 property public boolean isImmutable;
204 property public abstract Object? lastKey;
Chris Craikc5178fb2019-08-30 09:58:53 -0700[diff] [blame]205 property public final int loadedCount;
206 property public final int positionOffset;
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]207 property public int size;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]208 }
209
Dustin Lam74ee0172020-02-10 17:17:19 -0800[diff] [blame]210 @Deprecated @MainThread public abstract static class PagedList.BoundaryCallback<T> {
211 ctor @Deprecated public PagedList.BoundaryCallback();
212 method @Deprecated public void onItemAtEndLoaded(T itemAtEnd);
213 method @Deprecated public void onItemAtFrontLoaded(T itemAtFront);
214 method @Deprecated public void onZeroItemsLoaded();
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]215 }
216
Dustin Lam74ee0172020-02-10 17:17:19 -0800[diff] [blame]217 @Deprecated public static final class PagedList.Builder<Key, Value> {
Dustin Lamaa0515c2019-07-02 19:35:29 -0700[diff] [blame]218 ctor @Deprecated public PagedList.Builder(androidx.paging.DataSource<Key,Value> dataSource, androidx.paging.PagedList.Config config);
219 ctor @Deprecated public PagedList.Builder(androidx.paging.DataSource<Key,Value> dataSource, int pageSize);
Dustin Lam74ee0172020-02-10 17:17:19 -0800[diff] [blame]220 ctor @Deprecated public PagedList.Builder(androidx.paging.PagingSource<Key,Value> pagingSource, androidx.paging.PagingSource.LoadResult.Page<Key,Value> initialPage, androidx.paging.PagedList.Config config);
221 ctor @Deprecated public PagedList.Builder(androidx.paging.PagingSource<Key,Value> pagingSource, androidx.paging.PagingSource.LoadResult.Page<Key,Value> initialPage, int pageSize);
222 method @Deprecated public androidx.paging.PagedList<Value> build();
223 method @Deprecated public androidx.paging.PagedList.Builder<Key,Value> setBoundaryCallback(androidx.paging.PagedList.BoundaryCallback<Value>? boundaryCallback);
224 method @Deprecated public androidx.paging.PagedList.Builder<Key,Value> setCoroutineScope(kotlinx.coroutines.CoroutineScope coroutineScope);
225 method @Deprecated public androidx.paging.PagedList.Builder<Key,Value> setFetchDispatcher(kotlinx.coroutines.CoroutineDispatcher fetchDispatcher);
Dustin Lamdc14fd02019-08-01 19:34:18 -0700[diff] [blame]226 method @Deprecated public androidx.paging.PagedList.Builder<Key,Value> setFetchExecutor(java.util.concurrent.Executor fetchExecutor);
Dustin Lam74ee0172020-02-10 17:17:19 -0800[diff] [blame]227 method @Deprecated public androidx.paging.PagedList.Builder<Key,Value> setInitialKey(Key? initialKey);
228 method @Deprecated public androidx.paging.PagedList.Builder<Key,Value> setNotifyDispatcher(kotlinx.coroutines.CoroutineDispatcher notifyDispatcher);
Dustin Lamdc14fd02019-08-01 19:34:18 -0700[diff] [blame]229 method @Deprecated public androidx.paging.PagedList.Builder<Key,Value> setNotifyExecutor(java.util.concurrent.Executor notifyExecutor);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]230 }
231
Dustin Lam74ee0172020-02-10 17:17:19 -0800[diff] [blame]232 @Deprecated public abstract static class PagedList.Callback {
233 ctor @Deprecated public PagedList.Callback();
234 method @Deprecated public abstract void onChanged(int position, int count);
235 method @Deprecated public abstract void onInserted(int position, int count);
236 method @Deprecated public abstract void onRemoved(int position, int count);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]237 }
238
Dustin Lam74ee0172020-02-10 17:17:19 -0800[diff] [blame]239 @Deprecated public static final class PagedList.Config {
240 field @Deprecated public static final int MAX_SIZE_UNBOUNDED = 2147483647; // 0x7fffffff
241 field @Deprecated public final boolean enablePlaceholders;
242 field @Deprecated public final int initialLoadSizeHint;
243 field @Deprecated public final int maxSize;
244 field @Deprecated public final int pageSize;
245 field @Deprecated public final int prefetchDistance;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]246 }
247
Dustin Lam74ee0172020-02-10 17:17:19 -0800[diff] [blame]248 @Deprecated public static final class PagedList.Config.Builder {
249 ctor @Deprecated public PagedList.Config.Builder();
250 method @Deprecated public androidx.paging.PagedList.Config build();
251 method @Deprecated public androidx.paging.PagedList.Config.Builder setEnablePlaceholders(boolean enablePlaceholders);
252 method @Deprecated public androidx.paging.PagedList.Config.Builder setInitialLoadSizeHint(@IntRange(from=1) int initialLoadSizeHint);
253 method @Deprecated public androidx.paging.PagedList.Config.Builder setMaxSize(@IntRange(from=2) int maxSize);
254 method @Deprecated public androidx.paging.PagedList.Config.Builder setPageSize(@IntRange(from=1) int pageSize);
255 method @Deprecated public androidx.paging.PagedList.Config.Builder setPrefetchDistance(@IntRange(from=0) int prefetchDistance);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]256 }
257
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]258 public final class PagedListConfigKt {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]259 }
260
Dustin Lam26ca1a72019-05-28 17:42:51 -0700[diff] [blame]261 public final class PagedListKt {
Dustin Lam26ca1a72019-05-28 17:42:51 -0700[diff] [blame]262 }
263
Dustin Lam84cc4902020-04-10 14:50:35 -0700[diff] [blame]264 public final class Pager<Key, Value> {
265 ctor public Pager(androidx.paging.PagingConfig config, Key? initialKey, androidx.paging.RemoteMediator<Key,Value>? remoteMediator, kotlin.jvm.functions.Function0<? extends androidx.paging.PagingSource<Key,Value>> pagingSourceFactory);
266 ctor public Pager(androidx.paging.PagingConfig config, Key? initialKey, kotlin.jvm.functions.Function0<? extends androidx.paging.PagingSource<Key,Value>> pagingSourceFactory);
267 ctor public Pager(androidx.paging.PagingConfig config, kotlin.jvm.functions.Function0<? extends androidx.paging.PagingSource<Key,Value>> pagingSourceFactory);
268 method public kotlinx.coroutines.flow.Flow<androidx.paging.PagingData<Value>> getFlow();
269 property public final kotlinx.coroutines.flow.Flow<androidx.paging.PagingData<Value>> flow;
270 }
271
Chris Craik251f4132020-01-03 09:45:19 -0800[diff] [blame]272 public final class PagingConfig {
Aurimas Liutikasa3bfa992020-08-05 16:32:56 -0700[diff] [blame]273 ctor public PagingConfig(int pageSize, @IntRange(from=0) int prefetchDistance, boolean enablePlaceholders, @IntRange(from=1) int initialLoadSize, @IntRange(from=2) int maxSize, int jumpThreshold);
274 ctor public PagingConfig(int pageSize, @IntRange(from=0) int prefetchDistance, boolean enablePlaceholders, @IntRange(from=1) int initialLoadSize, @IntRange(from=2) int maxSize);
275 ctor public PagingConfig(int pageSize, @IntRange(from=0) int prefetchDistance, boolean enablePlaceholders, @IntRange(from=1) int initialLoadSize);
276 ctor public PagingConfig(int pageSize, @IntRange(from=0) int prefetchDistance, boolean enablePlaceholders);
277 ctor public PagingConfig(int pageSize, @IntRange(from=0) int prefetchDistance);
Dustin Lam7a1c56e2020-06-10 11:52:58 -0700[diff] [blame]278 ctor public PagingConfig(int pageSize);
Aurimas Liutikasafd4a792020-06-22 13:35:25 -0700[diff] [blame]279 field public static final androidx.paging.PagingConfig.Companion Companion;
Chris Craik251f4132020-01-03 09:45:19 -0800[diff] [blame]280 field public static final int MAX_SIZE_UNBOUNDED = 2147483647; // 0x7fffffff
281 field public final boolean enablePlaceholders;
282 field public final int initialLoadSize;
Dustin Lamd9ccaf32020-03-30 19:06:01 -0700[diff] [blame]283 field public final int jumpThreshold;
Chris Craik251f4132020-01-03 09:45:19 -0800[diff] [blame]284 field public final int maxSize;
285 field public final int pageSize;
286 field public final int prefetchDistance;
287 }
288
Chris Craik251f4132020-01-03 09:45:19 -0800[diff] [blame]289 public static final class PagingConfig.Companion {
290 }
291
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]292 public final class PagingData<T> {
Dustin Lamb82a27f2020-02-04 17:09:34 -0800[diff] [blame]293 method public static <T> androidx.paging.PagingData<T> empty();
Chris Craik1933a6a2020-03-11 12:11:30 -0700[diff] [blame]294 method @CheckResult public androidx.paging.PagingData<T> filter(kotlin.jvm.functions.Function1<? super T,java.lang.Boolean> predicate);
295 method @CheckResult public <R> androidx.paging.PagingData<R> flatMap(kotlin.jvm.functions.Function1<? super T,? extends java.lang.Iterable<? extends R>> transform);
Dustin Lame50166f2020-07-20 16:41:16 -0700[diff] [blame]296 method public static <T> androidx.paging.PagingData<T> from(java.util.List<? extends T> data);
Chris Craik5b5ca9c2020-03-13 13:39:12 -0700[diff] [blame]297 method @CheckResult public androidx.paging.PagingData<T> insertFooterItem(T item);
298 method @CheckResult public androidx.paging.PagingData<T> insertHeaderItem(T item);
Chris Craik1933a6a2020-03-11 12:11:30 -0700[diff] [blame]299 method @CheckResult public static <T extends R, R> androidx.paging.PagingData<R> insertSeparators(androidx.paging.PagingData<T> pagingData, kotlin.jvm.functions.Function2<? super T,? super T,? extends R> generator);
300 method @CheckResult public <R> androidx.paging.PagingData<R> map(kotlin.jvm.functions.Function1<? super T,? extends R> transform);
Aurimas Liutikasafd4a792020-06-22 13:35:25 -0700[diff] [blame]301 field public static final androidx.paging.PagingData.Companion Companion;
Dustin Lamb82a27f2020-02-04 17:09:34 -0800[diff] [blame]302 }
303
304 public static final class PagingData.Companion {
305 method public <T> androidx.paging.PagingData<T> empty();
Dustin Lame50166f2020-07-20 16:41:16 -0700[diff] [blame]306 method public <T> androidx.paging.PagingData<T> from(java.util.List<? extends T> data);
Chris Craik1933a6a2020-03-11 12:11:30 -0700[diff] [blame]307 method @CheckResult public <T extends R, R> androidx.paging.PagingData<R> insertSeparators(androidx.paging.PagingData<T> pagingData, kotlin.jvm.functions.Function2<? super T,? super T,? extends R> generator);
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]308 }
309
Chris Craik76219092020-03-09 11:30:01 -0700[diff] [blame]310 public final class PagingDataKt {
Chris Craik76219092020-03-09 11:30:01 -0700[diff] [blame]311 }
312
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]313 public abstract class PagingSource<Key, Value> {
314 ctor public PagingSource();
315 method public final boolean getInvalid();
Dustin Lam537c9682020-03-31 21:43:45 -0700[diff] [blame]316 method public boolean getJumpingSupported();
Dustin Lam39321212020-05-14 13:40:47 -0700[diff] [blame]317 method public boolean getKeyReuseSupported();
Dustin Lam34f31e42020-04-28 23:45:46 -0700[diff] [blame]318 method @androidx.paging.ExperimentalPagingApi public Key? getRefreshKey(androidx.paging.PagingState<Key,Value> state);
Yigit Boyarcfd12582020-12-01 17:01:50 -0800[diff] [blame^]319 method public final void invalidate();
Louis Pullen-Freilich10b53cd2020-04-30 12:35:30 +0100[diff] [blame]320 method public abstract suspend Object? load(androidx.paging.PagingSource.LoadParams<Key> params, kotlin.coroutines.Continuation<? super androidx.paging.PagingSource.LoadResult<Key,Value>> p);
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]321 method public final void registerInvalidatedCallback(kotlin.jvm.functions.Function0<kotlin.Unit> onInvalidatedCallback);
322 method public final void unregisterInvalidatedCallback(kotlin.jvm.functions.Function0<kotlin.Unit> onInvalidatedCallback);
323 property public final boolean invalid;
Dustin Lam537c9682020-03-31 21:43:45 -0700[diff] [blame]324 property public boolean jumpingSupported;
Dustin Lam39321212020-05-14 13:40:47 -0700[diff] [blame]325 property public boolean keyReuseSupported;
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]326 }
327
Yigit Boyarc44fdb22020-04-24 19:55:10 -0700[diff] [blame]328 public abstract static sealed class PagingSource.LoadParams<Key> {
329 method public abstract Key? getKey();
330 method public final int getLoadSize();
Yigit Boyarc44fdb22020-04-24 19:55:10 -0700[diff] [blame]331 method public final boolean getPlaceholdersEnabled();
332 property public abstract Key? key;
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]333 property public final int loadSize;
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]334 property public final boolean placeholdersEnabled;
Yigit Boyarc44fdb22020-04-24 19:55:10 -0700[diff] [blame]335 }
336
337 public static final class PagingSource.LoadParams.Append<Key> extends androidx.paging.PagingSource.LoadParams<Key> {
Dustin Lam343bb562020-05-04 13:53:12 -0700[diff] [blame]338 ctor public PagingSource.LoadParams.Append(Key key, int loadSize, boolean placeholdersEnabled);
Yigit Boyarc44fdb22020-04-24 19:55:10 -0700[diff] [blame]339 method public Key getKey();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]340 property public Key key;
Yigit Boyarc44fdb22020-04-24 19:55:10 -0700[diff] [blame]341 }
342
343 public static final class PagingSource.LoadParams.Prepend<Key> extends androidx.paging.PagingSource.LoadParams<Key> {
Dustin Lam343bb562020-05-04 13:53:12 -0700[diff] [blame]344 ctor public PagingSource.LoadParams.Prepend(Key key, int loadSize, boolean placeholdersEnabled);
Yigit Boyarc44fdb22020-04-24 19:55:10 -0700[diff] [blame]345 method public Key getKey();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]346 property public Key key;
Yigit Boyarc44fdb22020-04-24 19:55:10 -0700[diff] [blame]347 }
348
349 public static final class PagingSource.LoadParams.Refresh<Key> extends androidx.paging.PagingSource.LoadParams<Key> {
Dustin Lam343bb562020-05-04 13:53:12 -0700[diff] [blame]350 ctor public PagingSource.LoadParams.Refresh(Key? key, int loadSize, boolean placeholdersEnabled);
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]351 method public Key? getKey();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]352 property public Key? key;
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]353 }
354
355 public abstract static sealed class PagingSource.LoadResult<Key, Value> {
356 }
357
358 public static final class PagingSource.LoadResult.Error<Key, Value> extends androidx.paging.PagingSource.LoadResult<Key,Value> {
359 ctor public PagingSource.LoadResult.Error(Throwable throwable);
360 method public Throwable component1();
361 method public androidx.paging.PagingSource.LoadResult.Error<Key,Value> copy(Throwable throwable);
362 method public Throwable getThrowable();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]363 property public final Throwable throwable;
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]364 }
365
366 public static final class PagingSource.LoadResult.Page<Key, Value> extends androidx.paging.PagingSource.LoadResult<Key,Value> {
Aurimas Liutikasa3bfa992020-08-05 16:32:56 -0700[diff] [blame]367 ctor public PagingSource.LoadResult.Page(java.util.List<? extends Value> data, Key? prevKey, Key? nextKey, @IntRange(from=COUNT_UNDEFINED.toLong()) int itemsBefore, @IntRange(from=COUNT_UNDEFINED.toLong()) int itemsAfter);
Dustin Lamef4a8732020-07-01 18:24:30 -0700[diff] [blame]368 ctor public PagingSource.LoadResult.Page(java.util.List<? extends Value> data, Key? prevKey, Key? nextKey);
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]369 method public java.util.List<Value> component1();
370 method public Key? component2();
371 method public Key? component3();
372 method public int component4();
373 method public int component5();
374 method public androidx.paging.PagingSource.LoadResult.Page<Key,Value> copy(java.util.List<? extends Value> data, Key? prevKey, Key? nextKey, int itemsBefore, int itemsAfter);
375 method public java.util.List<Value> getData();
376 method public int getItemsAfter();
377 method public int getItemsBefore();
378 method public Key? getNextKey();
379 method public Key? getPrevKey();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]380 property public final java.util.List<Value> data;
381 property public final int itemsAfter;
382 property public final int itemsBefore;
383 property public final Key? nextKey;
384 property public final Key? prevKey;
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]385 field public static final int COUNT_UNDEFINED = -2147483648; // 0x80000000
Aurimas Liutikasafd4a792020-06-22 13:35:25 -0700[diff] [blame]386 field public static final androidx.paging.PagingSource.LoadResult.Page.Companion Companion;
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame]387 }
388
389 public static final class PagingSource.LoadResult.Page.Companion {
390 }
391
392 public final class PagingSourceKt {
393 }
394
Dustin Lamb0346022020-01-17 15:08:13 -0800[diff] [blame]395 public final class PagingState<Key, Value> {
Aurimas Liutikasa3bfa992020-08-05 16:32:56 -0700[diff] [blame]396 ctor public PagingState(java.util.List<androidx.paging.PagingSource.LoadResult.Page<Key,Value>> pages, Integer? anchorPosition, androidx.paging.PagingConfig config, @IntRange(from=0) int leadingPlaceholderCount);
Dustin Lam779cddb2020-03-26 12:28:43 -0700[diff] [blame]397 method public Value? closestItemToPosition(int anchorPosition);
398 method public androidx.paging.PagingSource.LoadResult.Page<Key,Value>? closestPageToPosition(int anchorPosition);
Dustin Lam5c9567f2020-06-17 13:44:16 -0700[diff] [blame]399 method public Value? firstItemOrNull();
Dustin Lam779cddb2020-03-26 12:28:43 -0700[diff] [blame]400 method public Integer? getAnchorPosition();
Dustin Lam1249ec02020-03-25 11:25:34 -0700[diff] [blame]401 method public androidx.paging.PagingConfig getConfig();
Dustin Lamb0346022020-01-17 15:08:13 -0800[diff] [blame]402 method public java.util.List<androidx.paging.PagingSource.LoadResult.Page<Key,Value>> getPages();
Dustin Lam5c9567f2020-06-17 13:44:16 -0700[diff] [blame]403 method public boolean isEmpty();
404 method public Value? lastItemOrNull();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]405 property public final Integer? anchorPosition;
406 property public final androidx.paging.PagingConfig config;
407 property public final java.util.List<androidx.paging.PagingSource.LoadResult.Page<Key,Value>> pages;
Dustin Lamb0346022020-01-17 15:08:13 -0800[diff] [blame]408 }
409
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]410 @Deprecated public abstract class PositionalDataSource<T> extends androidx.paging.DataSource<java.lang.Integer,T> {
411 ctor @Deprecated public PositionalDataSource();
412 method @Deprecated public static final int computeInitialLoadPosition(androidx.paging.PositionalDataSource.LoadInitialParams params, int totalCount);
413 method @Deprecated public static final int computeInitialLoadSize(androidx.paging.PositionalDataSource.LoadInitialParams params, int initialLoadPosition, int totalCount);
414 method @Deprecated @WorkerThread public abstract void loadInitial(androidx.paging.PositionalDataSource.LoadInitialParams params, androidx.paging.PositionalDataSource.LoadInitialCallback<T> callback);
415 method @Deprecated @WorkerThread public abstract void loadRange(androidx.paging.PositionalDataSource.LoadRangeParams params, androidx.paging.PositionalDataSource.LoadRangeCallback<T> callback);
416 method @Deprecated public final <V> androidx.paging.PositionalDataSource<V> map(androidx.arch.core.util.Function<T,V> function);
417 method @Deprecated public final <V> androidx.paging.PositionalDataSource<V> map(kotlin.jvm.functions.Function1<? super T,? extends V> function);
418 method @Deprecated public final <V> androidx.paging.PositionalDataSource<V> mapByPage(androidx.arch.core.util.Function<java.util.List<T>,java.util.List<V>> function);
419 method @Deprecated public final <V> androidx.paging.PositionalDataSource<V> mapByPage(kotlin.jvm.functions.Function1<? super java.util.List<? extends T>,? extends java.util.List<? extends V>> function);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]420 }
421
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]422 @Deprecated public abstract static class PositionalDataSource.LoadInitialCallback<T> {
423 ctor @Deprecated public PositionalDataSource.LoadInitialCallback();
424 method @Deprecated public abstract void onResult(java.util.List<? extends T> data, int position, int totalCount);
425 method @Deprecated public abstract void onResult(java.util.List<? extends T> data, int position);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]426 }
427
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]428 @Deprecated public static class PositionalDataSource.LoadInitialParams {
429 ctor @Deprecated public PositionalDataSource.LoadInitialParams(int requestedStartPosition, int requestedLoadSize, int pageSize, boolean placeholdersEnabled);
430 field @Deprecated public final int pageSize;
431 field @Deprecated public final boolean placeholdersEnabled;
432 field @Deprecated public final int requestedLoadSize;
433 field @Deprecated public final int requestedStartPosition;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]434 }
435
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]436 @Deprecated public abstract static class PositionalDataSource.LoadRangeCallback<T> {
437 ctor @Deprecated public PositionalDataSource.LoadRangeCallback();
438 method @Deprecated public abstract void onResult(java.util.List<? extends T> data);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]439 }
440
Dustin Lamcee0e1e2020-02-04 15:12:18 -0800[diff] [blame]441 @Deprecated public static class PositionalDataSource.LoadRangeParams {
442 ctor @Deprecated public PositionalDataSource.LoadRangeParams(int startPosition, int loadSize);
443 field @Deprecated public final int loadSize;
444 field @Deprecated public final int startPosition;
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]445 }
446
Dustin Lam937dfa92020-04-29 22:10:15 -0700[diff] [blame]447 @androidx.paging.ExperimentalPagingApi public abstract class RemoteMediator<Key, Value> {
Dustin Lam4f1cfee2020-03-09 09:49:22 -0700[diff] [blame]448 ctor public RemoteMediator();
Louis Pullen-Freilich10b53cd2020-04-30 12:35:30 +0100[diff] [blame]449 method public suspend Object? initialize(kotlin.coroutines.Continuation<? super androidx.paging.RemoteMediator.InitializeAction> $completion);
450 method public abstract suspend Object? load(androidx.paging.LoadType loadType, androidx.paging.PagingState<Key,Value> state, kotlin.coroutines.Continuation<? super androidx.paging.RemoteMediator.MediatorResult> p);
Dustin Lam4f1cfee2020-03-09 09:49:22 -0700[diff] [blame]451 }
452
453 public enum RemoteMediator.InitializeAction {
454 enum_constant public static final androidx.paging.RemoteMediator.InitializeAction LAUNCH_INITIAL_REFRESH;
455 enum_constant public static final androidx.paging.RemoteMediator.InitializeAction SKIP_INITIAL_REFRESH;
456 }
457
458 public abstract static sealed class RemoteMediator.MediatorResult {
459 }
460
461 public static final class RemoteMediator.MediatorResult.Error extends androidx.paging.RemoteMediator.MediatorResult {
462 ctor public RemoteMediator.MediatorResult.Error(Throwable throwable);
463 method public Throwable getThrowable();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]464 property public final Throwable throwable;
Dustin Lam4f1cfee2020-03-09 09:49:22 -0700[diff] [blame]465 }
466
467 public static final class RemoteMediator.MediatorResult.Success extends androidx.paging.RemoteMediator.MediatorResult {
Dustin Lamd87aafe2020-04-16 19:31:51 -0700[diff] [blame]468 ctor public RemoteMediator.MediatorResult.Success(boolean endOfPaginationReached);
469 method public boolean endOfPaginationReached();
Aurimas Liutikas6ac8c642020-09-29 13:48:32 -0700[diff] [blame]470 property public final boolean endOfPaginationReached;
Dustin Lam4f1cfee2020-03-09 09:49:22 -0700[diff] [blame]471 }
472
Yigit Boyarf86129d2020-10-09 11:34:07 -0700[diff] [blame]473 public final class RemoteMediatorAccessorKt {
474 }
475
Chris Craik29bc4692019-12-05 09:44:57 -0800[diff] [blame]476 public final class SeparatorsKt {
Chris Craik29bc4692019-12-05 09:44:57 -0800[diff] [blame]477 }
478
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]479}
480
Yigit Boyarc77bc772019-12-20 13:14:12 -0800[diff] [blame]481package androidx.paging.multicast {
482
483 public final class ChannelManagerKt {
484 }
485
486}
487