[go: nahoru, domu]
Google Git
Sign in
android / platform / frameworks / support / 4b8e0d0adef7d29305622dc48f1ce86e59f6ce4a / . / paging / common / api / current.txt
blob: d74f6c086ab59d75ebbc70505e56f02574cfdc81 [file] [log] [blame]
Jeff Gaston5d65a6a2019-01-23 13:44:15 -0500[diff] [blame]1// Signature format: 3.0
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]2package androidx.paging {
3
Yigit Boyarc77bc772019-12-20 13:14:12 -0800[diff] [blame]4 public final class CachedPagedDataKt {
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame^]5 method 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
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]8 public abstract class DataSource<Key, Value> {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]9 method @AnyThread public void addInvalidatedCallback(androidx.paging.DataSource.InvalidatedCallback onInvalidatedCallback);
Dustin Lam7b116f52019-06-12 13:51:31 -0700[diff] [blame]10 method @AnyThread public final void addInvalidatedCallback(kotlin.jvm.functions.Function0<kotlin.Unit> onInvalidatedCallback);
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]11 method @AnyThread public void invalidate();
12 method @WorkerThread public boolean isInvalid();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]13 method public <ToValue> androidx.paging.DataSource<Key,ToValue> map(androidx.arch.core.util.Function<Value,ToValue> function);
Dustin Lamc7011f22019-06-18 16:02:48 -0700[diff] [blame]14 method public <ToValue> androidx.paging.DataSource<Key,ToValue> map(kotlin.jvm.functions.Function1<? super Value,? extends ToValue> function);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]15 method public <ToValue> androidx.paging.DataSource<Key,ToValue> mapByPage(androidx.arch.core.util.Function<java.util.List<Value>,java.util.List<ToValue>> function);
Dustin Lamc7011f22019-06-18 16:02:48 -0700[diff] [blame]16 method public <ToValue> androidx.paging.DataSource<Key,ToValue> mapByPage(kotlin.jvm.functions.Function1<? super java.util.List<? extends Value>,? extends java.util.List<? extends ToValue>> function);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]17 method @AnyThread public void removeInvalidatedCallback(androidx.paging.DataSource.InvalidatedCallback onInvalidatedCallback);
Dustin Lam7b116f52019-06-12 13:51:31 -0700[diff] [blame]18 method @AnyThread public final void removeInvalidatedCallback(kotlin.jvm.functions.Function0<kotlin.Unit> onInvalidatedCallback);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]19 property @WorkerThread public boolean isInvalid;
20 }
21
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]22 public abstract static class DataSource.Factory<Key, Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]23 ctor public DataSource.Factory();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]24 method public abstract androidx.paging.DataSource<Key,Value> create();
25 method public <ToValue> androidx.paging.DataSource.Factory<Key,ToValue> map(androidx.arch.core.util.Function<Value,ToValue> function);
Dustin Lamc7011f22019-06-18 16:02:48 -0700[diff] [blame]26 method public <ToValue> androidx.paging.DataSource.Factory<Key,ToValue> map(kotlin.jvm.functions.Function1<? super Value,? extends ToValue> function);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]27 method public <ToValue> androidx.paging.DataSource.Factory<Key,ToValue> mapByPage(androidx.arch.core.util.Function<java.util.List<Value>,java.util.List<ToValue>> function);
Dustin Lamc7011f22019-06-18 16:02:48 -0700[diff] [blame]28 method public <ToValue> androidx.paging.DataSource.Factory<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]29 }
30
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]31 public static interface DataSource.InvalidatedCallback {
32 method @AnyThread public void onInvalidated();
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]33 }
34
Dustin Lam8ed132d2019-12-30 18:00:15 -0800[diff] [blame]35 public final class HeaderFooterKt {
36 }
37
Dustin Lam9a972d72019-06-20 08:40:12 -0700[diff] [blame]38 public abstract class ItemKeyedDataSource<Key, Value> extends androidx.paging.DataSource<Key,Value> {
Chris Craik557c8822018-10-25 15:04:03 -0700[diff] [blame]39 ctor public ItemKeyedDataSource();
Dustin Lam9a972d72019-06-20 08:40:12 -0700[diff] [blame]40 method public abstract Key getKey(Value item);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]41 method public abstract void loadAfter(androidx.paging.ItemKeyedDataSource.LoadParams<Key> params, androidx.paging.ItemKeyedDataSource.LoadCallback<Value> callback);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]42 method public abstract void loadBefore(androidx.paging.ItemKeyedDataSource.LoadParams<Key> params, androidx.paging.ItemKeyedDataSource.LoadCallback<Value> callback);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]43 method public abstract void loadInitial(androidx.paging.ItemKeyedDataSource.LoadInitialParams<Key> params, androidx.paging.ItemKeyedDataSource.LoadInitialCallback<Value> callback);
44 method public final <ToValue> androidx.paging.ItemKeyedDataSource<Key,ToValue> map(androidx.arch.core.util.Function<Value,ToValue> function);
Dustin Lamc7011f22019-06-18 16:02:48 -0700[diff] [blame]45 method public final <ToValue> androidx.paging.ItemKeyedDataSource<Key,ToValue> map(kotlin.jvm.functions.Function1<? super Value,? extends ToValue> function);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]46 method public final <ToValue> androidx.paging.ItemKeyedDataSource<Key,ToValue> mapByPage(androidx.arch.core.util.Function<java.util.List<Value>,java.util.List<ToValue>> function);
Dustin Lamc7011f22019-06-18 16:02:48 -0700[diff] [blame]47 method 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]48 }
49
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]50 public abstract static class ItemKeyedDataSource.LoadCallback<Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]51 ctor public ItemKeyedDataSource.LoadCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]52 method public abstract void onResult(java.util.List<? extends Value> data);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]53 }
54
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]55 public abstract static class ItemKeyedDataSource.LoadInitialCallback<Value> extends androidx.paging.ItemKeyedDataSource.LoadCallback<Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]56 ctor public ItemKeyedDataSource.LoadInitialCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]57 method public abstract void onResult(java.util.List<? extends Value> data, int position, int totalCount);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]58 }
59
Dustin Lam9a972d72019-06-20 08:40:12 -0700[diff] [blame]60 public static class ItemKeyedDataSource.LoadInitialParams<Key> {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]61 ctor public ItemKeyedDataSource.LoadInitialParams(Key? requestedInitialKey, int requestedLoadSize, boolean placeholdersEnabled);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]62 field public final boolean placeholdersEnabled;
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]63 field public final Key? requestedInitialKey;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]64 field public final int requestedLoadSize;
65 }
66
Dustin Lam9a972d72019-06-20 08:40:12 -0700[diff] [blame]67 public static class ItemKeyedDataSource.LoadParams<Key> {
68 ctor public ItemKeyedDataSource.LoadParams(Key key, int requestedLoadSize);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]69 field public final Key key;
70 field public final int requestedLoadSize;
71 }
72
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]73 public abstract sealed class LoadState {
74 }
75
76 public static final class LoadState.Done extends androidx.paging.LoadState {
77 field public static final androidx.paging.LoadState.Done! INSTANCE;
78 }
79
80 public static final class LoadState.Error extends androidx.paging.LoadState {
Chris Craikbda30df2019-09-06 15:14:28 -0700[diff] [blame]81 ctor public LoadState.Error(Throwable error);
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]82 method public Throwable component1();
Chris Craikbda30df2019-09-06 15:14:28 -0700[diff] [blame]83 method public androidx.paging.LoadState.Error copy(Throwable error);
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]84 method public Throwable getError();
Dustin Lamc6431e42019-08-28 18:40:11 -0700[diff] [blame]85 }
86
87 public static final class LoadState.Idle extends androidx.paging.LoadState {
88 field public static final androidx.paging.LoadState.Idle! INSTANCE;
89 }
90
91 public static final class LoadState.Loading extends androidx.paging.LoadState {
92 field public static final androidx.paging.LoadState.Loading! INSTANCE;
93 }
94
95 public enum LoadType {
96 enum_constant public static final androidx.paging.LoadType END;
97 enum_constant public static final androidx.paging.LoadType REFRESH;
98 enum_constant public static final androidx.paging.LoadType START;
99 }
100
Chris Craik29bc4692019-12-05 09:44:57 -0800[diff] [blame]101 public final class PageEventKt {
Chris Craik29bc4692019-12-05 09:44:57 -0800[diff] [blame]102 }
103
Dustin Lam4dcef652019-06-20 08:33:55 -0700[diff] [blame]104 public abstract class PageKeyedDataSource<Key, Value> extends androidx.paging.DataSource<Key,Value> {
Chris Craik557c8822018-10-25 15:04:03 -0700[diff] [blame]105 ctor public PageKeyedDataSource();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]106 method public abstract void loadAfter(androidx.paging.PageKeyedDataSource.LoadParams<Key> params, androidx.paging.PageKeyedDataSource.LoadCallback<Key,Value> callback);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]107 method public abstract void loadBefore(androidx.paging.PageKeyedDataSource.LoadParams<Key> params, androidx.paging.PageKeyedDataSource.LoadCallback<Key,Value> callback);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]108 method public abstract void loadInitial(androidx.paging.PageKeyedDataSource.LoadInitialParams<Key> params, androidx.paging.PageKeyedDataSource.LoadInitialCallback<Key,Value> callback);
109 method public final <ToValue> androidx.paging.PageKeyedDataSource<Key,ToValue> map(androidx.arch.core.util.Function<Value,ToValue> function);
Dustin Lamc7011f22019-06-18 16:02:48 -0700[diff] [blame]110 method public final <ToValue> androidx.paging.PageKeyedDataSource<Key,ToValue> map(kotlin.jvm.functions.Function1<? super Value,? extends ToValue> function);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]111 method public final <ToValue> androidx.paging.PageKeyedDataSource<Key,ToValue> mapByPage(androidx.arch.core.util.Function<java.util.List<Value>,java.util.List<ToValue>> function);
Dustin Lamc7011f22019-06-18 16:02:48 -0700[diff] [blame]112 method 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]113 }
114
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]115 public abstract static class PageKeyedDataSource.LoadCallback<Key, Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]116 ctor public PageKeyedDataSource.LoadCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]117 method public abstract void onResult(java.util.List<? extends Value> data, Key? adjacentPageKey);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]118 }
119
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]120 public abstract static class PageKeyedDataSource.LoadInitialCallback<Key, Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]121 ctor public PageKeyedDataSource.LoadInitialCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]122 method public abstract void onResult(java.util.List<? extends Value> data, int position, int totalCount, Key? previousPageKey, Key? nextPageKey);
123 method public abstract void onResult(java.util.List<? extends Value> data, Key? previousPageKey, Key? nextPageKey);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]124 }
125
Dustin Lam4dcef652019-06-20 08:33:55 -0700[diff] [blame]126 public static class PageKeyedDataSource.LoadInitialParams<Key> {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]127 ctor public PageKeyedDataSource.LoadInitialParams(int requestedLoadSize, boolean placeholdersEnabled);
Dustin Lam4dcef652019-06-20 08:33:55 -0700[diff] [blame]128 field public final boolean placeholdersEnabled;
129 field public final int requestedLoadSize;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]130 }
131
Dustin Lam4dcef652019-06-20 08:33:55 -0700[diff] [blame]132 public static class PageKeyedDataSource.LoadParams<Key> {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]133 ctor public PageKeyedDataSource.LoadParams(Key key, int requestedLoadSize);
Dustin Lam4dcef652019-06-20 08:33:55 -0700[diff] [blame]134 field public final Key key;
135 field public final int requestedLoadSize;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]136 }
137
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]138 public abstract class PagedList<T> extends java.util.AbstractList<T> {
Chris Craikc5178fb2019-08-30 09:58:53 -0700[diff] [blame]139 method @Deprecated public final void addWeakCallback(java.util.List<? extends T>? previousSnapshot, androidx.paging.PagedList.Callback callback);
140 method public final void addWeakCallback(androidx.paging.PagedList.Callback callback);
141 method public final void addWeakLoadStateListener(kotlin.jvm.functions.Function2<? super androidx.paging.LoadType,? super androidx.paging.LoadState,kotlin.Unit> listener);
Chris Craik557c8822018-10-25 15:04:03 -0700[diff] [blame]142 method public abstract void detach();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]143 method public T? get(int index);
Chris Craik4f0002c2019-08-30 09:19:39 -0700[diff] [blame]144 method public final androidx.paging.PagedList.Config getConfig();
Dustin Lam5cab6ee2019-07-17 09:49:04 -0700[diff] [blame]145 method @Deprecated public final androidx.paging.DataSource<?,T> getDataSource();
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]146 method public abstract Object? getLastKey();
Chris Craikc5178fb2019-08-30 09:58:53 -0700[diff] [blame]147 method public final int getLoadedCount();
148 method public final int getPositionOffset();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]149 method public int getSize();
Chris Craik557c8822018-10-25 15:04:03 -0700[diff] [blame]150 method public abstract boolean isDetached();
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]151 method public boolean isImmutable();
Chris Craikc5178fb2019-08-30 09:58:53 -0700[diff] [blame]152 method public final void loadAround(int index);
153 method public final void removeWeakCallback(androidx.paging.PagedList.Callback callback);
154 method public final void removeWeakLoadStateListener(kotlin.jvm.functions.Function2<? super androidx.paging.LoadType,? super androidx.paging.LoadState,kotlin.Unit> listener);
Chris Craikcf72bdc2018-10-18 13:32:02 -0700[diff] [blame]155 method public void retry();
Chris Craikc5178fb2019-08-30 09:58:53 -0700[diff] [blame]156 method public final java.util.List<T> snapshot();
Dustin Lam5cab6ee2019-07-17 09:49:04 -0700[diff] [blame]157 property @Deprecated public final androidx.paging.DataSource<?,T> dataSource;
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]158 property public abstract boolean isDetached;
159 property public boolean isImmutable;
160 property public abstract Object? lastKey;
Chris Craikc5178fb2019-08-30 09:58:53 -0700[diff] [blame]161 property public final int loadedCount;
162 property public final int positionOffset;
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]163 property public int size;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]164 }
165
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]166 @MainThread public abstract static class PagedList.BoundaryCallback<T> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]167 ctor public PagedList.BoundaryCallback();
Chris Craik76c72292019-09-19 14:06:32 -0700[diff] [blame]168 method public void onItemAtEndLoaded(T itemAtEnd);
169 method public void onItemAtFrontLoaded(T itemAtFront);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]170 method public void onZeroItemsLoaded();
171 }
172
173 public static final class PagedList.Builder<Key, Value> {
Dustin Lamaa0515c2019-07-02 19:35:29 -0700[diff] [blame]174 ctor @Deprecated public PagedList.Builder(androidx.paging.DataSource<Key,Value> dataSource, androidx.paging.PagedList.Config config);
175 ctor @Deprecated public PagedList.Builder(androidx.paging.DataSource<Key,Value> dataSource, int pageSize);
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame^]176 ctor public PagedList.Builder(androidx.paging.PagingSource<Key,Value> pagingSource, androidx.paging.PagingSource.LoadResult.Page<Key,Value> initialPage, androidx.paging.PagedList.Config config);
177 ctor public PagedList.Builder(androidx.paging.PagingSource<Key,Value> pagingSource, androidx.paging.PagingSource.LoadResult.Page<Key,Value> initialPage, int pageSize);
Chris Craik9e5b63a2019-09-16 14:04:49 -0700[diff] [blame]178 method public androidx.paging.PagedList<Value> build();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]179 method public androidx.paging.PagedList.Builder<Key,Value> setBoundaryCallback(androidx.paging.PagedList.BoundaryCallback<Value>? boundaryCallback);
Dustin Lamdba215c2019-06-21 17:35:26 -0700[diff] [blame]180 method public androidx.paging.PagedList.Builder<Key,Value> setCoroutineScope(kotlinx.coroutines.CoroutineScope coroutineScope);
Dustin Lamdc14fd02019-08-01 19:34:18 -0700[diff] [blame]181 method public androidx.paging.PagedList.Builder<Key,Value> setFetchDispatcher(kotlinx.coroutines.CoroutineDispatcher fetchDispatcher);
182 method @Deprecated public androidx.paging.PagedList.Builder<Key,Value> setFetchExecutor(java.util.concurrent.Executor fetchExecutor);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]183 method public androidx.paging.PagedList.Builder<Key,Value> setInitialKey(Key? initialKey);
Dustin Lamdc14fd02019-08-01 19:34:18 -0700[diff] [blame]184 method public androidx.paging.PagedList.Builder<Key,Value> setNotifyDispatcher(kotlinx.coroutines.CoroutineDispatcher notifyDispatcher);
185 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]186 }
187
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]188 public abstract static class PagedList.Callback {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]189 ctor public PagedList.Callback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]190 method public abstract void onChanged(int position, int count);
191 method public abstract void onInserted(int position, int count);
192 method public abstract void onRemoved(int position, int count);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]193 }
194
Dustin Lamb2de3cc2019-06-12 09:47:19 -0700[diff] [blame]195 public static final class PagedList.Config {
Chris Craike8ca38c2018-05-22 18:08:16 -0700[diff] [blame]196 field public static final int MAX_SIZE_UNBOUNDED = 2147483647; // 0x7fffffff
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]197 field public final boolean enablePlaceholders;
198 field public final int initialLoadSizeHint;
Chris Craike8ca38c2018-05-22 18:08:16 -0700[diff] [blame]199 field public final int maxSize;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]200 field public final int pageSize;
201 field public final int prefetchDistance;
202 }
203
204 public static final class PagedList.Config.Builder {
205 ctor public PagedList.Config.Builder();
206 method public androidx.paging.PagedList.Config build();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]207 method public androidx.paging.PagedList.Config.Builder setEnablePlaceholders(boolean enablePlaceholders);
208 method public androidx.paging.PagedList.Config.Builder setInitialLoadSizeHint(@IntRange(from=1) int initialLoadSizeHint);
209 method public androidx.paging.PagedList.Config.Builder setMaxSize(@IntRange(from=2) int maxSize);
210 method public androidx.paging.PagedList.Config.Builder setPageSize(@IntRange(from=1) int pageSize);
211 method public androidx.paging.PagedList.Config.Builder setPrefetchDistance(@IntRange(from=0) int prefetchDistance);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]212 }
213
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]214 public final class PagedListConfigKt {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]215 method public static androidx.paging.PagedList.Config Config(int pageSize, int prefetchDistance = pageSize, boolean enablePlaceholders = true, int initialLoadSizeHint = pageSize * androidx.paging.PagedList.Config.Builder.DEFAULT_INITIAL_PAGE_MULTIPLIER, int maxSize = 2147483647);
216 }
217
Dustin Lam26ca1a72019-05-28 17:42:51 -0700[diff] [blame]218 public final class PagedListKt {
Dustin Lam5cab6ee2019-07-17 09:49:04 -0700[diff] [blame]219 method @Deprecated public static <Key, Value> androidx.paging.PagedList<Value> PagedList(androidx.paging.DataSource<Key,Value> dataSource, androidx.paging.PagedList.Config config, java.util.concurrent.Executor notifyExecutor, java.util.concurrent.Executor fetchExecutor, androidx.paging.PagedList.BoundaryCallback<Value>? boundaryCallback = null, Key? initialKey = null);
Dustin Lam26ca1a72019-05-28 17:42:51 -0700[diff] [blame]220 }
221
Chris Craik251f4132020-01-03 09:45:19 -0800[diff] [blame]222 public final class PagingConfig {
223 ctor public PagingConfig(int pageSize, int prefetchDistance, boolean enablePlaceholders, int initialLoadSize, int maxSize);
224 field public static final androidx.paging.PagingConfig.Companion! Companion;
225 field public static final int MAX_SIZE_UNBOUNDED = 2147483647; // 0x7fffffff
226 field public final boolean enablePlaceholders;
227 field public final int initialLoadSize;
228 field public final int maxSize;
229 field public final int pageSize;
230 field public final int prefetchDistance;
231 }
232
233 public static final class PagingConfig.Builder {
234 ctor public PagingConfig.Builder(int pageSize);
235 method public androidx.paging.PagingConfig build();
236 method public androidx.paging.PagingConfig.Builder setEnablePlaceholders(boolean enablePlaceholders);
237 method public androidx.paging.PagingConfig.Builder setInitialLoadSizeHint(@IntRange(from=1) int initialLoadSizeHint);
238 method public androidx.paging.PagingConfig.Builder setMaxSize(@IntRange(from=2) int maxSize);
239 method public androidx.paging.PagingConfig.Builder setPrefetchDistance(@IntRange(from=0) int prefetchDistance);
240 }
241
242 public static final class PagingConfig.Companion {
243 }
244
Dustin Lam4b8e0d02020-01-09 15:55:17 -0800[diff] [blame^]245 public final class PagingData<T> {
246 method public androidx.paging.PagingData<T> addFooter(T item);
247 method public androidx.paging.PagingData<T> addHeader(T item);
248 method public androidx.paging.PagingData<T> filter(kotlin.jvm.functions.Function1<? super T,java.lang.Boolean> predicate);
249 method public <R> androidx.paging.PagingData<R> flatMap(kotlin.jvm.functions.Function1<? super T,? extends java.lang.Iterable<? extends R>> transform);
250 method public <R extends T> androidx.paging.PagingData<T> insertSeparators(kotlin.jvm.functions.Function2<? super T,? super T,? extends R> generator);
251 method public <R> androidx.paging.PagingData<R> map(kotlin.jvm.functions.Function1<? super T,? extends R> transform);
252 }
253
254 public final class PagingDataFlow {
255 method public static <Key, Value> kotlinx.coroutines.flow.Flow<androidx.paging.PagingData<Value>> create(androidx.paging.PagingConfig config, Key? initialKey, kotlin.jvm.functions.Function0<? extends androidx.paging.PagingSource<Key,Value>> pagingSourceFactory);
256 method public static <Key, Value> kotlinx.coroutines.flow.Flow<androidx.paging.PagingData<Value>> create(androidx.paging.PagingConfig config, kotlin.jvm.functions.Function0<? extends androidx.paging.PagingSource<Key,Value>> pagingSourceFactory);
257 }
258
259 public abstract class PagingSource<Key, Value> {
260 ctor public PagingSource();
261 method public final boolean getInvalid();
262 method public Key? getRefreshKeyFromPage(int indexInPage, androidx.paging.PagingSource.LoadResult.Page<Key,Value> page);
263 method public void invalidate();
264 method public abstract suspend Object load(androidx.paging.PagingSource.LoadParams<Key> params, kotlin.coroutines.Continuation<? super androidx.paging.PagingSource.LoadResult<Key,Value>> p);
265 method public final void registerInvalidatedCallback(kotlin.jvm.functions.Function0<kotlin.Unit> onInvalidatedCallback);
266 method public final void unregisterInvalidatedCallback(kotlin.jvm.functions.Function0<kotlin.Unit> onInvalidatedCallback);
267 property public final boolean invalid;
268 }
269
270 public static final class PagingSource.LoadParams<Key> {
271 ctor public PagingSource.LoadParams(androidx.paging.LoadType loadType, Key? key, int loadSize, boolean placeholdersEnabled, int pageSize);
272 method public androidx.paging.LoadType component1();
273 method public Key? component2();
274 method public int component3();
275 method public boolean component4();
276 method public int component5();
277 method public androidx.paging.PagingSource.LoadParams<Key> copy(androidx.paging.LoadType loadType, Key? key, int loadSize, boolean placeholdersEnabled, int pageSize);
278 method public Key? getKey();
279 method public int getLoadSize();
280 method public androidx.paging.LoadType getLoadType();
281 method public int getPageSize();
282 method public boolean getPlaceholdersEnabled();
283 }
284
285 public abstract static sealed class PagingSource.LoadResult<Key, Value> {
286 }
287
288 public static final class PagingSource.LoadResult.Error<Key, Value> extends androidx.paging.PagingSource.LoadResult<Key,Value> {
289 ctor public PagingSource.LoadResult.Error(Throwable throwable);
290 method public Throwable component1();
291 method public androidx.paging.PagingSource.LoadResult.Error<Key,Value> copy(Throwable throwable);
292 method public Throwable getThrowable();
293 }
294
295 public static final class PagingSource.LoadResult.Page<Key, Value> extends androidx.paging.PagingSource.LoadResult<Key,Value> {
296 ctor public PagingSource.LoadResult.Page(java.util.List<? extends Value> data, Key? prevKey, Key? nextKey, @IntRange(from=null) int itemsBefore, @IntRange(from=null) int itemsAfter);
297 method public java.util.List<Value> component1();
298 method public Key? component2();
299 method public Key? component3();
300 method public int component4();
301 method public int component5();
302 method public androidx.paging.PagingSource.LoadResult.Page<Key,Value> copy(java.util.List<? extends Value> data, Key? prevKey, Key? nextKey, int itemsBefore, int itemsAfter);
303 method public java.util.List<Value> getData();
304 method public int getItemsAfter();
305 method public int getItemsBefore();
306 method public Key? getNextKey();
307 method public Key? getPrevKey();
308 field public static final int COUNT_UNDEFINED = -2147483648; // 0x80000000
309 field public static final androidx.paging.PagingSource.LoadResult.Page.Companion! Companion;
310 }
311
312 public static final class PagingSource.LoadResult.Page.Companion {
313 }
314
315 public final class PagingSourceKt {
316 }
317
Dustin Lama7fecfa2019-06-20 18:39:13 -0700[diff] [blame]318 public abstract class PositionalDataSource<T> extends androidx.paging.DataSource<java.lang.Integer,T> {
Chris Craik557c8822018-10-25 15:04:03 -0700[diff] [blame]319 ctor public PositionalDataSource();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]320 method public static final int computeInitialLoadPosition(androidx.paging.PositionalDataSource.LoadInitialParams params, int totalCount);
321 method public static final int computeInitialLoadSize(androidx.paging.PositionalDataSource.LoadInitialParams params, int initialLoadPosition, int totalCount);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]322 method @WorkerThread public abstract void loadInitial(androidx.paging.PositionalDataSource.LoadInitialParams params, androidx.paging.PositionalDataSource.LoadInitialCallback<T> callback);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]323 method @WorkerThread public abstract void loadRange(androidx.paging.PositionalDataSource.LoadRangeParams params, androidx.paging.PositionalDataSource.LoadRangeCallback<T> callback);
324 method public final <V> androidx.paging.PositionalDataSource<V> map(androidx.arch.core.util.Function<T,V> function);
Dustin Lamc7011f22019-06-18 16:02:48 -0700[diff] [blame]325 method public final <V> androidx.paging.PositionalDataSource<V> map(kotlin.jvm.functions.Function1<? super T,? extends V> function);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]326 method public final <V> androidx.paging.PositionalDataSource<V> mapByPage(androidx.arch.core.util.Function<java.util.List<T>,java.util.List<V>> function);
Dustin Lamc7011f22019-06-18 16:02:48 -0700[diff] [blame]327 method 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]328 }
329
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]330 public abstract static class PositionalDataSource.LoadInitialCallback<T> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]331 ctor public PositionalDataSource.LoadInitialCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]332 method public abstract void onResult(java.util.List<? extends T> data, int position, int totalCount);
333 method public abstract void onResult(java.util.List<? extends T> data, int position);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]334 }
335
Dustin Lama7fecfa2019-06-20 18:39:13 -0700[diff] [blame]336 public static class PositionalDataSource.LoadInitialParams {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]337 ctor public PositionalDataSource.LoadInitialParams(int requestedStartPosition, int requestedLoadSize, int pageSize, boolean placeholdersEnabled);
Dustin Lama7fecfa2019-06-20 18:39:13 -0700[diff] [blame]338 field public final int pageSize;
339 field public final boolean placeholdersEnabled;
340 field public final int requestedLoadSize;
341 field public final int requestedStartPosition;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]342 }
343
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]344 public abstract static class PositionalDataSource.LoadRangeCallback<T> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]345 ctor public PositionalDataSource.LoadRangeCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]346 method public abstract void onResult(java.util.List<? extends T> data);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]347 }
348
Dustin Lama7fecfa2019-06-20 18:39:13 -0700[diff] [blame]349 public static class PositionalDataSource.LoadRangeParams {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]350 ctor public PositionalDataSource.LoadRangeParams(int startPosition, int loadSize);
Dustin Lama7fecfa2019-06-20 18:39:13 -0700[diff] [blame]351 field public final int loadSize;
352 field public final int startPosition;
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]353 }
354
Chris Craik29bc4692019-12-05 09:44:57 -0800[diff] [blame]355 public final class SeparatorsKt {
Chris Craik29bc4692019-12-05 09:44:57 -0800[diff] [blame]356 }
357
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]358}
359
Yigit Boyarc77bc772019-12-20 13:14:12 -0800[diff] [blame]360package androidx.paging.multicast {
361
362 public final class ChannelManagerKt {
363 }
364
365}
366