Package org.kohsuke.github

Class GHRepositorySearchBuilder

java.lang.Object

org.kohsuke.github.GHQueryBuilder<T>

org.kohsuke.github.GHSearchBuilder<GHRepository>

org.kohsuke.github.GHRepositorySearchBuilder

public class GHRepositorySearchBuilder
extends GHSearchBuilder<GHRepository>

Search repositories.

Author:

Kohsuke Kawaguchi

See Also:

GitHub#searchRepositories()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHRepositorySearchBuilder.Fork	Deprecated. Kept for backward compatibility.
static class	GHRepositorySearchBuilder.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
GHRepositorySearchBuilder	created(String v)	Created gh repository search builder.
GHRepositorySearchBuilder	fork(GHFork fork)	Searching in forks The default search mode is GHRepositorySearchBuilder.Fork.PARENT_ONLY.
GHRepositorySearchBuilder	fork(GHRepositorySearchBuilder.Fork fork)	Deprecated. use fork(GHFork) instead.
GHRepositorySearchBuilder	forks(String v)	Deprecated. use fork(GHFork) instead.
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.
GHRepositorySearchBuilder	in(String v)	In gh repository search builder.
GHRepositorySearchBuilder	language(String v)	Language gh repository search builder.
GHRepositorySearchBuilder	order(GHDirection v)	Order gh repository search builder.
GHRepositorySearchBuilder	org(String v)	Org gh repository search builder.
GHRepositorySearchBuilder	pushed(String v)	Pushed gh repository search builder.
GHRepositorySearchBuilder	q(String term)	Search terms.
GHRepositorySearchBuilder	repo(String v)	Repo gh repository search builder.
GHRepositorySearchBuilder	size(String v)	Size gh repository search builder.
GHRepositorySearchBuilder	sort(GHRepositorySearchBuilder.Sort sort)	Sort gh repository search builder.
GHRepositorySearchBuilder	stars(String v)	Stars gh repository search builder.
GHRepositorySearchBuilder	topic(String v)	Topic gh repository search builder.
GHRepositorySearchBuilder	user(String v)	User gh repository search builder.
GHRepositorySearchBuilder	visibility(GHRepository.Visibility visibility)	Search by repository visibility.

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 GHRepositorySearchBuilder q(String term)

Search terms.

Overrides:

q in class GHSearchBuilder<GHRepository>

Parameters:

term - the term

Returns:

the gh query builder

in

public GHRepositorySearchBuilder in(String v)

In gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

size

public GHRepositorySearchBuilder size(String v)

Size gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

forks

@Deprecated
public GHRepositorySearchBuilder forks(String v)

Deprecated.

use fork(GHFork) instead.

Forks gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

fork

@Deprecated
public GHRepositorySearchBuilder fork(GHRepositorySearchBuilder.Fork fork)

Deprecated.

use fork(GHFork) instead.

Searching in forks The default search mode is GHRepositorySearchBuilder.Fork.PARENT_ONLY. In that mode, forks are not included in search results.

Passing GHRepositorySearchBuilder.Fork.PARENT_AND_FORKS or GHRepositorySearchBuilder.Fork.FORKS_ONLY will show results from forks, but only if they have more stars than the parent repository.

IMPORTANT: Regardless of this setting, no search results will ever be returned for forks with equal or fewer stars than the parent repository. Forks with less stars than the parent repository are not included in the index for code searching.

Parameters:

fork - search mode for forks

Returns:

the gh repository search builder

See Also:

Searching in forks

fork

public GHRepositorySearchBuilder fork(GHFork fork)

Searching in forks The default search mode is GHRepositorySearchBuilder.Fork.PARENT_ONLY. In that mode, forks are not included in search results.

Passing GHRepositorySearchBuilder.Fork.PARENT_AND_FORKS or GHRepositorySearchBuilder.Fork.FORKS_ONLY will show results from forks, but only if they have more stars than the parent repository.

IMPORTANT: Regardless of this setting, no search results will ever be returned for forks with equal or fewer stars than the parent repository. Forks with less stars than the parent repository are not included in the index for code searching.

Parameters:

fork - search mode for forks

Returns:

the gh repository search builder

See Also:

Searching in forks

visibility

public GHRepositorySearchBuilder visibility(GHRepository.Visibility visibility)

Search by repository visibility.

Parameters:

visibility - repository visibility

Returns:

the gh repository search builder

Throws:

GHException - if GHRepository.Visibility.UNKNOWN is passed. UNKNOWN is a placeholder for unexpected values encountered when reading data.

See Also:

Search by repository visibility

created

public GHRepositorySearchBuilder created(String v)

Created gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

pushed

public GHRepositorySearchBuilder pushed(String v)

Pushed gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

user

public GHRepositorySearchBuilder user(String v)

User gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

repo

public GHRepositorySearchBuilder repo(String v)

Repo gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

language

public GHRepositorySearchBuilder language(String v)

Language gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

stars

public GHRepositorySearchBuilder stars(String v)

Stars gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

topic

public GHRepositorySearchBuilder topic(String v)

Topic gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

org

public GHRepositorySearchBuilder org(String v)

Org gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

order

public GHRepositorySearchBuilder order(GHDirection v)

Order gh repository search builder.

Parameters:

v - the v

Returns:

the gh repository search builder

sort

public GHRepositorySearchBuilder sort(GHRepositorySearchBuilder.Sort sort)

Sort gh repository search builder.

Parameters:

sort - the sort

Returns:

the gh repository search builder

getApiUrl

protected String getApiUrl()

Gets the api url.

Specified by:

getApiUrl in class GHSearchBuilder<GHRepository>

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