Package io.rocketbase.commons.util

Class QueryParamParser

java.lang.Object

io.rocketbase.commons.util.QueryParamParser

public final class QueryParamParser
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static List<DateTimeFormatter>	DEFAULT_DATE_FORMATTERS

Constructor Summary

Constructors

Constructor	Description
QueryParamParser()

Method Summary

Modifier and Type	Method	Description
static Boolean	parseBoolean(String value, Boolean defaultValue)
static Boolean	parseBoolean(org.springframework.util.MultiValueMap<String,String> params, String key, Boolean defaultValue)
static <T extends Enum> T	parseEnum(String value, Class<T> clazz, T defaultValue)
static <T extends Enum> T	parseEnum(org.springframework.util.MultiValueMap<String,String> params, String key, Class<T> clazz, T defaultValue)
static <T extends Enum> Set<T>	parseEnumSet(org.springframework.util.MultiValueMap<String,String> params, String key, Class<T> clazz, Set<T> defaultValue)
static Instant	parseInstant(String value, Instant defaultValue)
static Instant	parseInstant(org.springframework.util.MultiValueMap<String,String> params, String key, Instant defaultValue)
static Integer	parseInteger(String value, Integer defaultValue)
static Integer	parseInteger(org.springframework.util.MultiValueMap<String,String> params, String key, Integer defaultValue)
static Map<String,String>	parseKeyValue(String key, org.springframework.util.MultiValueMap<String,String> params)
static LocalDate	parseLocalDate(String value, LocalDate defaultValue)
static LocalDate	parseLocalDate(org.springframework.util.MultiValueMap<String,String> params, String key, LocalDate defaultValue)
static LocalDateTime	parseLocalDateTime(String value, LocalDateTime defaultValue)
static LocalDateTime	parseLocalDateTime(org.springframework.util.MultiValueMap<String,String> params, String key, LocalDateTime defaultValue)
static LocalTime	parseLocalTime(String value, LocalTime defaultValue)
static LocalTime	parseLocalTime(org.springframework.util.MultiValueMap<String,String> params, String key, LocalTime defaultValue)
static Long	parseLong(String value, Long defaultValue)
static Long	parseLong(org.springframework.util.MultiValueMap<String,String> params, String key, Long defaultValue)
static org.springframework.data.domain.Pageable	parsePageRequest(org.springframework.util.MultiValueMap<String,String> params)	parse page, size and sort from request
static org.springframework.data.domain.Pageable	parsePageRequest(org.springframework.util.MultiValueMap<String,String> params, String pageSizeKey, String pageKey, String sortKey, org.springframework.data.domain.Sort defaultSort, int defaultPageSize, int maxPageSize)	parse page, size and sort from request
static org.springframework.data.domain.Pageable	parsePageRequest(org.springframework.util.MultiValueMap<String,String> params, org.springframework.data.domain.Sort defaultSort, int defaultPageSize, int maxPageSize)	parse page, size and sort from request
static org.springframework.data.domain.Sort	parseSort(org.springframework.util.MultiValueMap<String,String> params, String key)	parse sort and build correct Sort or Pageable
static org.springframework.data.domain.Sort	parseSort(org.springframework.util.MultiValueMap<String,String> params, String key, org.springframework.data.domain.Sort defaultSort)	parse sort and build correct Sort or Pageable
static String	parseString(org.springframework.util.MultiValueMap<String,String> params, String key)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DATE_FORMATTERS

public static List<DateTimeFormatter> DEFAULT_DATE_FORMATTERS

Constructor Detail

QueryParamParser

public QueryParamParser()

Method Detail

parsePageRequest

public static org.springframework.data.domain.Pageable parsePageRequest(org.springframework.util.MultiValueMap<String,String> params)

parse page, size and sort from request

Parameters:

params - MultiValueMap that contains all query params of request

Returns:

a filled PageRequest

parsePageRequest

public static org.springframework.data.domain.Pageable parsePageRequest(org.springframework.util.MultiValueMap<String,String> params,
                                                                        org.springframework.data.domain.Sort defaultSort,
                                                                        int defaultPageSize,
                                                                        int maxPageSize)

parse page, size and sort from request

Parameters:

params - MultiValueMap that contains all query params of request

defaultSort - sort that should get used in case of not filled parameter

defaultPageSize - in case the pageSize is not set - which value to take

maxPageSize - maximum size of pageSize to limit the response size

Returns:

a filled PageRequest

parsePageRequest

public static org.springframework.data.domain.Pageable parsePageRequest(org.springframework.util.MultiValueMap<String,String> params,
                                                                        String pageSizeKey,
                                                                        String pageKey,
                                                                        String sortKey,
                                                                        org.springframework.data.domain.Sort defaultSort,
                                                                        int defaultPageSize,
                                                                        int maxPageSize)

parse page, size and sort from request

Parameters:

params - MultiValueMap that contains all query params of request

pageSizeKey - queryParam of current size of page to query

pageKey - queryParam of current page to query

sortKey - queryParam of sort to query

defaultSort - sort that should get used in case of not filled parameter

defaultPageSize - in case the pageSize is not set - which value to take

maxPageSize - maximum size of pageSize to limit the response size

Returns:

a filled PageRequest

parseSort

public static org.springframework.data.domain.Sort parseSort(org.springframework.util.MultiValueMap<String,String> params,
                                                             String key)

parse sort and build correct Sort or Pageable

Parameters:

params - MultiValueMap that contains all query params of request

key - name of sort parameter in uri

Returns:

an unsorted Sort in case of empty param or filled one

parseSort

public static org.springframework.data.domain.Sort parseSort(org.springframework.util.MultiValueMap<String,String> params,
                                                             String key,
                                                             org.springframework.data.domain.Sort defaultSort)

parse sort and build correct Sort or Pageable

Parameters:

params - MultiValueMap that contains all query params of request

key - name of sort parameter in uri

defaultSort - sort that should get used in case of not filled parameter

Returns:

defaultSort in case of empty param or filled one

parseString

public static String parseString(org.springframework.util.MultiValueMap<String,String> params,
                                 String key)

parseInteger

public static Integer parseInteger(org.springframework.util.MultiValueMap<String,String> params,
                                   String key,
                                   Integer defaultValue)

parseInteger

public static Integer parseInteger(String value,
                                   Integer defaultValue)

parseLong

public static Long parseLong(org.springframework.util.MultiValueMap<String,String> params,
                             String key,
                             Long defaultValue)

parseLong

public static Long parseLong(String value,
                             Long defaultValue)

parseBoolean

public static Boolean parseBoolean(org.springframework.util.MultiValueMap<String,String> params,
                                   String key,
                                   Boolean defaultValue)

parseBoolean

public static Boolean parseBoolean(String value,
                                   Boolean defaultValue)

parseLocalDate

public static LocalDate parseLocalDate(org.springframework.util.MultiValueMap<String,String> params,
                                       String key,
                                       LocalDate defaultValue)

parseLocalDate

public static LocalDate parseLocalDate(String value,
                                       LocalDate defaultValue)

parseLocalTime

public static LocalTime parseLocalTime(org.springframework.util.MultiValueMap<String,String> params,
                                       String key,
                                       LocalTime defaultValue)

parseLocalTime

public static LocalTime parseLocalTime(String value,
                                       LocalTime defaultValue)

parseLocalDateTime

public static LocalDateTime parseLocalDateTime(org.springframework.util.MultiValueMap<String,String> params,
                                               String key,
                                               LocalDateTime defaultValue)

parseLocalDateTime

public static LocalDateTime parseLocalDateTime(String value,
                                               LocalDateTime defaultValue)

parseInstant

public static Instant parseInstant(org.springframework.util.MultiValueMap<String,String> params,
                                   String key,
                                   Instant defaultValue)

parseInstant

public static Instant parseInstant(String value,
                                   Instant defaultValue)

parseEnum

public static <T extends Enum> T parseEnum(org.springframework.util.MultiValueMap<String,String> params,
                                           String key,
                                           Class<T> clazz,
                                           T defaultValue)

parseEnum

public static <T extends Enum> T parseEnum(String value,
                                           Class<T> clazz,
                                           T defaultValue)

parseEnumSet

public static <T extends Enum> Set<T> parseEnumSet(org.springframework.util.MultiValueMap<String,String> params,
                                                   String key,
                                                   Class<T> clazz,
                                                   Set<T> defaultValue)

parseKeyValue

public static Map<String,String> parseKeyValue(String key,
                                                     org.springframework.util.MultiValueMap<String,String> params)