Google Git
Sign in
android / platform / tools / dokka-devsite-plugin / 3adcc28f9ebb13ca9b17d41f0e2bc88a5d0029ad / . / testData / paging / docs / reference / kotlin / androidx / paging / ItemSnapshotList.html
blob: 6973e1a1affed664addd202afc20443f3945ac02 [file] [log] [blame]
<html devsite="true">
<head>
<title>ItemSnapshotList</title>
{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>ItemSnapshotList</h1>
{% setvar page_path %}androidx/paging/ItemSnapshotList.html{% endsetvar %}
{% setvar can_switch %}1{% endsetvar %}
{% include "reference/_kotlin_switcher2.md" %}
<p>
<pre>class ItemSnapshotList&lt;T&nbsp;:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?&gt;</pre>
</p>
<hr>
<p>Snapshot of data being presented by a <a href="[androidx.pagingAsyncPagingDataDiffer]">androidx.pagingAsyncPagingDataDiffer</a> or a <code><a href="/reference/kotlin/androidx/paging/PagingDataAdapter.html">PagingDataAdapter</a></code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a>&lt;T&gt;</code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#items()">items</a></code></div>
<p>The presented data, excluding placeholders.</p>
</td>
</tr>
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#placeholdersAfter()">placeholdersAfter</a></code></div>
<p>Number of placeholders after the presented <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#items()">items</a></code>, 0 if <code><a href="/reference/kotlin/androidx/paging/PagingConfig.html#enablePlaceholders()">enablePlaceholders</a></code> is <code>false</code>.</p>
</td>
</tr>
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#placeholdersBefore()">placeholdersBefore</a></code></div>
<p>Number of placeholders before the presented <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#items()">items</a></code>, 0 if <code><a href="/reference/kotlin/androidx/paging/PagingConfig.html#enablePlaceholders()">enablePlaceholders</a></code> is <code>false</code>.</p>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#size()">size</a></code></div>
<p>Size of <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html">ItemSnapshotList</a></code> including placeholders.</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>&lt;T&nbsp;:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?&gt; <a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#ItemSnapshotList(kotlin.Int,kotlin.Int,kotlin.collections.List)">ItemSnapshotList</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-int-range/index.html">IntRange</a>&nbsp;placeholdersBefore:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-int-range/index.html">IntRange</a>&nbsp;placeholdersAfter:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;items:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a>&lt;T&gt;<br>)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public functions</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>operator&nbsp;open T?</code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#get(kotlin.Int)">get</a>(index:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>)</code></div>
<p>Returns the item at <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#index()">index</a></code>, where <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#index()">index</a></code> includes the position of placeholders.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive" id="inhmethods">
<thead>
<tr>
<th colspan="2"><h3>Inherited functions</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><devsite-expandable><span class="expand-control">From class <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-collection/index.html">AbstractCollection</a></span>
<div class="devsite-table-wrapper">
<table class="responsive">
<tbody>
<tr>
<td><code>operator&nbsp;open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-collection/contains.html">contains</a>(element:&nbsp;T?)</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-collection/contains-all.html">containsAll</a>(elements:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/index.html">Collection</a>&lt;T?&gt;)</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-collection/is-empty.html">isEmpty</a>()</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-collection/to-string.html">toString</a>()</code></div>
</td>
</tr>
</tbody>
</table>
</div>
</devsite-expandable> </td>
</tr>
<tr>
<td><devsite-expandable><span class="expand-control">From class <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-list/index.html">AbstractList</a></span>
<div class="devsite-table-wrapper">
<table class="responsive">
<tbody>
<tr>
<td><code>operator&nbsp;open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-list/equals.html">equals</a>(other:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?)</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-list/hash-code.html">hashCode</a>()</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-list/index-of.html">indexOf</a>(element:&nbsp;T?)</code></div>
</td>
</tr>
<tr>
<td><code>operator&nbsp;open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterator/index.html">Iterator</a>&lt;T?&gt;</code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-list/iterator.html">iterator</a>()</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-list/last-index-of.html">lastIndexOf</a>(element:&nbsp;T?)</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list-iterator/index.html">ListIterator</a>&lt;T?&gt;</code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-list/list-iterator.html">listIterator</a>()</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list-iterator/index.html">ListIterator</a>&lt;T?&gt;</code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-list/list-iterator.html">listIterator</a>(index:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>)</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a>&lt;T?&gt;</code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-abstract-list/sub-list.html">subList</a>(fromIndex:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,&nbsp;toIndex:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
</devsite-expandable> </td>
</tr>
<tr>
<td><devsite-expandable><span class="expand-control">From class <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html">Iterable</a></span>
<div class="devsite-table-wrapper">
<table class="responsive">
<tbody>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/for-each.html">forEach</a>(p0:&nbsp;<a href="https://developer.android.com/reference/java/util/function/Consumer.html">Consumer</a>&lt;T?&gt;)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
</devsite-expandable> </td>
</tr>
<tr>
<td><devsite-expandable><span class="expand-control">From class <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/index.html">Collection</a></span>
<div class="devsite-table-wrapper">
<table class="responsive">
<tbody>
<tr>
<td><code>open <a href="https://developer.android.com/reference/java/util/stream/Stream.html">Stream</a>&lt;T?&gt;</code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/parallel-stream.html">parallelStream</a>()</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://developer.android.com/reference/java/util/Spliterator.html">Spliterator</a>&lt;T?&gt;</code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/spliterator.html">spliterator</a>()</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://developer.android.com/reference/java/util/stream/Stream.html">Stream</a>&lt;T?&gt;</code></td>
<td width="100%">
<div><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/stream.html">stream</a>()</code></div>
</td>
</tr>
<tr>
<td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;T&gt;</code></td>
<td width="100%">
<div><code>&lt;T&nbsp;:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>&gt; <span><del><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/to-array.html">toArray</a></del></span>(p0:&nbsp;<a href="https://developer.android.com/reference/java/util/function/IntFunction.html">IntFunction</a>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;T&gt;&gt;)</code></div>
<p><strong>This function is deprecated.</strong> This member is not fully supported by Kotlin compiler, so it may be absent or have different signature in next major version</p>
</td>
</tr>
</tbody>
</table>
</div>
</devsite-expandable> </td>
</tr>
</tbody>
</table>
</div>
<h2>Public properties</h2>
<div><a name="getItems()"></a><a name="setItems()"></a><a name="getItems--"></a><a name="setItems--"></a>
<h3 class="api-name" id="items()">items</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#items()">items</a>:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a>&lt;T&gt;</pre>
<p>The presented data, excluding placeholders.</p>
</div>
<div><a name="getPlaceholdersAfter()"></a><a name="setPlaceholdersAfter()"></a><a name="getPlaceholdersAfter--"></a><a name="setPlaceholdersAfter--"></a>
<h3 class="api-name" id="placeholdersAfter()">placeholdersAfter</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#placeholdersAfter()">placeholdersAfter</a>:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
<p>Number of placeholders after the presented <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#items()">items</a></code>, 0 if <code><a href="/reference/kotlin/androidx/paging/PagingConfig.html#enablePlaceholders()">enablePlaceholders</a></code> is <code>false</code>.</p>
</div>
<div><a name="getPlaceholdersBefore()"></a><a name="setPlaceholdersBefore()"></a><a name="getPlaceholdersBefore--"></a><a name="setPlaceholdersBefore--"></a>
<h3 class="api-name" id="placeholdersBefore()">placeholdersBefore</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#placeholdersBefore()">placeholdersBefore</a>:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
<p>Number of placeholders before the presented <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#items()">items</a></code>, 0 if <code><a href="/reference/kotlin/androidx/paging/PagingConfig.html#enablePlaceholders()">enablePlaceholders</a></code> is <code>false</code>.</p>
</div>
<div><a name="getSize()"></a><a name="setSize()"></a><a name="getSize--"></a><a name="setSize--"></a>
<h3 class="api-name" id="size()">size</h3>
<pre class="api-signature no-pretty-print">open&nbsp;val&nbsp;<a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#size()">size</a>:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
<p>Size of <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html">ItemSnapshotList</a></code> including placeholders.</p>
<p>To get the size excluding placeholders, use <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/size.html">List.size</a></code> on <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#items()">items</a></code> directly.</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/kotlin/androidx/paging/ItemSnapshotList.html#items()">items</a></code></td>
<td width="100%"></td>
</tr>
</tbody>
</table>
</div>
</div>
<h2>Public constructors</h2>
<div><a name="ItemSnapshotList(kotlin.Int, kotlin.Int, kotlin.collections.List)"></a><a name="ItemSnapshotList-kotlin.Int-kotlin.Int-kotlin.collections.List-"></a>
<h3 class="api-name" id="ItemSnapshotList(kotlin.Int,kotlin.Int,kotlin.collections.List)">ItemSnapshotList</h3>
<pre class="api-signature no-pretty-print">&lt;T&nbsp;:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?&gt; <a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#ItemSnapshotList(kotlin.Int,kotlin.Int,kotlin.collections.List)">ItemSnapshotList</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-int-range/index.html">IntRange</a>&nbsp;placeholdersBefore:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-int-range/index.html">IntRange</a>&nbsp;placeholdersAfter:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;items:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a>&lt;T&gt;<br>)</pre>
</div>
<h2>Public functions</h2>
<div><a name="get-kotlin.Int-"></a>
<h3 class="api-name" id="get(kotlin.Int)">get</h3>
<pre class="api-signature no-pretty-print">operator&nbsp;open&nbsp;fun&nbsp;<a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#get(kotlin.Int)">get</a>(index:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>):&nbsp;T?</pre>
<p>Returns the item at <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#index()">index</a></code>, where <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#index()">index</a></code> includes the position of placeholders. If <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#index()">index</a></code> points to the position of a placeholder, <code>null</code> is returned.</p>
<p>To get the size using an index excluding placeholders, use <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/size.html">List.size</a></code> on <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#items()">items</a></code> directly.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Throws</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>kotlin.IndexOutOfBoundsException</code></td>
<td width="100%">
<p>if <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#index()">index</a></code> &lt; 0 or <code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#index()">index</a></code><code><a href="/reference/kotlin/androidx/paging/ItemSnapshotList.html#size()">size</a></code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</body>
</html>