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 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
    • 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