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