Package org.kohsuke.github

Class GHCommitSearchBuilder

java.lang.Object

org.kohsuke.github.GHQueryBuilder<T>

org.kohsuke.github.GHSearchBuilder<GHCommit>

org.kohsuke.github.GHCommitSearchBuilder

@Preview(CLOAK)
public class GHCommitSearchBuilder
extends GHSearchBuilder<GHCommit>

Search commits.

Author:

Marc de Verdelhan

See Also:

GitHub#searchCommits()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHCommitSearchBuilder.Sort	The enum Sort.

Field Summary

Fields inherited from class org.kohsuke.github.GHSearchBuilder

terms

Fields inherited from class org.kohsuke.github.GHQueryBuilder

req

Method Summary

Modifier and Type	Method	Description
GHCommitSearchBuilder	author(String v)	Author gh commit search builder.
GHCommitSearchBuilder	authorDate(String v)	Author date gh commit search builder.
GHCommitSearchBuilder	authorEmail(String v)	Author email gh commit search builder.
GHCommitSearchBuilder	authorName(String v)	Author name gh commit search builder.
GHCommitSearchBuilder	committer(String v)	Committer gh commit search builder.
GHCommitSearchBuilder	committerDate(String v)	Committer date gh commit search builder.
GHCommitSearchBuilder	committerEmail(String v)	Committer email gh commit search builder.
GHCommitSearchBuilder	committerName(String v)	Committer name gh commit search builder.
protected String	getApiUrl()	Gets the api url.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHCommitSearchBuilder	hash(String v)	Hash gh commit search builder.
GHCommitSearchBuilder	is(String v)	Is gh commit search builder.
GHCommitSearchBuilder	merge(boolean merge)	Merge gh commit search builder.
GHCommitSearchBuilder	order(GHDirection v)	Order gh commit search builder.
GHCommitSearchBuilder	org(String v)	Org gh commit search builder.
GHCommitSearchBuilder	parent(String v)	Parent gh commit search builder.
GHCommitSearchBuilder	q(String term)	Search terms.
GHCommitSearchBuilder	repo(String v)	Repo gh commit search builder.
GHCommitSearchBuilder	sort(GHCommitSearchBuilder.Sort sort)	Sort gh commit search builder.
GHCommitSearchBuilder	tree(String v)	Tree gh commit search builder.
GHCommitSearchBuilder	user(String v)	User gh commit search builder.

Methods inherited from class org.kohsuke.github.GHSearchBuilder

list

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

q

public GHCommitSearchBuilder q(String term)

Search terms.

Overrides:

q in class GHSearchBuilder<GHCommit>

Parameters:

term - the term

Returns:

the GH commit search builder

author

public GHCommitSearchBuilder author(String v)

Author gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

committer

public GHCommitSearchBuilder committer(String v)

Committer gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

authorName

public GHCommitSearchBuilder authorName(String v)

Author name gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

committerName

public GHCommitSearchBuilder committerName(String v)

Committer name gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

authorEmail

public GHCommitSearchBuilder authorEmail(String v)

Author email gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

committerEmail

public GHCommitSearchBuilder committerEmail(String v)

Committer email gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

authorDate

public GHCommitSearchBuilder authorDate(String v)

Author date gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

committerDate

public GHCommitSearchBuilder committerDate(String v)

Committer date gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

merge

public GHCommitSearchBuilder merge(boolean merge)

Merge gh commit search builder.

Parameters:

merge - the merge

Returns:

the gh commit search builder

hash

public GHCommitSearchBuilder hash(String v)

Hash gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

parent

public GHCommitSearchBuilder parent(String v)

Parent gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

tree

public GHCommitSearchBuilder tree(String v)

Tree gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

is

public GHCommitSearchBuilder is(String v)

Is gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

user

public GHCommitSearchBuilder user(String v)

User gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

org

public GHCommitSearchBuilder org(String v)

Org gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

repo

public GHCommitSearchBuilder repo(String v)

Repo gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

order

public GHCommitSearchBuilder order(GHDirection v)

Order gh commit search builder.

Parameters:

v - the v

Returns:

the gh commit search builder

sort

public GHCommitSearchBuilder sort(GHCommitSearchBuilder.Sort sort)

Sort gh commit search builder.

Parameters:

sort - the sort

Returns:

the gh commit search builder

getApiUrl

protected String getApiUrl()

Gets the api url.

Specified by:

getApiUrl in class GHSearchBuilder<GHCommit>

Returns:

the api url

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance