com.atlassian.stash.rest.client.api.entity

Class Page<T>

java.lang.Object

com.atlassian.stash.rest.client.api.entity.Page<T>

Type Parameters:

T - Value type

public class Page<T>
extends Object

Describes a page of values. Stash documentation: "Stash uses paging to conserve server resources and limit response size for resources that return potentially large collections of items. A request to a paged API will result in a values array wrapped in [..] object with some paging metadata"

See Also:

Stash documentation

Constructor Summary

Constructors

Constructor and Description
Page(int size, int limit, boolean lastPage, int start, Integer nextPageStart, Iterable<T> values)

Method Summary

Modifier and Type	Method and Description
int	getLimit()
Integer	getNextPageStart()
int	getSize()
int	getStart()
List<T>	getValues()
boolean	isLastPage()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Page

public Page(int size,
            int limit,
            boolean lastPage,
            int start,
            @Nullable
            Integer nextPageStart,
            @Nonnull
            Iterable<T> values)

Method Detail

getSize

public int getSize()

Returns:

number of values

getLimit

public int getLimit()

Returns:

requested number of values

isLastPage

public boolean isLastPage()

Returns:

true if current page is the last one ie. there are no more values

getValues

@Nonnull
public List<T> getValues()

Returns:

value list

getStart

public int getStart()

Returns:

requested position of first value

getNextPageStart

@Nullable
public Integer getNextPageStart()

Returns:

suggested position of first value for next page or null if there are no more values

toString

public String toString()

Overrides:

toString in class Object