Class PaginatedOptions

java.lang.Object

ink.icoding.github4j.option.PaginatedOptions

Direct Known Subclasses:

ListArtifactsOptions, ListBranchesOptions, ListCollaboratorsOptions, ListForksOptions, ListGistsOptions, ListIssueCommentsOptions, ListIssuesOptions, ListLicensesOptions, ListMilestonesOptions, ListNotificationsOptions, ListOrgInvitationsOptions, ListOrgMembersOptions, ListOrgReposOptions, ListOutsideCollaboratorsOptions, ListProjectCardsOptions, ListProjectsOptions, ListPullsOptions, ListReposOptions, ListReviewCommentsOptions, ListTeamMembersOptions, ListUserIssuesOptions, ListUserReposOptions, ListWorkflowJobsOptions, ListWorkflowRunsOptions, PageOptions, SearchOptions

public abstract class PaginatedOptions
extends Object

分页查询参数基类。所有列表类 API 的 Options 都继承此类。

提供通用的 per_page 和 page 分页参数， 子类通过重写 toQueryParams() 添加额外的查询参数。

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	page	页码，从 1 开始
protected Integer	perPage	每页返回的结果数量，默认 30，最大 100

Constructor Summary

Constructors

Constructor	Description
PaginatedOptions()

Method Summary

Modifier and Type	Method	Description
protected void	putIfNotNull(Map<String,String> params, String key, Object value)
Map<String,String>	toQueryParams()	将所有非空参数转换为查询参数 Map。

Methods inherited from class Object

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

Field Details

perPage

protected Integer perPage

每页返回的结果数量，默认 30，最大 100

page

protected Integer page

页码，从 1 开始

Constructor Details

PaginatedOptions

public PaginatedOptions()

Method Details

toQueryParams

public Map<String,String> toQueryParams()

将所有非空参数转换为查询参数 Map。

Returns:

查询参数映射，可直接传给 HTTP 请求

putIfNotNull

protected void putIfNotNull(Map<String,String> params,
 String key,
 Object value)