Package info.ejava.examples.common.dto.paging

Class PageableDTO

java.lang.Object

info.ejava.examples.common.dto.paging.PageableDTO

public class PageableDTO
extends Object

This class is responsible for serializing and deserializing a Spring Data Pageable object to/from an API. It has been mapped using Jackson JSON and XML, with a little JAXB to get it to work with WebFlux. It is designed to be an immutable object -- thus the mapping challenge is to have all properties known prior to construction.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PageableDTO.DtoFacade	This mutable adapter class is used to unmarshal JSON/XML using Jackson and build a resulting immutable object.
(package private) static class	PageableDTO.PageableAdapter	This adapter is called by JAXB when a class -- like the PageableDTO -- declares a XmlJavaTypeAdapter to handle marshaling and demarshaling through a facade object.
static class	PageableDTO.Serializer	This adapter is called by Jackson to marshal the unmutable PageableDTO.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PAGE_NUMBER
static final String	PAGE_SIZE
private final Integer	pageNumber
private final Integer	pageSize
static final String	SORT
private final String	sortString

Constructor Summary

Constructors

Constructor	Description
PageableDTO(Integer pageNumber, Integer pageSize, String sort)

Method Summary

Modifier and Type	Method	Description
org.springframework.web.util.UriBuilder	addQueryParams(org.springframework.web.util.UriBuilder uriBuilder)
static PageableDTO	fromPageable(org.springframework.data.domain.Pageable pageable)
org.springframework.util.MultiValueMap<String,String>	getQueryParams()
boolean	hasPrevious()
boolean	isPaged()
boolean	isSorted()
boolean	isUnpaged()
PageableDTO	next()
static PageableDTO	of(Integer pageNumber, Integer pageSize)
static PageableDTO	of(Integer pageNumber, Integer pageSize, String sortString)
static PageableDTO	of(Integer pageNumber, Integer pageSize, org.springframework.data.domain.Sort sort)
static PageableDTO	of(org.springframework.data.domain.Pageable pageable)
PageableDTO	previous()
PageableDTO.DtoFacade	toDtoFacade()
org.springframework.data.domain.Pageable	toPageable()
org.springframework.data.domain.Sort	toSort()
String	toString()
static PageableDTO	unpaged()

Methods inherited from class java.lang.Object

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

Field Details

PAGE_NUMBER

public static final String PAGE_NUMBER

See Also:

• Constant Field Values

PAGE_SIZE

public static final String PAGE_SIZE

See Also:

• Constant Field Values

SORT

public static final String SORT

See Also:

• Constant Field Values

pageNumber

private final Integer pageNumber

pageSize

private final Integer pageSize

sortString

private final String sortString

Constructor Details

PageableDTO

public PageableDTO(Integer pageNumber,
 Integer pageSize,
 String sort)

Method Details

unpaged

public static PageableDTO unpaged()

of

public static PageableDTO of(Integer pageNumber,
 Integer pageSize)

of

public static PageableDTO of(Integer pageNumber,
 Integer pageSize,
 org.springframework.data.domain.Sort sort)

of

public static PageableDTO of(Integer pageNumber,
 Integer pageSize,
 String sortString)

of

public static PageableDTO of(org.springframework.data.domain.Pageable pageable)

next

public PageableDTO next()

previous

public PageableDTO previous()

isUnpaged

public boolean isUnpaged()

isPaged

public boolean isPaged()

isSorted

public boolean isSorted()

hasPrevious

public boolean hasPrevious()

addQueryParams

public org.springframework.web.util.UriBuilder addQueryParams(org.springframework.web.util.UriBuilder uriBuilder)

getQueryParams

public org.springframework.util.MultiValueMap<String,String> getQueryParams()

fromPageable

public static PageableDTO fromPageable(org.springframework.data.domain.Pageable pageable)

toPageable

public org.springframework.data.domain.Pageable toPageable()

toSort

public org.springframework.data.domain.Sort toSort()

toString

public String toString()

Overrides:

toString in class Object

toDtoFacade

public PageableDTO.DtoFacade toDtoFacade()