[go: nahoru, domu]
Google Git
Sign in
android / platform / frameworks / support / b21368c21032a84b74e560f3557e5312d435436c / . / paging / common / api / current.txt
blob: e5bc3c00a9db6996cc37552f6fe269cb0869bffc [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
4 public abstract class DataSource<Key, Value> {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]5 method @AnyThread public void addInvalidatedCallback(androidx.paging.DataSource.InvalidatedCallback onInvalidatedCallback);
Dustin Lam7b116f52019-06-12 13:51:31 -0700[diff] [blame]6 method @AnyThread public final void addInvalidatedCallback(kotlin.jvm.functions.Function0<kotlin.Unit> onInvalidatedCallback);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]7 method protected final java.util.concurrent.Executor getExecutor();
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]8 method @AnyThread public void invalidate();
9 method @WorkerThread public boolean isInvalid();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]10 method public boolean isRetryableError(Throwable error);
Dustin Lamd847ca62019-06-24 14:53:17 -0700[diff] [blame]11 method public abstract suspend Object load$lintWithKotlin(androidx.paging.DataSource.Params<Key> params, kotlin.coroutines.Continuation<? super androidx.paging.DataSource.BaseResult<Value>> p);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]12 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]13 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]14 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]15 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]16 method @AnyThread public void removeInvalidatedCallback(androidx.paging.DataSource.InvalidatedCallback onInvalidatedCallback);
Dustin Lam7b116f52019-06-12 13:51:31 -0700[diff] [blame]17 method @AnyThread public final void removeInvalidatedCallback(kotlin.jvm.functions.Function0<kotlin.Unit> onInvalidatedCallback);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]18 property protected final java.util.concurrent.Executor executor;
19 property @WorkerThread public boolean isInvalid;
20 }
21
22 public static class DataSource.BaseResult<Value> {
23 ctor protected DataSource.BaseResult(java.util.List<? extends Value> data, Object? prevKey, Object? nextKey, int leadingNulls, int trailingNulls, int offset, boolean counted);
24 method public final boolean getCounted();
25 method public final int getLeadingNulls();
26 method public final Object? getNextKey();
27 method public final int getOffset();
28 method public final Object? getPrevKey();
29 method public final int getTrailingNulls();
30 field public final java.util.List<Value> data;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]31 }
32
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]33 public abstract static class DataSource.Factory<Key, Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]34 ctor public DataSource.Factory();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]35 method public abstract androidx.paging.DataSource<Key,Value> create();
36 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]37 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]38 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]39 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]40 }
41
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]42 public static interface DataSource.InvalidatedCallback {
43 method @AnyThread public void onInvalidated();
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]44 }
45
Dustin Lamd847ca62019-06-24 14:53:17 -0700[diff] [blame]46 public static final class DataSource.Params<K> {
47 method public int getInitialLoadSize();
48 method public K? getKey();
49 method public int getPageSize();
50 method public boolean getPlaceholdersEnabled();
51 }
52
Dustin Lam7b116f52019-06-12 13:51:31 -0700[diff] [blame]53 public final class DataSourceKt {
54 ctor public DataSourceKt();
55 }
56
Dustin Lam9a972d72019-06-20 08:40:12 -0700[diff] [blame]57 public abstract class ItemKeyedDataSource<Key, Value> extends androidx.paging.DataSource<Key,Value> {
Chris Craik557c8822018-10-25 15:04:03 -0700[diff] [blame]58 ctor public ItemKeyedDataSource();
Dustin Lam9a972d72019-06-20 08:40:12 -0700[diff] [blame]59 method public abstract Key getKey(Value item);
Dustin Lamd847ca62019-06-24 14:53:17 -0700[diff] [blame]60 method public final suspend Object load$lintWithKotlin(androidx.paging.DataSource.Params<Key> params, kotlin.coroutines.Continuation<? super androidx.paging.DataSource.BaseResult<Value>> p);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]61 method public abstract void loadAfter(androidx.paging.ItemKeyedDataSource.LoadParams<Key> params, androidx.paging.ItemKeyedDataSource.LoadCallback<Value> callback);
Dustin Lam000d48c2019-06-25 16:33:41 -0700[diff] [blame]62 method @VisibleForTesting public final suspend Object loadAfter$lintWithKotlin(androidx.paging.ItemKeyedDataSource.LoadParams<Key> params, kotlin.coroutines.Continuation<? super androidx.paging.ItemKeyedDataSource.Result<Value>> p);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]63 method public abstract void loadBefore(androidx.paging.ItemKeyedDataSource.LoadParams<Key> params, androidx.paging.ItemKeyedDataSource.LoadCallback<Value> callback);
Dustin Lam000d48c2019-06-25 16:33:41 -0700[diff] [blame]64 method @VisibleForTesting public final suspend Object loadBefore$lintWithKotlin(androidx.paging.ItemKeyedDataSource.LoadParams<Key> params, kotlin.coroutines.Continuation<? super androidx.paging.ItemKeyedDataSource.Result<Value>> p);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]65 method public abstract void loadInitial(androidx.paging.ItemKeyedDataSource.LoadInitialParams<Key> params, androidx.paging.ItemKeyedDataSource.LoadInitialCallback<Value> callback);
Dustin Lam000d48c2019-06-25 16:33:41 -0700[diff] [blame]66 method @VisibleForTesting public final suspend Object loadInitial$lintWithKotlin(androidx.paging.ItemKeyedDataSource.LoadInitialParams<Key> params, kotlin.coroutines.Continuation<? super androidx.paging.ItemKeyedDataSource.InitialResult<Value>> p);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]67 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]68 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]69 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]70 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]71 }
72
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]73 public abstract static class ItemKeyedDataSource.LoadCallback<Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]74 ctor public ItemKeyedDataSource.LoadCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]75 method public void onError(Throwable error);
76 method public abstract void onResult(java.util.List<? extends Value> data);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]77 }
78
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]79 public abstract static class ItemKeyedDataSource.LoadInitialCallback<Value> extends androidx.paging.ItemKeyedDataSource.LoadCallback<Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]80 ctor public ItemKeyedDataSource.LoadInitialCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]81 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]82 }
83
Dustin Lam9a972d72019-06-20 08:40:12 -0700[diff] [blame]84 public static class ItemKeyedDataSource.LoadInitialParams<Key> {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]85 ctor public ItemKeyedDataSource.LoadInitialParams(Key? requestedInitialKey, int requestedLoadSize, boolean placeholdersEnabled);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]86 field public final boolean placeholdersEnabled;
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]87 field public final Key? requestedInitialKey;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]88 field public final int requestedLoadSize;
89 }
90
Dustin Lam9a972d72019-06-20 08:40:12 -0700[diff] [blame]91 public static class ItemKeyedDataSource.LoadParams<Key> {
92 ctor public ItemKeyedDataSource.LoadParams(Key key, int requestedLoadSize);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]93 field public final Key key;
94 field public final int requestedLoadSize;
95 }
96
Dustin Lam000d48c2019-06-25 16:33:41 -0700[diff] [blame]97 public final class ItemKeyedDataSourceKt {
98 ctor public ItemKeyedDataSourceKt();
99 }
100
Dustin Lam4dcef652019-06-20 08:33:55 -0700[diff] [blame]101 public abstract class PageKeyedDataSource<Key, Value> extends androidx.paging.DataSource<Key,Value> {
Chris Craik557c8822018-10-25 15:04:03 -0700[diff] [blame]102 ctor public PageKeyedDataSource();
Dustin Lamd847ca62019-06-24 14:53:17 -0700[diff] [blame]103 method public final suspend Object load$lintWithKotlin(androidx.paging.DataSource.Params<Key> params, kotlin.coroutines.Continuation<? super androidx.paging.DataSource.BaseResult<Value>> p);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]104 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]105 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]106 method public abstract void loadInitial(androidx.paging.PageKeyedDataSource.LoadInitialParams<Key> params, androidx.paging.PageKeyedDataSource.LoadInitialCallback<Key,Value> callback);
107 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]108 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]109 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]110 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]111 }
112
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]113 public abstract static class PageKeyedDataSource.LoadCallback<Key, Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]114 ctor public PageKeyedDataSource.LoadCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]115 method public void onError(Throwable error);
116 method public abstract void onResult(java.util.List<? extends Value> data, Key? adjacentPageKey);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]117 }
118
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]119 public abstract static class PageKeyedDataSource.LoadInitialCallback<Key, Value> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]120 ctor public PageKeyedDataSource.LoadInitialCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]121 method public void onError(Throwable error);
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
Dustin Lambca5a172019-06-25 12:55:05 -0700[diff] [blame]138 public final class PageKeyedDataSourceKt {
139 ctor public PageKeyedDataSourceKt();
140 }
141
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]142 public abstract class PagedList<T> extends java.util.AbstractList<T> {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]143 method public void addWeakCallback(java.util.List<? extends T>? previousSnapshot, androidx.paging.PagedList.Callback callback);
Dustin Lam7b116f52019-06-12 13:51:31 -0700[diff] [blame]144 method public void addWeakLoadStateListener(kotlin.jvm.functions.Function3<? super androidx.paging.PagedList.LoadType,? super androidx.paging.PagedList.LoadState,? super java.lang.Throwable,kotlin.Unit> listener);
Chris Craik557c8822018-10-25 15:04:03 -0700[diff] [blame]145 method public abstract void detach();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]146 method public T? get(int index);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]147 method public androidx.paging.PagedList.Config getConfig();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]148 method public abstract androidx.paging.DataSource<?,T> getDataSource();
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]149 method public abstract Object? getLastKey();
Chris Craik00cf2052018-08-10 14:00:23 -0700[diff] [blame]150 method public int getLoadedCount();
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]151 method public int getPositionOffset();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]152 method public int getSize();
153 method public abstract boolean isContiguous();
Chris Craik557c8822018-10-25 15:04:03 -0700[diff] [blame]154 method public abstract boolean isDetached();
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]155 method public boolean isImmutable();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]156 method public void loadAround(int index);
157 method public void removeWeakCallback(androidx.paging.PagedList.Callback callback);
Dustin Lam7b116f52019-06-12 13:51:31 -0700[diff] [blame]158 method public void removeWeakLoadStateListener(kotlin.jvm.functions.Function3<? super androidx.paging.PagedList.LoadType,? super androidx.paging.PagedList.LoadState,? super java.lang.Throwable,kotlin.Unit> listener);
Chris Craikcf72bdc2018-10-18 13:32:02 -0700[diff] [blame]159 method public void retry();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]160 method public java.util.List<T> snapshot();
161 property public androidx.paging.PagedList.Config config;
162 property public abstract androidx.paging.DataSource<?,T> dataSource;
163 property public abstract boolean isContiguous;
164 property public abstract boolean isDetached;
165 property public boolean isImmutable;
166 property public abstract Object? lastKey;
167 property public int loadedCount;
168 property public int positionOffset;
169 property public int size;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]170 }
171
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]172 @MainThread public abstract static class PagedList.BoundaryCallback<T> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]173 ctor public PagedList.BoundaryCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]174 method public void onItemAtEndLoaded(T? itemAtEnd);
175 method public void onItemAtFrontLoaded(T? itemAtFront);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]176 method public void onZeroItemsLoaded();
177 }
178
179 public static final class PagedList.Builder<Key, Value> {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]180 ctor public PagedList.Builder(androidx.paging.DataSource<Key,Value> dataSource, androidx.paging.PagedList.Config config);
181 ctor public PagedList.Builder(androidx.paging.DataSource<Key,Value> dataSource, int pageSize);
182 method @Deprecated @WorkerThread public androidx.paging.PagedList<Value> build();
Dustin Lamb21368c2019-06-27 17:23:13 -0700[diff] [blame^]183 method public suspend Object buildAsync(kotlin.coroutines.Continuation<? super androidx.paging.PagedList<Value>> p);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]184 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]185 method public androidx.paging.PagedList.Builder<Key,Value> setCoroutineScope(kotlinx.coroutines.CoroutineScope coroutineScope);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]186 method public androidx.paging.PagedList.Builder<Key,Value> setFetchExecutor(java.util.concurrent.Executor fetchExecutor);
187 method public androidx.paging.PagedList.Builder<Key,Value> setInitialKey(Key? initialKey);
188 method public androidx.paging.PagedList.Builder<Key,Value> setNotifyExecutor(java.util.concurrent.Executor notifyExecutor);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]189 }
190
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]191 public abstract static class PagedList.Callback {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]192 ctor public PagedList.Callback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]193 method public abstract void onChanged(int position, int count);
194 method public abstract void onInserted(int position, int count);
195 method public abstract void onRemoved(int position, int count);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]196 }
197
Dustin Lamb2de3cc2019-06-12 09:47:19 -0700[diff] [blame]198 public static final class PagedList.Config {
Chris Craike8ca38c2018-05-22 18:08:16 -0700[diff] [blame]199 field public static final int MAX_SIZE_UNBOUNDED = 2147483647; // 0x7fffffff
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]200 field public final boolean enablePlaceholders;
201 field public final int initialLoadSizeHint;
Chris Craike8ca38c2018-05-22 18:08:16 -0700[diff] [blame]202 field public final int maxSize;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]203 field public final int pageSize;
204 field public final int prefetchDistance;
205 }
206
207 public static final class PagedList.Config.Builder {
208 ctor public PagedList.Config.Builder();
209 method public androidx.paging.PagedList.Config build();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]210 method public androidx.paging.PagedList.Config.Builder setEnablePlaceholders(boolean enablePlaceholders);
211 method public androidx.paging.PagedList.Config.Builder setInitialLoadSizeHint(@IntRange(from=1) int initialLoadSizeHint);
212 method public androidx.paging.PagedList.Config.Builder setMaxSize(@IntRange(from=2) int maxSize);
213 method public androidx.paging.PagedList.Config.Builder setPageSize(@IntRange(from=1) int pageSize);
214 method public androidx.paging.PagedList.Config.Builder setPrefetchDistance(@IntRange(from=0) int prefetchDistance);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]215 }
216
Jeff Gaston5d65a6a2019-01-23 13:44:15 -0500[diff] [blame]217 public enum PagedList.LoadState {
Chris Craikcf72bdc2018-10-18 13:32:02 -0700[diff] [blame]218 enum_constant public static final androidx.paging.PagedList.LoadState DONE;
219 enum_constant public static final androidx.paging.PagedList.LoadState ERROR;
220 enum_constant public static final androidx.paging.PagedList.LoadState IDLE;
221 enum_constant public static final androidx.paging.PagedList.LoadState LOADING;
222 enum_constant public static final androidx.paging.PagedList.LoadState RETRYABLE_ERROR;
223 }
224
Jeff Gaston5d65a6a2019-01-23 13:44:15 -0500[diff] [blame]225 public enum PagedList.LoadType {
Chris Craikcf72bdc2018-10-18 13:32:02 -0700[diff] [blame]226 enum_constant public static final androidx.paging.PagedList.LoadType END;
227 enum_constant public static final androidx.paging.PagedList.LoadType REFRESH;
228 enum_constant public static final androidx.paging.PagedList.LoadType START;
229 }
230
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]231 public final class PagedListConfigKt {
232 ctor public PagedListConfigKt();
233 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);
234 }
235
Dustin Lam26ca1a72019-05-28 17:42:51 -0700[diff] [blame]236 public final class PagedListKt {
237 ctor public PagedListKt();
238 method 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);
239 }
240
Dustin Lamff2f9792019-06-14 19:38:01 -0700[diff] [blame]241 public abstract class PagedSource<Key, Value> {
242 ctor public PagedSource();
243 method public abstract boolean getInvalid();
244 method public abstract androidx.paging.PagedSource.KeyProvider<Key,Value> getKeyProvider();
245 method public abstract void invalidate();
246 method public abstract boolean isRetryableError(Throwable error);
Dustin Lamdba215c2019-06-21 17:35:26 -0700[diff] [blame]247 method public abstract suspend Object load(androidx.paging.PagedSource.LoadParams<Key> params, kotlin.coroutines.Continuation<? super androidx.paging.PagedSource.LoadResult<Key,Value>> p);
Dustin Lamff2f9792019-06-14 19:38:01 -0700[diff] [blame]248 property public abstract boolean invalid;
249 property public abstract androidx.paging.PagedSource.KeyProvider<Key,Value> keyProvider;
250 field public static final int COUNT_UNDEFINED = -1; // 0xffffffff
251 field public static final androidx.paging.PagedSource.Companion! Companion;
252 }
253
254 public static final class PagedSource.Companion {
255 }
256
257 public abstract static sealed class PagedSource.KeyProvider<Key, Value> {
258 }
259
260 public abstract static class PagedSource.KeyProvider.ItemKey<Key, Value> extends androidx.paging.PagedSource.KeyProvider<Key,Value> {
261 ctor public PagedSource.KeyProvider.ItemKey();
262 method public abstract Key getKey(Value item);
263 }
264
265 public static final class PagedSource.KeyProvider.PageKey<Key, Value> extends androidx.paging.PagedSource.KeyProvider<Key,Value> {
266 ctor public PagedSource.KeyProvider.PageKey();
267 }
268
269 public static final class PagedSource.KeyProvider.Positional<Value> extends androidx.paging.PagedSource.KeyProvider<java.lang.Integer,Value> {
270 ctor public PagedSource.KeyProvider.Positional();
271 }
272
273 public static final class PagedSource.LoadParams<Key> {
274 ctor public PagedSource.LoadParams(androidx.paging.PagedSource.LoadType loadType, Key? key, int loadSize, boolean placeholdersEnabled, int pageSize);
275 method public androidx.paging.PagedSource.LoadType component1();
276 method public Key? component2();
277 method public int component3();
278 method public boolean component4();
279 method public int component5();
280 method public androidx.paging.PagedSource.LoadParams<Key> copy(androidx.paging.PagedSource.LoadType loadType, Key? key, int loadSize, boolean placeholdersEnabled, int pageSize);
281 method public Key? getKey();
282 method public int getLoadSize();
283 method public androidx.paging.PagedSource.LoadType getLoadType();
284 method public int getPageSize();
285 method public boolean getPlaceholdersEnabled();
286 }
287
288 public static final class PagedSource.LoadResult<Key, Value> {
289 ctor public PagedSource.LoadResult(int itemsBefore, int itemsAfter, Key? nextKey, Key? prevKey, java.util.List<? extends Value> data, int offset, boolean counted);
290 method public int component1();
291 method public int component2();
292 method public Key? component3();
293 method public Key? component4();
294 method public java.util.List<Value> component5();
295 method public int component6();
296 method public boolean component7();
297 method public androidx.paging.PagedSource.LoadResult<Key,Value> copy(int itemsBefore, int itemsAfter, Key? nextKey, Key? prevKey, java.util.List<? extends Value> data, int offset, boolean counted);
298 method public boolean getCounted();
299 method public java.util.List<Value> getData();
300 method public int getItemsAfter();
301 method public int getItemsBefore();
302 method public Key? getNextKey();
303 method public int getOffset();
304 method public Key? getPrevKey();
305 }
306
307 public enum PagedSource.LoadType {
308 enum_constant public static final androidx.paging.PagedSource.LoadType END;
309 enum_constant public static final androidx.paging.PagedSource.LoadType INITIAL;
310 enum_constant public static final androidx.paging.PagedSource.LoadType START;
311 }
312
Dustin Lama7fecfa2019-06-20 18:39:13 -0700[diff] [blame]313 public abstract class PositionalDataSource<T> extends androidx.paging.DataSource<java.lang.Integer,T> {
Chris Craik557c8822018-10-25 15:04:03 -0700[diff] [blame]314 ctor public PositionalDataSource();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]315 method public static final int computeInitialLoadPosition(androidx.paging.PositionalDataSource.LoadInitialParams params, int totalCount);
316 method public static final int computeInitialLoadSize(androidx.paging.PositionalDataSource.LoadInitialParams params, int initialLoadPosition, int totalCount);
Dustin Lamd847ca62019-06-24 14:53:17 -0700[diff] [blame]317 method public final suspend Object load$lintWithKotlin(androidx.paging.DataSource.Params<java.lang.Integer> params, kotlin.coroutines.Continuation<? super androidx.paging.DataSource.BaseResult<T>> p);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]318 method @WorkerThread public abstract void loadInitial(androidx.paging.PositionalDataSource.LoadInitialParams params, androidx.paging.PositionalDataSource.LoadInitialCallback<T> callback);
Dustin Lam8c46d1b2019-06-25 17:09:59 -0700[diff] [blame]319 method @VisibleForTesting public final suspend Object loadInitial$lintWithKotlin(androidx.paging.PositionalDataSource.LoadInitialParams params, kotlin.coroutines.Continuation<? super androidx.paging.PositionalDataSource.InitialResult<T>> p);
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]320 method @WorkerThread public abstract void loadRange(androidx.paging.PositionalDataSource.LoadRangeParams params, androidx.paging.PositionalDataSource.LoadRangeCallback<T> callback);
321 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]322 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]323 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]324 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]325 }
326
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]327 public abstract static class PositionalDataSource.LoadInitialCallback<T> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]328 ctor public PositionalDataSource.LoadInitialCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]329 method public void onError(Throwable error);
330 method public abstract void onResult(java.util.List<? extends T> data, int position, int totalCount);
331 method public abstract void onResult(java.util.List<? extends T> data, int position);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]332 }
333
Dustin Lama7fecfa2019-06-20 18:39:13 -0700[diff] [blame]334 public static class PositionalDataSource.LoadInitialParams {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]335 ctor public PositionalDataSource.LoadInitialParams(int requestedStartPosition, int requestedLoadSize, int pageSize, boolean placeholdersEnabled);
Dustin Lama7fecfa2019-06-20 18:39:13 -0700[diff] [blame]336 field public final int pageSize;
337 field public final boolean placeholdersEnabled;
338 field public final int requestedLoadSize;
339 field public final int requestedStartPosition;
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]340 }
341
Jeff Gastonc21caf92018-10-16 13:24:41 -0400[diff] [blame]342 public abstract static class PositionalDataSource.LoadRangeCallback<T> {
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]343 ctor public PositionalDataSource.LoadRangeCallback();
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]344 method public void onError(Throwable error);
345 method public abstract void onResult(java.util.List<? extends T> data);
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]346 }
347
Dustin Lama7fecfa2019-06-20 18:39:13 -0700[diff] [blame]348 public static class PositionalDataSource.LoadRangeParams {
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]349 ctor public PositionalDataSource.LoadRangeParams(int startPosition, int loadSize);
Dustin Lama7fecfa2019-06-20 18:39:13 -0700[diff] [blame]350 field public final int loadSize;
351 field public final int startPosition;
Dustin Lamb6bab3f2019-05-20 08:05:34 -0700[diff] [blame]352 }
353
354}
355
356package androidx.paging.futures {
357
Dustin Lam77e18d12019-06-13 10:53:57 -0700[diff] [blame]358 public final class DirectExecutorKt {
359 ctor public DirectExecutorKt();
360 }
361
Chris Craik7cb60412018-04-04 13:02:50 -0700[diff] [blame]362}
363