com.atlassian.audit.api.util.pagination

Class PageRequest<C>

java.lang.Object

com.atlassian.audit.api.util.pagination.PageRequest<C>

public class PageRequest<C>
extends Object

Pagination for a request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PageRequest.Builder<C>

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Optional<C>	getCursor() Used for cursor based pagination.
int	getLimit()
int	getOffset()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getOffset

public int getOffset()

Returns:

the index of the element in the result set that this page will start at

getCursor

@Nonnull
public Optional<C> getCursor()

Used for cursor based pagination. Cursor based pagination can be used by services to return results with better performance vs offset based pagination as offset may need all results to be scanned in order to skip records. When using cursor based pagination, each page of results are ordered by a unique combination of field(s) which forms a cursor. Clients can request for a page that contains results starting from and excluding given cursor.

Returns:

cursor if specified in this page request, otherwise Optional.empty()

See Also:

Page.getNextPageRequest()

getLimit

public int getLimit()

Returns:

the maximum allowed size of the page

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object