Google Git
Sign in
android / platform / tools / dokka-devsite-plugin / 3adcc28f9ebb13ca9b17d41f0e2bc88a5d0029ad / . / testData / paging / docs / reference / androidx / paging / LoadState.Error.html
blob: 7fdbab208a7c7fbe99f560e2ec2d68aa9457835f [file] [log] [blame]
<html devsite="true">
<head>
<title>LoadState.Error</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>LoadState.Error</h1>
{% setvar page_path %}androidx/paging/LoadState.Error.html{% endsetvar %}
{% setvar can_switch %}1{% endsetvar %}
{% include "reference/_java_switcher2.md" %}
<p>
<pre>public final class LoadState.Error extends <a href="/reference/androidx/paging/LoadState.html">LoadState</a></pre>
</p>
<div class="devsite-table-wrapper">
<table class="jd-inheritance-table">
<tbody>
<tr>
<td colspan="3"><a href="https://developer.android.com/reference/java/lang/Object.html">Object</a></td>
</tr>
<tr>
<td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;↳</td>
<td colspan="2"><a href="/reference/androidx/paging/LoadState.html">LoadState</a></td>
</tr>
<tr>
<td>&nbsp;</td>
<td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;↳</td>
<td colspan="1"><a href="/reference/androidx/paging/LoadState.Error.html">LoadState.Error</a></td>
</tr>
</tbody>
</table>
</div>
<hr>
<p>Loading hit an error.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">See also</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/androidx/paging/PagedList.html#retry()">retry</a></code></td>
<td width="100%"></td>
</tr>
</tbody>
</table>
</div>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public fields</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>final boolean</code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/LoadState.Error.html#endOfPaginationReached()">endOfPaginationReached</a></code></div>
<p><code>false</code> if there is more data to load in the <code><a href="/reference/androidx/paging/LoadType.html">LoadType</a></code> this <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> is associated with, <code>true</code> otherwise.</p>
</td>
</tr>
<tr>
<td><code>final <a href="https://developer.android.com/reference/java/lang/Throwable.html">Throwable</a></code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/LoadState.Error.html#error()">error</a></code></div>
<p><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a></code> that caused the load operation to generate this error state.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public constructors</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td>
<div><code><a href="/reference/androidx/paging/LoadState.Error.html#Error(kotlin.Throwable)">Error</a>(<a href="https://developer.android.com/reference/java/lang/Throwable.html">Throwable</a>&nbsp;error)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>boolean</code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/LoadState.Error.html#equals(kotlin.Any)">equals</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;other)</code></div>
</td>
</tr>
<tr>
<td><code>int</code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/LoadState.Error.html#hashCode()">hashCode</a>()</code></div>
</td>
</tr>
<tr>
<td><code><a href="https://developer.android.com/reference/java/lang/String.html">String</a></code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/LoadState.Error.html#toString()">toString</a>()</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public fields</h2>
<div><a name="getEndOfPaginationReached()"></a><a name="setEndOfPaginationReached()"></a><a name="getEndOfPaginationReached--"></a><a name="setEndOfPaginationReached--"></a>
<h3 class="api-name" id="endOfPaginationReached()">endOfPaginationReached</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;boolean&nbsp;<a href="/reference/androidx/paging/LoadState.Error.html#endOfPaginationReached()">endOfPaginationReached</a></pre>
<p><code>false</code> if there is more data to load in the <code><a href="/reference/androidx/paging/LoadType.html">LoadType</a></code> this <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> is associated with, <code>true</code> otherwise. This parameter informs <code><a href="/reference/androidx/paging/Pager.html">Pager</a></code> if it should continue to make requests for additional data in this direction or if it should halt as the end of the dataset has been reached.</p>
</div>
<div><a name="getError()"></a><a name="setError()"></a><a name="getError--"></a><a name="setError--"></a>
<h3 class="api-name" id="error()">error</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;<a href="https://developer.android.com/reference/java/lang/Throwable.html">Throwable</a>&nbsp;<a href="/reference/androidx/paging/LoadState.Error.html#error()">error</a></pre>
<p><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a></code> that caused the load operation to generate this error state.</p>
</div>
<h2>Public constructors</h2>
<div><a name="Error-kotlin.Throwable-"></a>
<h3 class="api-name" id="Error(kotlin.Throwable)">Error</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;<a href="/reference/androidx/paging/LoadState.Error.html#Error(kotlin.Throwable)">Error</a>(<a href="https://developer.android.com/reference/java/lang/Throwable.html">Throwable</a>&nbsp;error)</pre>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="https://developer.android.com/reference/java/lang/Throwable.html">Throwable</a>&nbsp;error</code></td>
<td width="100%">
<p><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a></code> that caused the load operation to generate this error state.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h2>Public methods</h2>
<div><a name="equals-kotlin.Any-"></a>
<h3 class="api-name" id="equals(kotlin.Any)">equals</h3>
<pre class="api-signature no-pretty-print">public&nbsp;boolean&nbsp;<a href="/reference/androidx/paging/LoadState.Error.html#equals(kotlin.Any)">equals</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&nbsp;other)</pre>
</div>
<div><a name="hashCode--"></a>
<h3 class="api-name" id="hashCode()">hashCode</h3>
<pre class="api-signature no-pretty-print">public&nbsp;int&nbsp;<a href="/reference/androidx/paging/LoadState.Error.html#hashCode()">hashCode</a>()</pre>
</div>
<div><a name="toString--"></a>
<h3 class="api-name" id="toString()">toString</h3>
<pre class="api-signature no-pretty-print">public&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;<a href="/reference/androidx/paging/LoadState.Error.html#toString()">toString</a>()</pre>
</div>
</body>
</html>