com.atlassian.bamboo.plugins.rest.pagination

Class PaginationServiceImpl

java.lang.Object

com.atlassian.bamboo.plugins.rest.pagination.PaginationServiceImpl

All Implemented Interfaces:

PaginationService

@Component
public class PaginationServiceImpl
extends Object
implements PaginationService

Utility service for constructing a paged rest responses

Constructor Summary

Constructors

Constructor and Description
PaginationServiceImpl(LinkService linkService)

Method Summary

Modifier and Type	Method and Description
<T extends AbstractRestModel> @NotNull 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.
<W,T extends AbstractRestModel> @NotNull 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.
<W,T extends AbstractRestModel> @NotNull 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.
<W,T extends AbstractRestModel> @NotNull 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.
<W,T extends AbstractRestModel> @NotNull 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginationServiceImpl

@Autowired
public PaginationServiceImpl(LinkService linkService)

Method Detail

getPage

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

Description copied from interface: PaginationService

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 PaginationService.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).

Specified by:

getPage in interface PaginationService

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

Description copied from interface: PaginationService

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 PaginationService.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).

Specified by:

getPage in interface PaginationService

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

Description copied from interface: PaginationService

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.

Specified by:

getPage in interface PaginationService

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

Description copied from interface: PaginationService

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.

Specified by:

getPage in interface PaginationService

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
public <T extends AbstractRestModel> @NotNull RestPageModel<T> getExpandablePage(@NotNull
                                                                                          @NotNull PageRequest pageRequest,
                                                                                          @NotNull
                                                                                          @NotNull javax.ws.rs.core.UriInfo uriInfo,
                                                                                          @NotNull
                                                                                          @NotNull String pageLocation)

Description copied from interface: PaginationService

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

Specified by:

getExpandablePage in interface PaginationService

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