Package org.apache.juneau.rest.server.converter

Class QueryableSettings.Builder

java.lang.Object

org.apache.juneau.rest.server.converter.QueryableSettings.Builder

Enclosing class:

QueryableSettings

public static class QueryableSettings.Builder
extends Object

Builder for QueryableSettings.

Each setter records a value to be copied by QueryableSettings.applyTo(BeanQueryContext.Builder); the values are validated by the context builder when applied.

Method Summary

Modifier and Type	Method	Description
QueryableSettings.Builder	allowRegex(boolean value)	Enables or disables the $regex search operator.
QueryableSettings	build()	Builds the (immutable) settings.
QueryableSettings.Builder	countPolicy(CountPolicy value)	Sets which counts are computed.
QueryableSettings.Builder	defaultLimit(int value)	Sets the page size used when the request specifies no limit.
QueryableSettings.Builder	maxExpressionDepth(int value)	Sets the deepest allowed expression nesting.
QueryableSettings.Builder	maxLimit(Integer value)	Sets the largest page size a request may ask for; larger limits are clamped to it.
QueryableSettings.Builder	maxSearchClauses(int value)	Sets the largest number of search clauses.
QueryableSettings.Builder	maxSearchLength(int value)	Sets the longest search, sort, view or opts string, in characters.
QueryableSettings.Builder	maxSortKeys(int value)	Sets the largest number of sort keys.
QueryableSettings.Builder	regexTimeout(Duration value)	Sets the time budget for all $regex matching in one query.

Methods inherited from class java.lang.Object

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

Method Details

allowRegex

public QueryableSettings.Builder allowRegex(boolean value)

Enables or disables the $regex search operator.

Parameters:

value - true to allow $regex. Builder default is true; call allowRegex(false) to opt out.

Returns:

This object.

regexTimeout

public QueryableSettings.Builder regexTimeout(Duration value)

Sets the time budget for all $regex matching in one query.

Parameters:

value - The budget. Must be positive.

Returns:

This object.

countPolicy

public QueryableSettings.Builder countPolicy(CountPolicy value)

Sets which counts are computed.

Parameters:

value - The policy. Must not be null.

Returns:

This object.

defaultLimit

public QueryableSettings.Builder defaultLimit(int value)

Sets the page size used when the request specifies no limit.

Parameters:

value - The default limit. Must be positive.

Returns:

This object.

maxLimit

public QueryableSettings.Builder maxLimit(Integer value)

Sets the largest page size a request may ask for; larger limits are clamped to it.

Parameters:

value - The cap, or null for no cap. Must be positive if set.

Returns:

This object.

maxSearchClauses

public QueryableSettings.Builder maxSearchClauses(int value)

Sets the largest number of search clauses.

Parameters:

value - The cap. Must be positive.

Returns:

This object.

maxSortKeys

public QueryableSettings.Builder maxSortKeys(int value)

Sets the largest number of sort keys.

Parameters:

value - The cap. Must be positive.

Returns:

This object.

maxSearchLength

public QueryableSettings.Builder maxSearchLength(int value)

Sets the longest search, sort, view or opts string, in characters.

Parameters:

value - The cap. Must be positive.

Returns:

This object.

maxExpressionDepth

public QueryableSettings.Builder maxExpressionDepth(int value)

Sets the deepest allowed expression nesting.

Parameters:

value - The cap. Must be positive.

Returns:

This object.

build

public QueryableSettings build()

Builds the (immutable) settings.

Returns:

A new QueryableSettings.