blob: ebcd75dedbbff4df6d70d869f525647cef86334a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_07) on Wed Sep 18 17:57:13 EDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>AbstractIterable (Apache Chemistry OpenCMIS 0.10.0 API)</title>
<meta name="date" content="2013-09-18">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractIterable (Apache Chemistry OpenCMIS 0.10.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractIterable.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterator.html" title="class in org.apache.chemistry.opencmis.client.runtime.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" target="_top">Frames</a></li>
<li><a href="AbstractIterable.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.chemistry.opencmis.client.runtime.util</div>
<h2 title="Class AbstractIterable" class="title">Class AbstractIterable&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.chemistry.opencmis.client.runtime.util.AbstractIterable&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type returned by the iterable's iterator</dd></dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;T&gt;, <a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/CollectionIterable.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">CollectionIterable</a>, <a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/CollectionPageIterable.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">CollectionPageIterable</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractIterable&lt;T&gt;</span>
extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;T&gt;</pre>
<div class="block">Abstract <code>ItemIterable</code> implementation.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#AbstractIterable(org.apache.chemistry.opencmis.client.runtime.util.AbstractPageFetcher)">AbstractIterable</a></strong>(<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractPageFetcher.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">AbstractPageFetcher</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;&nbsp;pageFetcher)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#AbstractIterable(long, org.apache.chemistry.opencmis.client.runtime.util.AbstractPageFetcher)">AbstractIterable</a></strong>(long&nbsp;position,
<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractPageFetcher.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">AbstractPageFetcher</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;&nbsp;pageFetcher)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract <a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterator.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">AbstractIterator</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#createIterator()">createIterator</a></strong>()</code>
<div class="block">Construct the iterator</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#getHasMoreItems()">getHasMoreItems</a></strong>()</code>
<div class="block">Returns whether the repository contains additional items beyond the page of
items already fetched.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#getPage()">getPage</a></strong>()</code>
<div class="block">Gets an iterable for the current sub collection within the CMIS collection using
default maximum number of items</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#getPage(int)">getPage</a></strong>(int&nbsp;maxNumItems)</code>
<div class="block">Gets an iterable for the current sub collection within the CMIS collection</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractPageFetcher.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">AbstractPageFetcher</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#getPageFetcher()">getPageFetcher</a></strong>()</code>
<div class="block">Gets the page fetcher</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#getPageNumItems()">getPageNumItems</a></strong>()</code>
<div class="block">Returns the number of items fetched for the current page.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#getSkipCount()">getSkipCount</a></strong>()</code>
<div class="block">Gets the skip count</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#getTotalNumItems()">getTotalNumItems</a></strong>()</code>
<div class="block">Returns the total number of items.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterator.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">AbstractIterator</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#iterator()">iterator</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html#skipTo(long)">skipTo</a></strong>(long&nbsp;position)</code>
<div class="block">Skip to position within CMIS collection</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractIterable(org.apache.chemistry.opencmis.client.runtime.util.AbstractPageFetcher)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AbstractIterable</h4>
<pre>protected&nbsp;AbstractIterable(<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractPageFetcher.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">AbstractPageFetcher</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;&nbsp;pageFetcher)</pre>
</li>
</ul>
<a name="AbstractIterable(long, org.apache.chemistry.opencmis.client.runtime.util.AbstractPageFetcher)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractIterable</h4>
<pre>protected&nbsp;AbstractIterable(long&nbsp;position,
<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractPageFetcher.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">AbstractPageFetcher</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;&nbsp;pageFetcher)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSkipCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSkipCount</h4>
<pre>protected&nbsp;long&nbsp;getSkipCount()</pre>
<div class="block">Gets the skip count</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>skip count</dd></dl>
</li>
</ul>
<a name="getPageFetcher()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageFetcher</h4>
<pre>protected&nbsp;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractPageFetcher.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">AbstractPageFetcher</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;&nbsp;getPageFetcher()</pre>
<div class="block">Gets the page fetcher</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>page fetcher</dd></dl>
</li>
</ul>
<a name="createIterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createIterator</h4>
<pre>protected abstract&nbsp;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterator.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">AbstractIterator</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;&nbsp;createIterator()</pre>
<div class="block">Construct the iterator</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>iterator</dd></dl>
</li>
</ul>
<a name="iterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterator.html" title="class in org.apache.chemistry.opencmis.client.runtime.util">AbstractIterator</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;&nbsp;iterator()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#iterator()">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="skipTo(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipTo</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;&nbsp;skipTo(long&nbsp;position)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#skipTo(long)">ItemIterable</a></code></strong></div>
<div class="block">Skip to position within CMIS collection</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#skipTo(long)">skipTo</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>iterable whose starting point is the specified skip to position.
This iterable <em>may</em> be the same as <code>this</code></dd></dl>
</li>
</ul>
<a name="getPage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPage</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;&nbsp;getPage()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getPage()">ItemIterable</a></code></strong></div>
<div class="block">Gets an iterable for the current sub collection within the CMIS collection using
default maximum number of items</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getPage()">getPage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>iterable for current page</dd></dl>
</li>
</ul>
<a name="getPage(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPage</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;&nbsp;getPage(int&nbsp;maxNumItems)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getPage(int)">ItemIterable</a></code></strong></div>
<div class="block">Gets an iterable for the current sub collection within the CMIS collection</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getPage(int)">getPage</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>maxNumItems</code> - maximum number of items the sub collection will contain</dd>
<dt><span class="strong">Returns:</span></dt><dd>iterable for current page</dd></dl>
</li>
</ul>
<a name="getPageNumItems()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageNumItems</h4>
<pre>public&nbsp;long&nbsp;getPageNumItems()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getPageNumItems()">ItemIterable</a></code></strong></div>
<div class="block">Returns the number of items fetched for the current page.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getPageNumItems()">getPageNumItems</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>number of items for currently fetched collection</dd></dl>
</li>
</ul>
<a name="getHasMoreItems()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHasMoreItems</h4>
<pre>public&nbsp;boolean&nbsp;getHasMoreItems()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getHasMoreItems()">ItemIterable</a></code></strong></div>
<div class="block">Returns whether the repository contains additional items beyond the page of
items already fetched.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getHasMoreItems()">getHasMoreItems</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true => further page requests will be made to the repository</dd></dl>
</li>
</ul>
<a name="getTotalNumItems()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTotalNumItems</h4>
<pre>public&nbsp;long&nbsp;getTotalNumItems()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getTotalNumItems()">ItemIterable</a></code></strong></div>
<div class="block">Returns the total number of items. If the repository knows the total
number of items in a result set, the repository SHOULD include the number
here. If the repository does not know the number of items in a result
set, this parameter SHOULD not be set. The value in the parameter MAY NOT
be accurate the next time the client retrieves the result set or the next
page in the result set.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html#getTotalNumItems()">getTotalNumItems</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/chemistry/opencmis/client/api/ItemIterable.html" title="interface in org.apache.chemistry.opencmis.client.api">ItemIterable</a>&lt;<a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" title="type parameter in AbstractIterable">T</a>&gt;</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>total number of items or (-1)</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractIterable.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../../org/apache/chemistry/opencmis/client/runtime/util/AbstractIterator.html" title="class in org.apache.chemistry.opencmis.client.runtime.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/chemistry/opencmis/client/runtime/util/AbstractIterable.html" target="_top">Frames</a></li>
<li><a href="AbstractIterable.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2009-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>