Package jetbrains.buildServer.vcshostings.github

Class GitHubBranchesSearch

java.lang.Object

jetbrains.buildServer.vcshostings.github.GitHubBranchesSearch

All Implemented Interfaces:

VcsSearch<VcsBranches>

public class GitHubBranchesSearch
extends Object
implements VcsSearch<VcsBranches>

Constructor Summary

Constructors

Constructor	Description
GitHubBranchesSearch(jetbrains.buildServer.vcshostings.github.GitHubFacade informationProvider, String repositoryName)

Method Summary

Modifier and Type	Method	Description
VcsBranches	get()	Obtains a list of entities from a VCS hosting service
VcsSearch<VcsBranches>	page(String pageId)	Sets the required page
VcsSearch<VcsBranches>	pageSize(int pageSize)	Sets custom page size for the results
VcsSearch<VcsBranches>	search(String searchString)	Sets a search string (if supported).

Methods inherited from class java.lang.Object

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

Constructor Detail

GitHubBranchesSearch

public GitHubBranchesSearch(jetbrains.buildServer.vcshostings.github.GitHubFacade informationProvider,
                            String repositoryName)

Method Detail

search

public VcsSearch<VcsBranches> search(@NotNull
                                     String searchString)

Description copied from interface: VcsSearch

Sets a search string (if supported). The search string is matched across entity names

Specified by:

search in interface VcsSearch<VcsBranches>

Parameters:

searchString - search string, case-insensitive

Returns:

the same object

pageSize

public VcsSearch<VcsBranches> pageSize(int pageSize)

Description copied from interface: VcsSearch

Sets custom page size for the results

Specified by:

pageSize in interface VcsSearch<VcsBranches>

Parameters:

pageSize - custom page size

Returns:

the same object

page

public VcsSearch<VcsBranches> page(@NotNull
                                   String pageId)

Description copied from interface: VcsSearch

Sets the required page

Specified by:

page in interface VcsSearch<VcsBranches>

Parameters:

pageId - page id, e.g. page number

Returns:

the same object

get

public VcsBranches get()

Description copied from interface: VcsSearch

Obtains a list of entities from a VCS hosting service

Specified by:

get in interface VcsSearch<VcsBranches>

Returns:

list of repositories with some additional information