Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHSearchBuilder<T>

java.lang.Object

org.kohsuke.github.GHQueryBuilder<T>

org.kohsuke.github.GHSearchBuilder<T>

Type Parameters:

T - the type parameter

Direct Known Subclasses:

GHCommitSearchBuilder, GHContentSearchBuilder, GHIssueSearchBuilder, GHPullRequestSearchBuilder, GHRepositorySearchBuilder, GHUserSearchBuilder

public abstract class GHSearchBuilder<T>
extends GHQueryBuilder<T>

Base class for various search builders.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<String>	terms	The terms.

Fields inherited from class org.kohsuke.github.GHQueryBuilder

req

Method Summary

Modifier and Type	Method	Description
protected abstract String	getApiUrl()	Gets api url.
PagedSearchIterable<T>	list()	Performs the search.
GHQueryBuilder<T>	q(String term)	Search terms.

Methods inherited from class java.lang.Object

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

Field Details

terms

protected final List<String> terms

The terms.

Method Details

q

public GHQueryBuilder<T> q(String term)

Search terms.

Parameters:

term - the term

Returns:

the gh query builder

list

public PagedSearchIterable<T> list()

Performs the search.

Specified by:

list in class GHQueryBuilder<T>

Returns:

the paged search iterable

getApiUrl

protected abstract String getApiUrl()

Gets api url.

Returns:

the api url