Package com.testdroid.api.dto

Class Context<T extends APIEntity>

java.lang.Object

com.testdroid.api.dto.Context<T>

public class Context<T extends APIEntity>
extends java.lang.Object

Author:

Damian Sniezek

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_LIMIT
static int	DEFAULT_OFFSET
static java.lang.String	FILTER_DELIMITER
static java.lang.String	FILTER_REQUEST_PARAM
static java.lang.String	GROUP_REQUEST_PARAM
static java.lang.String	LIMIT_REQUEST_PARAM
static java.lang.String	OFFSET_REQUEST_PARAM
static java.lang.String	SEARCH_REQUEST_PARAM
static java.lang.String	SORT_REQUEST_PARAM

Constructor Summary

Constructors

Constructor	Description
Context(java.lang.Class<T> type)
Context(java.lang.Class<T> type, int offset, int limit, java.lang.String search, java.lang.String sort)
Context(java.lang.Class<T> type, int offset, int limit, java.lang.String search, java.lang.String sort, java.util.List<FilterEntry> filters, java.util.List<java.lang.String> groups)

Method Summary

Modifier and Type	Method	Description
Context<T>	addFilter(FilterEntry filterEntry)
<R extends T> Context<R>	as(java.lang.Class<R> clazz)
org.apache.commons.collections4.MultiValuedMap<java.lang.String,java.lang.Object>	build()
java.util.Optional<java.lang.Integer>	computeMaxResult()
java.util.Optional<FilterEntry>	findFilter(java.lang.String field, Operand operand)
java.util.Optional<APISort.SortItem>	findSort(java.lang.String field)
java.lang.Boolean	getCacheable()
org.apache.commons.collections4.MultiValuedMap<java.lang.String,java.lang.Object>	getExtraParams()
java.util.List<FilterEntry>	getFilters()
java.util.List<java.lang.String>	getGroups()
int	getLimit()
int	getOffset()
java.lang.String	getSearch()
APISort	getSort()
java.lang.Class<T>	getType()
Context<T>	setCacheable(java.lang.Boolean cacheable)
Context<T>	setCount(java.lang.Long count)
void	setExtraParams(org.apache.commons.collections4.MultiValuedMap<java.lang.String,java.lang.Object> extraParams)
Context<T>	setFilters(java.util.List<FilterEntry> filters)
Context<T>	setLimit(int limit)
Context<T>	setOffset(int offset)
Context<T>	setSearch(java.lang.String search)
Context<T>	setSort(APISort sort)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

Constant Field Values

DEFAULT_OFFSET

public static final int DEFAULT_OFFSET

See Also:

Constant Field Values

FILTER_REQUEST_PARAM

public static final java.lang.String FILTER_REQUEST_PARAM

See Also:

Constant Field Values

SEARCH_REQUEST_PARAM

public static final java.lang.String SEARCH_REQUEST_PARAM

See Also:

Constant Field Values

FILTER_DELIMITER

public static final java.lang.String FILTER_DELIMITER

See Also:

Constant Field Values

GROUP_REQUEST_PARAM

public static final java.lang.String GROUP_REQUEST_PARAM

See Also:

Constant Field Values

LIMIT_REQUEST_PARAM

public static final java.lang.String LIMIT_REQUEST_PARAM

See Also:

Constant Field Values

SORT_REQUEST_PARAM

public static final java.lang.String SORT_REQUEST_PARAM

See Also:

Constant Field Values

OFFSET_REQUEST_PARAM

public static final java.lang.String OFFSET_REQUEST_PARAM

See Also:

Constant Field Values

Constructor Detail

Context

public Context(java.lang.Class<T> type)

Context

public Context(java.lang.Class<T> type,
               int offset,
               int limit,
               java.lang.String search,
               java.lang.String sort)

Context

public Context(java.lang.Class<T> type,
               int offset,
               int limit,
               java.lang.String search,
               java.lang.String sort,
               java.util.List<FilterEntry> filters,
               java.util.List<java.lang.String> groups)

Method Detail

getOffset

public int getOffset()

setOffset

public Context<T> setOffset(int offset)

getLimit

public int getLimit()

setLimit

public Context<T> setLimit(int limit)

getSearch

public java.lang.String getSearch()

setSearch

public Context<T> setSearch(java.lang.String search)

getSort

public APISort getSort()

findSort

public java.util.Optional<APISort.SortItem> findSort(java.lang.String field)

setSort

public Context<T> setSort(APISort sort)

getType

public java.lang.Class<T> getType()

getFilters

public java.util.List<FilterEntry> getFilters()

findFilter

public java.util.Optional<FilterEntry> findFilter(java.lang.String field,
                                                  Operand operand)

setFilters

public Context<T> setFilters(java.util.List<FilterEntry> filters)

addFilter

public Context<T> addFilter(FilterEntry filterEntry)

getGroups

public java.util.List<java.lang.String> getGroups()

getCacheable

public java.lang.Boolean getCacheable()

setCacheable

public Context<T> setCacheable(java.lang.Boolean cacheable)

getExtraParams

public org.apache.commons.collections4.MultiValuedMap<java.lang.String,java.lang.Object> getExtraParams()

setExtraParams

public void setExtraParams(org.apache.commons.collections4.MultiValuedMap<java.lang.String,java.lang.Object> extraParams)

setCount

public Context<T> setCount(java.lang.Long count)

computeMaxResult

public java.util.Optional<java.lang.Integer> computeMaxResult()

build

public org.apache.commons.collections4.MultiValuedMap<java.lang.String,java.lang.Object> build()

as

public <R extends T> Context<R> as(java.lang.Class<R> clazz)