Google Git
Sign in
android/platform/tools/dokka-devsite-plugin/0a4e539cb5607c306e3ffe51b616f4e6601a4bc3/./testData/paging/docs/reference/androidx/paging/CombinedLoadStates.html
blob: f86c939c2b7faa6f88432ec276b49ddae0c349d1 [file]
<html devsite="true">
<head>
<title>CombinedLoadStates</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div itemscope="" itemtype="http://developers.google.com/ReferenceObject">
<meta itemprop="name" content="CombinedLoadStates">
<meta itemprop="path" content="androidx.paging">
<meta itemprop="property" content="equals(kotlin.Any)">
<meta itemprop="property" content="getAppend()">
<meta itemprop="property" content="getMediator()">
<meta itemprop="property" content="getPrepend()">
<meta itemprop="property" content="getRefresh()">
<meta itemprop="property" content="getSource()">
<meta itemprop="property" content="hashCode()">
<meta itemprop="property" content="toString()">
<meta itemprop="language" content="JAVA">
</div>
<div id="header-block">
<div>
<h1>CombinedLoadStates</h1>
</div>
<div id="metadata-info-block">
<div id="source-link"><a href="https://cs.android.com/search?q=file:androidx/paging/CombinedLoadStates.kt+class:androidx.paging.CombinedLoadStates&amp;ss=androidx/platform/frameworks/support" class="external">View Source</a></div>
</div>
</div>
<div id="refdoc-switcher-placeholder"></div>
<p>
<pre>public final class <a href="/reference/androidx/paging/CombinedLoadStates.html">CombinedLoadStates</a></pre>
</p>
<hr>
<p>Collection of pagination <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code>s for both a <code><a href="/reference/androidx/paging/PagingSource.html">PagingSource</a></code>, and <code><a href="/reference/androidx/paging/RemoteMediator.html">RemoteMediator</a></code>.</p>
<p>Note: The REFRESH<code><a href="/reference/androidx/paging/LoadType.html#REFRESH">LoadType.REFRESH</a></code> always has <code><a href="/reference/androidx/paging/LoadState.html#endOfPaginationReached()">LoadState.endOfPaginationReached</a></code> set to <code>false</code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Public constructors</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td>
<div><code><a href="/reference/androidx/paging/CombinedLoadStates.html#CombinedLoadStates(androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadStates,androidx.paging.LoadStates)">CombinedLoadStates</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a>&nbsp;refresh,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a>&nbsp;prepend,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a>&nbsp;append,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadStates.html">LoadStates</a>&nbsp;source,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/LoadStates.html">LoadStates</a>&nbsp;mediator<br>)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>boolean</code></td>
<td>
<div><code><a href="/reference/androidx/paging/CombinedLoadStates.html#equals(kotlin.Any)">equals</a>(<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;other)</code></div>
</td>
</tr>
<tr>
<td><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a></code></td>
<td>
<div><code><a href="/reference/androidx/paging/CombinedLoadStates.html#getAppend()">getAppend</a>()</code></div>
<p>Convenience for combined behavior of <code><a href="/reference/androidx/paging/LoadType.html#REFRESH">APPEND</a></code> <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code>, which generally defers to <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> if it exists, but if previously was <code><a href="/reference/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code>, awaits for both <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> to become <code><a href="/reference/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code> to ensure the remote load was applied.</p>
</td>
</tr>
<tr>
<td><code>final <a href="/reference/androidx/paging/LoadStates.html">LoadStates</a></code></td>
<td>
<div><code><a href="/reference/androidx/paging/CombinedLoadStates.html#getMediator()">getMediator</a>()</code></div>
<p><code><a href="/reference/androidx/paging/LoadStates.html">LoadStates</a></code> corresponding to loads from a <code><a href="/reference/androidx/paging/RemoteMediator.html">RemoteMediator</a></code>, or <code>null</code> if <code><a href="/reference/androidx/paging/RemoteMediator.html">RemoteMediator</a></code> not present.</p>
</td>
</tr>
<tr>
<td><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a></code></td>
<td>
<div><code><a href="/reference/androidx/paging/CombinedLoadStates.html#getPrepend()">getPrepend</a>()</code></div>
<p>Convenience for combined behavior of <code><a href="/reference/androidx/paging/LoadType.html#REFRESH">PREPEND</a></code> <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code>, which generally defers to <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> if it exists, but if previously was <code><a href="/reference/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code>, awaits for both <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> to become <code><a href="/reference/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code> to ensure the remote load was applied.</p>
</td>
</tr>
<tr>
<td><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a></code></td>
<td>
<div><code><a href="/reference/androidx/paging/CombinedLoadStates.html#getRefresh()">getRefresh</a>()</code></div>
<p>Convenience for combined behavior of <code><a href="/reference/androidx/paging/LoadType.html#REFRESH">REFRESH</a></code> <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code>, which generally defers to <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> if it exists, but if previously was <code><a href="/reference/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code>, awaits for both <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> to become <code><a href="/reference/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code> to ensure the remote load was applied.</p>
</td>
</tr>
<tr>
<td><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadStates.html">LoadStates</a></code></td>
<td>
<div><code><a href="/reference/androidx/paging/CombinedLoadStates.html#getSource()">getSource</a>()</code></div>
<p><code><a href="/reference/androidx/paging/LoadStates.html">LoadStates</a></code> corresponding to loads from a <code><a href="/reference/androidx/paging/PagingSource.html">PagingSource</a></code>.</p>
</td>
</tr>
<tr>
<td><code>int</code></td>
<td>
<div><code><a href="/reference/androidx/paging/CombinedLoadStates.html#hashCode()">hashCode</a>()</code></div>
</td>
</tr>
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a></code></td>
<td>
<div><code><a href="/reference/androidx/paging/CombinedLoadStates.html#toString()">toString</a>()</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="CombinedLoadStates(androidx.paging.LoadState, androidx.paging.LoadState, androidx.paging.LoadState, androidx.paging.LoadStates, androidx.paging.LoadStates)"></a><a name="CombinedLoadStates-androidx.paging.LoadState-androidx.paging.LoadState-androidx.paging.LoadState-androidx.paging.LoadStates-androidx.paging.LoadStates-"></a><a name="combinedloadstates"></a>
<div class="api-name-block">
<div>
<h3 id="CombinedLoadStates(androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadStates,androidx.paging.LoadStates)">CombinedLoadStates</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;<a href="/reference/androidx/paging/CombinedLoadStates.html#CombinedLoadStates(androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadStates,androidx.paging.LoadStates)">CombinedLoadStates</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a>&nbsp;refresh,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a>&nbsp;prepend,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a>&nbsp;append,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadStates.html">LoadStates</a>&nbsp;source,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/LoadStates.html">LoadStates</a>&nbsp;mediator<br>)</pre>
</div>
</div>
<div class="list">
<h2>Public methods</h2>
<div class="api-item"><a name="equals-kotlin.Any-"></a><a name="equals"></a>
<div class="api-name-block">
<div>
<h3 id="equals(kotlin.Any)">equals</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;boolean&nbsp;<a href="/reference/androidx/paging/CombinedLoadStates.html#equals(kotlin.Any)">equals</a>(<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;other)</pre>
</div>
<div class="api-item"><a name="getAppend--"></a><a name="getappend"></a>
<div class="api-name-block">
<div>
<h3 id="getAppend()">getAppend</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a>&nbsp;<a href="/reference/androidx/paging/CombinedLoadStates.html#getAppend()">getAppend</a>()</pre>
<p>Convenience for combined behavior of <code><a href="/reference/androidx/paging/LoadType.html#REFRESH">APPEND</a></code> <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code>, which generally defers to <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> if it exists, but if previously was <code><a href="/reference/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code>, awaits for both <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> to become <code><a href="/reference/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code> to ensure the remote load was applied.</p>
<p>For use cases that require reacting to <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> of <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> specifically, e.g., showing cached data when network loads via <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> fail, <code><a href="/reference/androidx/paging/LoadStates.html">LoadStates</a></code> exposed via <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> should be used directly.</p>
</div>
<div class="api-item"><a name="getMediator--"></a><a name="getmediator"></a>
<div class="api-name-block">
<div>
<h3 id="getMediator()">getMediator</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;<a href="/reference/androidx/paging/LoadStates.html">LoadStates</a>&nbsp;<a href="/reference/androidx/paging/CombinedLoadStates.html#getMediator()">getMediator</a>()</pre>
<p><code><a href="/reference/androidx/paging/LoadStates.html">LoadStates</a></code> corresponding to loads from a <code><a href="/reference/androidx/paging/RemoteMediator.html">RemoteMediator</a></code>, or <code>null</code> if <code><a href="/reference/androidx/paging/RemoteMediator.html">RemoteMediator</a></code> not present.</p>
</div>
<div class="api-item"><a name="getPrepend--"></a><a name="getprepend"></a>
<div class="api-name-block">
<div>
<h3 id="getPrepend()">getPrepend</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a>&nbsp;<a href="/reference/androidx/paging/CombinedLoadStates.html#getPrepend()">getPrepend</a>()</pre>
<p>Convenience for combined behavior of <code><a href="/reference/androidx/paging/LoadType.html#REFRESH">PREPEND</a></code> <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code>, which generally defers to <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> if it exists, but if previously was <code><a href="/reference/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code>, awaits for both <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> to become <code><a href="/reference/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code> to ensure the remote load was applied.</p>
<p>For use cases that require reacting to <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> of <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> specifically, e.g., showing cached data when network loads via <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> fail, <code><a href="/reference/androidx/paging/LoadStates.html">LoadStates</a></code> exposed via <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> should be used directly.</p>
</div>
<div class="api-item"><a name="getRefresh--"></a><a name="getrefresh"></a>
<div class="api-name-block">
<div>
<h3 id="getRefresh()">getRefresh</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadState.html">LoadState</a>&nbsp;<a href="/reference/androidx/paging/CombinedLoadStates.html#getRefresh()">getRefresh</a>()</pre>
<p>Convenience for combined behavior of <code><a href="/reference/androidx/paging/LoadType.html#REFRESH">REFRESH</a></code> <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code>, which generally defers to <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> if it exists, but if previously was <code><a href="/reference/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code>, awaits for both <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> to become <code><a href="/reference/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code> to ensure the remote load was applied.</p>
<p>For use cases that require reacting to <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> of <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> specifically, e.g., showing cached data when network loads via <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> fail, <code><a href="/reference/androidx/paging/LoadStates.html">LoadStates</a></code> exposed via <code><a href="/reference/androidx/paging/CombinedLoadStates.html#source()">source</a></code> and <code><a href="/reference/androidx/paging/CombinedLoadStates.html#mediator()">mediator</a></code> should be used directly.</p>
</div>
<div class="api-item"><a name="getSource--"></a><a name="getsource"></a>
<div class="api-name-block">
<div>
<h3 id="getSource()">getSource</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="/reference/androidx/paging/LoadStates.html">LoadStates</a>&nbsp;<a href="/reference/androidx/paging/CombinedLoadStates.html#getSource()">getSource</a>()</pre>
<p><code><a href="/reference/androidx/paging/LoadStates.html">LoadStates</a></code> corresponding to loads from a <code><a href="/reference/androidx/paging/PagingSource.html">PagingSource</a></code>.</p>
</div>
<div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
<div class="api-name-block">
<div>
<h3 id="hashCode()">hashCode</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;int&nbsp;<a href="/reference/androidx/paging/CombinedLoadStates.html#hashCode()">hashCode</a>()</pre>
</div>
<div class="api-item"><a name="toString--"></a><a name="tostring"></a>
<div class="api-name-block">
<div>
<h3 id="toString()">toString</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;<a href="/reference/androidx/paging/CombinedLoadStates.html#toString()">toString</a>()</pre>
</div>
</div>
</body>
</html>