com.atlassian.bamboo.plugins.rest.common

Class Paginator

java.lang.Object

com.atlassian.bamboo.plugins.rest.common.Paginator

public class Paginator
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_RESULTS

Constructor Summary

Constructors

Constructor and Description
Paginator()

Method Summary

Modifier and Type	Method and Description
static <T> Collection<T>	getLast(Collection<T> input, javax.ws.rs.core.UriInfo uriInfo)
static int	getMaxResults(javax.ws.rs.core.UriInfo uriInfo)
static int	getMaxResults(javax.ws.rs.core.UriInfo uriInfo, int defaultValue)
static <W,T> @NotNull PageResponse<T>	getPage(@NotNull Collection<W> input, @NotNull PageRequest pageRequest, @NotNull com.google.common.base.Function<? super W,T> transformer) Deprecated. since 5.10 use PaginationService instead
static <T> org.apache.commons.lang3.Range<Integer>	getPaginationRange(Collection<T> input, javax.ws.rs.core.UriInfo uriInfo)
static org.apache.commons.lang3.Range<Integer>	getPaginationRange(int resultSize, javax.ws.rs.core.UriInfo uriInfo)
static org.apache.commons.lang3.Range<Integer>	getPaginationRange(javax.ws.rs.core.UriInfo uriInfo)
static <T> PagerPaginationSupport	getPaginationSupport(com.atlassian.user.search.page.Pager<T> pager, javax.ws.rs.core.UriInfo uriInfo)
static int	getStartIndex(javax.ws.rs.core.UriInfo uriInfo, int maxResults)
static <T> List<T>	paginate(Collection<T> input, org.apache.commons.lang3.Range<Integer> range)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_RESULTS

public static final int DEFAULT_MAX_RESULTS

See Also:

Constant Field Values

Constructor Detail

Paginator

public Paginator()

Method Detail

getLast

public static <T> Collection<T> getLast(Collection<T> input,
                                        javax.ws.rs.core.UriInfo uriInfo)

getStartIndex

public static int getStartIndex(javax.ws.rs.core.UriInfo uriInfo,
                                int maxResults)

getMaxResults

public static int getMaxResults(javax.ws.rs.core.UriInfo uriInfo)

getMaxResults

public static int getMaxResults(javax.ws.rs.core.UriInfo uriInfo,
                                int defaultValue)

getPaginationRange

public static org.apache.commons.lang3.Range<Integer> getPaginationRange(javax.ws.rs.core.UriInfo uriInfo)

getPaginationRange

public static org.apache.commons.lang3.Range<Integer> getPaginationRange(int resultSize,
                                                                         javax.ws.rs.core.UriInfo uriInfo)

getPaginationRange

public static <T> org.apache.commons.lang3.Range<Integer> getPaginationRange(Collection<T> input,
                                                                             javax.ws.rs.core.UriInfo uriInfo)

getPaginationSupport

public static <T> PagerPaginationSupport getPaginationSupport(com.atlassian.user.search.page.Pager<T> pager,
                                                              javax.ws.rs.core.UriInfo uriInfo)

paginate

public static <T> List<T> paginate(Collection<T> input,
                                   org.apache.commons.lang3.Range<Integer> range)

getPage

@NotNull
 @Deprecated
public static <W,T> @NotNull PageResponse<T> getPage(@NotNull
                                                                           @NotNull Collection<W> input,
                                                                           @NotNull
                                                                           @NotNull PageRequest pageRequest,
                                                                           @NotNull
                                                                           @NotNull com.google.common.base.Function<? super W,T> transformer)

Deprecated. since 5.10 use PaginationService instead

Calculate a page of rest objects from a list of domain objects. Assumes input is the full list of possible objects. Will only transform the required number of domain objects into their rest objects

Type Parameters:

W - domain object

T - rest object

Parameters:

input - full list of domain objects

pageRequest - which page of information required

transformer - to convert domain object into rest object

Returns:

Single page of rest objects