mirror of
https://github.com/jlengrand/github-api.git
synced 2026-05-08 15:52:17 +00:00
300 lines
14 KiB
HTML
300 lines
14 KiB
HTML
<!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_21) on Mon Feb 29 21:06:35 PST 2016 -->
|
|
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
|
|
<title>PagedSearchIterable (GitHub API for Java 1.73 API)</title>
|
|
<meta name="date" content="2016-02-29">
|
|
<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="PagedSearchIterable (GitHub API for Java 1.73 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/PagedSearchIterable.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><a href="../../../org/kohsuke/github/PagedIterator.html" title="class in org.kohsuke.github"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../org/kohsuke/github/RateLimitHandler.html" title="class in org.kohsuke.github"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?org/kohsuke/github/PagedSearchIterable.html" target="_top">Frames</a></li>
|
|
<li><a href="PagedSearchIterable.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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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.kohsuke.github</div>
|
|
<h2 title="Class PagedSearchIterable" class="title">Class PagedSearchIterable<T></h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://java.sun.com/j2se/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><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">org.kohsuke.github.PagedIterable</a><T></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.kohsuke.github.PagedSearchIterable<T></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><T></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public abstract class <span class="strong">PagedSearchIterable<T></span>
|
|
extends <a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><T></pre>
|
|
<div class="block"><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github"><code>PagedIterable</code></a> enhanced to report search result specific information.</div>
|
|
<dl><dt><span class="strong">Author:</span></dt>
|
|
<dd>Kohsuke Kawaguchi</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== 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"> </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 <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../org/kohsuke/github/PagedSearchIterable.html" title="type parameter in PagedSearchIterable">T</a>[]></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/kohsuke/github/PagedSearchIterable.html#adapt(java.util.Iterator)">adapt</a></strong>(<a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><? extends org.kohsuke.github.SearchResult<<a href="../../../org/kohsuke/github/PagedSearchIterable.html" title="type parameter in PagedSearchIterable">T</a>>> base)</code>
|
|
<div class="block">Adapts <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/kohsuke/github/PagedSearchIterable.html#getTotalCount()">getTotalCount</a></strong>()</code>
|
|
<div class="block">Returns the total number of hit, including the results that's not yet fetched.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/kohsuke/github/PagedSearchIterable.html#isIncomplete()">isIncomplete</a></strong>()</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedSearchIterable.html" title="class in org.kohsuke.github">PagedSearchIterable</a><<a href="../../../org/kohsuke/github/PagedSearchIterable.html" title="type parameter in PagedSearchIterable">T</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/kohsuke/github/PagedSearchIterable.html#withPageSize(int)">withPageSize</a></strong>(int size)</code>
|
|
<div class="block">Sets the pagination size.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_org.kohsuke.github.PagedIterable">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class org.kohsuke.github.<a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a></h3>
|
|
<code><a href="../../../org/kohsuke/github/PagedIterable.html#_iterator(int)">_iterator</a>, <a href="../../../org/kohsuke/github/PagedIterable.html#asList()">asList</a>, <a href="../../../org/kohsuke/github/PagedIterable.html#asSet()">asSet</a>, <a href="../../../org/kohsuke/github/PagedIterable.html#iterator()">iterator</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="withPageSize(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>withPageSize</h4>
|
|
<pre>public <a href="../../../org/kohsuke/github/PagedSearchIterable.html" title="class in org.kohsuke.github">PagedSearchIterable</a><<a href="../../../org/kohsuke/github/PagedSearchIterable.html" title="type parameter in PagedSearchIterable">T</a>> withPageSize(int size)</pre>
|
|
<div class="block"><strong>Description copied from class: <code><a href="../../../org/kohsuke/github/PagedIterable.html#withPageSize(int)">PagedIterable</a></code></strong></div>
|
|
<div class="block">Sets the pagination size.
|
|
|
|
<p>
|
|
When set to non-zero, each API call will retrieve this many entries.</div>
|
|
<dl>
|
|
<dt><strong>Overrides:</strong></dt>
|
|
<dd><code><a href="../../../org/kohsuke/github/PagedIterable.html#withPageSize(int)">withPageSize</a></code> in class <code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a><<a href="../../../org/kohsuke/github/PagedSearchIterable.html" title="type parameter in PagedSearchIterable">T</a>></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTotalCount()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTotalCount</h4>
|
|
<pre>public int getTotalCount()</pre>
|
|
<div class="block">Returns the total number of hit, including the results that's not yet fetched.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="isIncomplete()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isIncomplete</h4>
|
|
<pre>public boolean isIncomplete()</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="adapt(java.util.Iterator)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>adapt</h4>
|
|
<pre>protected <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../org/kohsuke/github/PagedSearchIterable.html" title="type parameter in PagedSearchIterable">T</a>[]> adapt(<a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><? extends org.kohsuke.github.SearchResult<<a href="../../../org/kohsuke/github/PagedSearchIterable.html" title="type parameter in PagedSearchIterable">T</a>>> base)</pre>
|
|
<div class="block">Adapts <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a>.</div>
|
|
</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/PagedSearchIterable.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><a href="../../../org/kohsuke/github/PagedIterator.html" title="class in org.kohsuke.github"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../org/kohsuke/github/RateLimitHandler.html" title="class in org.kohsuke.github"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?org/kohsuke/github/PagedSearchIterable.html" target="_top">Frames</a></li>
|
|
<li><a href="PagedSearchIterable.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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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 © 2016. All Rights Reserved.</small></p>
|
|
</body>
|
|
</html>
|