com.atlassian.bamboo.plugins.rest.pagination

Interface PaginationService

All Known Implementing Classes:

PaginationServiceImpl

public interface PaginationService

Method Summary

Modifier and Type	Method and Description
<T extends AbstractRestModel> RestPageModel<T>	getExpandablePage(PageRequest pageRequest, javax.ws.rs.core.UriInfo uriInfo, String pageLocation) Constructs a RestPageModel which is an empty page with a self link.
<W,T extends AbstractRestModel> RestPageModel<T>	getPage(Iterable<W> input, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo, RestConversionFunction<? super W,T> transformer) Transforms a list of domain objects to AbstractRestModels and constructs a RestPageModel from the result.
<W,T extends AbstractRestModel> RestPageModel<T>	getPage(Iterable<W> input, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo, RestConversionFunction<? super W,T> transformer, String pageLocation) Transforms a list of domain objects to AbstractRestModels and constructs a RestPageModel from the result.
<W,T extends AbstractRestModel> RestPageModel<T>	getPage(Stream<W> input, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo, RestConversionFunction<? super W,T> transformer) Transforms a list of domain objects to AbstractRestModels and constructs a RestPageModel from the result.
<W,T extends AbstractRestModel> RestPageModel<T>	getPage(Stream<W> input, PageRequest pageRequest, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo, RestConversionFunction<? super W,T> transformer, String pageLocation) Transforms a list of domain objects to AbstractRestModels and constructs a RestPageModel from the result.

Method Detail

getPage

@NotNull
<W,T extends AbstractRestModel> RestPageModel<T> getPage(@NotNull
                                                                  Iterable<W> input,
                                                                  @NotNull
                                                                  PageRequest pageRequest,
                                                                  @NotNull
                                                                  Expansion expansion,
                                                                  @NotNull
                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                  @NotNull
                                                                  RestConversionFunction<? super W,T> transformer)

Transforms a list of domain objects to AbstractRestModels and constructs a RestPageModel from the result. Assumes input is the full list of possible objects. Will only transform the required number of objects as defined by the PageRequest. The RestPageModel will include page links.

DO NOT USE FOR EXPANDED PAGES

This method assumes the uriInfo represents the page being requested and uses it to construct the page's self link. Use getPage(Iterable, PageRequest, Expansion, UriInfo, RestConversionFunction, String) to specify the page location if the current request does not represent the page being transformed (e.g. resource expansion may need to construct a page of sub-resources).

Type Parameters:

W - domain object

T - rest object

Parameters:

input - full list of domain objects

pageRequest - which page of information required

expansion - The expansion to use when transforming the objects

uriInfo - URI info from the request used to construct the page's self link

transformer - to convert domain object into rest object

Returns:

Single page of rest objects

getPage

@NotNull
<W,T extends AbstractRestModel> RestPageModel<T> getPage(@NotNull
                                                                  Stream<W> input,
                                                                  @NotNull
                                                                  PageRequest pageRequest,
                                                                  @NotNull
                                                                  Expansion expansion,
                                                                  @NotNull
                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                  @NotNull
                                                                  RestConversionFunction<? super W,T> transformer)

Transforms a list of domain objects to AbstractRestModels and constructs a RestPageModel from the result. Assumes input is the full list of possible objects. Will only transform the required number of objects as defined by the PageRequest. The RestPageModel will include page links.

DO NOT USE FOR EXPANDED PAGES

This method assumes the uriInfo represents the page being requested and uses it to construct the page's self link. Use getPage(Iterable, PageRequest, Expansion, UriInfo, RestConversionFunction, String) to specify the page location if the current request does not represent the page being transformed (e.g. resource expansion may need to construct a page of sub-resources).

Type Parameters:

W - domain object

T - rest object

Parameters:

input - full list of domain objects

pageRequest - which page of information required

expansion - The expansion to use when transforming the objects

uriInfo - URI info from the request used to construct the page's self link

transformer - to convert domain object into rest object

Returns:

Single page of rest objects

getPage

@NotNull
<W,T extends AbstractRestModel> RestPageModel<T> getPage(@NotNull
                                                                  Iterable<W> input,
                                                                  @NotNull
                                                                  PageRequest pageRequest,
                                                                  @NotNull
                                                                  Expansion expansion,
                                                                  @NotNull
                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                  @NotNull
                                                                  RestConversionFunction<? super W,T> transformer,
                                                                  @NotNull
                                                                  String pageLocation)

Transforms a list of domain objects to AbstractRestModels and constructs a RestPageModel from the result. Assumes input is the full list of possible objects. Will only transform the required number of objects as defined by the PageRequest. The RestPageModel will include page links.

Type Parameters:

W - domain object

T - rest object

Parameters:

input - full list of domain objects

pageRequest - which page of information required

expansion - The expansion to use when transforming the objects

uriInfo - URI info from the request

transformer - to convert domain object into rest object

pageLocation - The relative URI path used to construct the page's self link

Returns:

Single page of rest objects

getPage

@NotNull
<W,T extends AbstractRestModel> RestPageModel<T> getPage(@NotNull
                                                                  Stream<W> input,
                                                                  @NotNull
                                                                  PageRequest pageRequest,
                                                                  @NotNull
                                                                  Expansion expansion,
                                                                  @NotNull
                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                  @NotNull
                                                                  RestConversionFunction<? super W,T> transformer,
                                                                  @NotNull
                                                                  String pageLocation)

Transforms a list of domain objects to AbstractRestModels and constructs a RestPageModel from the result. Assumes input is the full list of possible objects. Will only transform the required number of objects as defined by the PageRequest. The RestPageModel will include page links.

Type Parameters:

W - domain object

T - rest object

Parameters:

input - full list of domain objects

pageRequest - which page of information required

expansion - The expansion to use when transforming the objects

uriInfo - URI info from the request

transformer - to convert domain object into rest object

pageLocation - The relative URI path used to construct the page's self link

Returns:

Single page of rest objects

getExpandablePage

@NotNull
<T extends AbstractRestModel> RestPageModel<T> getExpandablePage(@NotNull
                                                                          PageRequest pageRequest,
                                                                          @NotNull
                                                                          javax.ws.rs.core.UriInfo uriInfo,
                                                                          @NotNull
                                                                          String pageLocation)

Constructs a RestPageModel which is an empty page with a self link.

Type Parameters:

T - rest object

Parameters:

pageRequest - which page of information required

uriInfo - URI info from the request

pageLocation - The relative URI path used to construct the page's self link

Returns:

Empty page with self link