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