Package org.apache.juneau.commons.beanquery

Class BeanQuerySession.Builder<T,SELF extends BeanQuerySession.Builder<T,SELF>>

java.lang.Object

org.apache.juneau.commons.beanquery.BeanQuerySession.Builder<T,SELF>

Type Parameters:

T - The row type.

SELF - The concrete builder type, returned by every setter.

Direct Known Subclasses:

InMemoryBeanQuerySession.Builder, SqlBeanQuerySession.Builder

Enclosing class:

BeanQuerySession<T>

public abstract static class BeanQuerySession.Builder<T,SELF extends BeanQuerySession.Builder<T,SELF>>
extends Object

The settings every engine's session builder shares. Each starts from the context's value.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(BeanQueryContext<T> context)	Constructor.

Method Summary

Modifier and Type	Method	Description
abstract BeanQuerySession<T>	build()	Builds the session.
SELF	countPolicy(CountPolicy value)	Overrides BeanQueryContext.Builder.countPolicy(CountPolicy) for this session.
SELF	defaultLimit(int value)	Overrides BeanQueryContext.Builder.defaultLimit(int) for this session.
SELF	maxExpressionDepth(int value)	Overrides BeanQueryContext.Builder.maxExpressionDepth(int) for this session.
SELF	maxLimit(Integer value)	Overrides BeanQueryContext.Builder.maxLimit(Integer) for this session.
SELF	maxSearchClauses(int value)	Overrides BeanQueryContext.Builder.maxSearchClauses(int) for this session.
SELF	maxSearchLength(int value)	Overrides BeanQueryContext.Builder.maxSearchLength(int) for this session.
SELF	maxSortKeys(int value)	Overrides BeanQueryContext.Builder.maxSortKeys(int) for this session.
SELF	regexTimeout(Duration value)	Overrides BeanQueryContext.Builder.regexTimeout(Duration) for this session.
SELF	restrictColumns(String... names)	Keeps only the specified columns for this session.
protected final SELF	self()	Returns this builder as its concrete type.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(BeanQueryContext<T> context)

Constructor.

Parameters:

context - The context the session runs against. Must not be null.

Method Details

self

protected final SELF self()

Returns this builder as its concrete type.

Returns:

This object.

restrictColumns

public SELF restrictColumns(String... names)

Keeps only the specified columns for this session. The context's column order is kept.

Parameters:

names - The column names. Each must be a column of the context (or of an earlier restriction).

Returns:

This object.

Throws:

IllegalArgumentException - If a name is not a current column.

regexTimeout

public SELF regexTimeout(Duration value)

Overrides BeanQueryContext.Builder.regexTimeout(Duration) for this session.

Parameters:

value - The budget. Must be positive.

Returns:

This object.

countPolicy

public SELF countPolicy(CountPolicy value)

Overrides BeanQueryContext.Builder.countPolicy(CountPolicy) for this session.

Parameters:

value - The policy. Must not be null.

Returns:

This object.

defaultLimit

public SELF defaultLimit(int value)

Overrides BeanQueryContext.Builder.defaultLimit(int) for this session.

Parameters:

value - The limit. Must be positive.

Returns:

This object.

maxLimit

public SELF maxLimit(Integer value)

Overrides BeanQueryContext.Builder.maxLimit(Integer) for this session.

If this session's defaultLimit was never explicitly set on this builder (it is still the value inherited from the context), narrowing maxLimit below it auto-narrows defaultLimit to match, rather than leaving the two in conflict. An explicitly-chosen defaultLimit is never silently changed by this setter — a resulting conflict is left for build() to reject.

Parameters:

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

Returns:

This object.

maxSearchClauses

public SELF maxSearchClauses(int value)

Overrides BeanQueryContext.Builder.maxSearchClauses(int) for this session.

Parameters:

value - The cap. Must be positive.

Returns:

This object.

maxSortKeys

public SELF maxSortKeys(int value)

Overrides BeanQueryContext.Builder.maxSortKeys(int) for this session.

Parameters:

value - The cap. Must be positive.

Returns:

This object.

maxSearchLength

public SELF maxSearchLength(int value)

Overrides BeanQueryContext.Builder.maxSearchLength(int) for this session.

Parameters:

value - The cap. Must be positive.

Returns:

This object.

maxExpressionDepth

public SELF maxExpressionDepth(int value)

Overrides BeanQueryContext.Builder.maxExpressionDepth(int) for this session.

Parameters:

value - The cap. Must be positive.

Returns:

This object.

build

public abstract BeanQuerySession<T> build()

Builds the session.

Returns:

A new session. Close it when done.

Throws:

IllegalStateException - If a required setting is missing or two settings conflict.