Package org.sourcelab.buildkite.api.client.request

Class PageOptions

java.lang.Object

org.sourcelab.buildkite.api.client.request.PageOptions

public class PageOptions
extends Object

Paging options.

Constructor Summary

Constructors

Constructor	Description
PageOptions(long page, int perPage)	Constructor.

Method Summary

Modifier and Type	Method	Description
static PageOptions	fromUrl(String url)	Parses the given url and creates a PageOptions instance from the parameters.
static PageOptions	getDefault()	Default instance with sane default properties.
long	getPage()
int	getPerPage()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PageOptions

public PageOptions(long page,
 int perPage)

Constructor.

Parameters:

page - Which page to request.

perPage - How many entries per page.

Method Details

getDefault

public static PageOptions getDefault()

Default instance with sane default properties.

Returns:

Default instance with sane default properties.

fromUrl

public static PageOptions fromUrl(String url)

Parses the given url and creates a PageOptions instance from the parameters.

Parameters:

url - The url to parse for per_page and page parameters.

Returns:

PageOptions instance populated from the supplied url.

Throws:

IllegalArgumentException - if passed an invalid url.

getPage

public long getPage()

getPerPage

public int getPerPage()

toString

public String toString()

Overrides:

toString in class Object