jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-03-10 08:21:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
769d5b75b3efd3f30413fe1daca0979709781de2
github-api/apidocs/org/kohsuke/github/GHCommitQueryBuilder.html
Liam Newman 769d5b75b3 Manual update
2019-11-04 13:25:28 -08:00

385 lines
19 KiB
HTML
Raw Blame History

<!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 (1.8.0_211) on Mon Nov 04 13:11:25 PST 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GHCommitQueryBuilder (GitHub API for Java 1.100-SNAPSHOT API)</title>
<meta name="date" content="2019-11-04">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GHCommitQueryBuilder (GitHub API for Java 1.100-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/GHCommitQueryBuilder.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/GHCommitPointer.html" title="class in org.kohsuke.github"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/kohsuke/github/GHCommitSearchBuilder.html" title="class in org.kohsuke.github"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/github/GHCommitQueryBuilder.html" target="_top">Frames</a></li>
<li><a href="GHCommitQueryBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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>Constr&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>Constr&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.kohsuke.github</div>
<h2 title="Class GHCommitQueryBuilder" class="title">Class GHCommitQueryBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/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.kohsuke.github.GHCommitQueryBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">GHCommitQueryBuilder</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Builds up query for listing commits.
<p>
Call various methods that set the filter criteria, then <a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html#list--"><code>list()</code></a> method to actually list up the commit.
<pre>
GHRepository r = ...;
for (GHCommit c : r.queryCommits().since(x).until(y).author("kohsuke")) {
...
}
</pre></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Kohsuke Kawaguchi</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/kohsuke/github/GHRepository.html#queryCommits--"><code>GHRepository.queryCommits()</code></a></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html#author-java.lang.String-">author</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;author)</code>
<div class="block">GItHub login or email address by which to filter by commit author.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html#from-java.lang.String-">from</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ref)</code>
<div class="block">Specifies the SHA1 commit / tag / branch / etc to start listing commits from.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="../../../org/kohsuke/github/GHCommit.html" title="class in org.kohsuke.github">GHCommit</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html#list--">list</a></span>()</code>
<div class="block">Lists up the commits with the criteria built so far.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html#pageSize-int-">pageSize</a></span>(int&nbsp;pageSize)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html#path-java.lang.String-">path</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)</code>
<div class="block">Only commits containing this file path will be returned.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html#since-java.util.Date-">since</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;dt)</code>
<div class="block">Only commits after this date will be returned</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html#since-long-">since</a></span>(long&nbsp;timestamp)</code>
<div class="block">Only commits after this date will be returned</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html#until-java.util.Date-">until</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;dt)</code>
<div class="block">Only commits before this date will be returned</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html#until-long-">until</a></span>(long&nbsp;timestamp)</code>
<div class="block">Only commits before this date will be returned</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/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="author-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>author</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a>&nbsp;author(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;author)</pre>
<div class="block">GItHub login or email address by which to filter by commit author.</div>
</li>
</ul>
<a name="path-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>path</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a>&nbsp;path(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)</pre>
<div class="block">Only commits containing this file path will be returned.</div>
</li>
</ul>
<a name="from-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>from</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a>&nbsp;from(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;ref)</pre>
<div class="block">Specifies the SHA1 commit / tag / branch / etc to start listing commits from.</div>
</li>
</ul>
<a name="pageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pageSize</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a>&nbsp;pageSize(int&nbsp;pageSize)</pre>
</li>
</ul>
<a name="since-java.util.Date-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>since</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a>&nbsp;since(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;dt)</pre>
<div class="block">Only commits after this date will be returned</div>
</li>
</ul>
<a name="since-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>since</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a>&nbsp;since(long&nbsp;timestamp)</pre>
<div class="block">Only commits after this date will be returned</div>
</li>
</ul>
<a name="until-java.util.Date-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>until</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a>&nbsp;until(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;dt)</pre>
<div class="block">Only commits before this date will be returned</div>
</li>
</ul>
<a name="until-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>until</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GHCommitQueryBuilder.html" title="class in org.kohsuke.github">GHCommitQueryBuilder</a>&nbsp;until(long&nbsp;timestamp)</pre>
<div class="block">Only commits before this date will be returned</div>
</li>
</ul>
<a name="list--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>list</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/PagedIterable.html" title="class in org.kohsuke.github">PagedIterable</a>&lt;<a href="../../../org/kohsuke/github/GHCommit.html" title="class in org.kohsuke.github">GHCommit</a>&gt;&nbsp;list()</pre>
<div class="block">Lists up the commits with the criteria built so far.</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/GHCommitQueryBuilder.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/GHCommitPointer.html" title="class in org.kohsuke.github"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/kohsuke/github/GHCommitSearchBuilder.html" title="class in org.kohsuke.github"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/github/GHCommitQueryBuilder.html" target="_top">Frames</a></li>
<li><a href="GHCommitQueryBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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>Constr&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>Constr&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; 2019. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink