Module org.dellroad.querystream.jpa

Package org.dellroad.querystream.jpa

Interface BooleanValue

All Superinterfaces:

ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>, ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>, QueryConfigurer<jakarta.persistence.criteria.AbstractQuery<?>,Boolean,jakarta.persistence.criteria.Expression<Boolean>>, QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>, SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>, SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

public interface BooleanValue
extends ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

A boolean ExprValue.

Nested Class Summary

Nested classes/interfaces inherited from interface org.dellroad.querystream.jpa.QueryStream

QueryStream.Builder

Method Summary

Modifier and Type	Method	Description
BooleanValue	bind(Ref<Boolean,? super jakarta.persistence.criteria.Expression<Boolean>> ref)	Bind an unbound reference to the items in this stream.
default boolean	booleanValue()	Build and evaluate a JPA query based on this instance and return the single non-NULL result.
BooleanValue	filter(Function<? super jakarta.persistence.criteria.Expression<Boolean>,? extends jakarta.persistence.criteria.Expression<Boolean>> predicateBuilder)	Filter results using the boolean expression produced by the given function.
BooleanValue	not()	Invert this instance.
BooleanValue	peek(Consumer<? super jakarta.persistence.criteria.Expression<Boolean>> peeker)	Peek at the items in this stream.
BooleanValue	withFetchGraph(String name)	Configure a fetch graph for this query.
BooleanValue	withFlushMode(jakarta.persistence.FlushModeType flushMode)	Set the FlushModeType associated with this query.
BooleanValue	withHint(String name, Object value)	Associate a hint with this query.
BooleanValue	withHints(Map<String,Object> hints)	Associate hints with this query.
BooleanValue	withLoadGraph(String name)	Configure a load graph for this query.
BooleanValue	withLockMode(jakarta.persistence.LockModeType lockMode)	Set the LockModeType associated with this query.
BooleanValue	withParam(jakarta.persistence.Parameter<Calendar> parameter, Calendar value, jakarta.persistence.TemporalType temporalType)	Bind the value of a query parameter of type Calendar.
BooleanValue	withParam(jakarta.persistence.Parameter<Date> parameter, Date value, jakarta.persistence.TemporalType temporalType)	Bind the value of a query parameter of type Date.
<T> BooleanValue	withParam(jakarta.persistence.Parameter<T> parameter, T value)	Bind the value of a query parameter.
BooleanValue	withParams(Iterable<? extends ParamBinding<?>> params)	Associate parameter bindings with this query.

Methods inherited from interface org.dellroad.querystream.jpa.ExprStream

addRoot, asSubquery, count, countDistinct, distinct, exists, fetch, fetch, fetch, fetch, findAny, findFirst, findSingle, groupBy, groupBy, groupBy, groupByMulti, having, limit, orderBy, orderBy, orderBy, orderBy, orderBy, orderBy, orderByMulti, skip, thenOrderBy, thenOrderBy, thenOrderBy, thenOrderBy

Methods inherited from interface org.dellroad.querystream.jpa.ExprValue

bind, filter, map, map, map, map, mapToDouble, mapToDouble, mapToExpr, mapToFrom, mapToInt, mapToInt, mapToLong, mapToLong, mapToPath

Methods inherited from interface org.dellroad.querystream.jpa.QueryConfigurer

configure

Methods inherited from interface org.dellroad.querystream.jpa.QueryStream

getEntityManager, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParams, toCriteriaQuery, toQuery

Methods inherited from interface org.dellroad.querystream.jpa.SearchStream

allMatch, allMatch, anyMatch, anyMatch, flatMap, flatMap, flatMap, flatMapKeys, flatMapValues, getQueryType, getResultList, getResultStream, isEmpty, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, mapToRef, mapToRef, mapToRef, mapToRef, mapToRoot, noneMatch, noneMatch

Methods inherited from interface org.dellroad.querystream.jpa.SearchValue

ifPresent, isPresent, mapToSelection, orElse, orElseGet, orElseThrow, toOptional, value

Method Details

not

BooleanValue not()

Invert this instance.

Returns:

inverse value

booleanValue

default boolean booleanValue()

Build and evaluate a JPA query based on this instance and return the single non-NULL result.

This variant of SearchValue.value() is useful when it is known that NULL won't be returned.

Returns:

result of executed query

Throws:

jakarta.persistence.NoResultException - if the query returns NULL

bind

BooleanValue bind(Ref<Boolean,? super jakarta.persistence.criteria.Expression<Boolean>> ref)

Description copied from interface: QueryStream

Bind an unbound reference to the items in this stream.

Specified by:

bind in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

bind in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

bind in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

bind in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

bind in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

ref - unbound reference

Returns:

new stream that binds ref

peek

BooleanValue peek(Consumer<? super jakarta.persistence.criteria.Expression<Boolean>> peeker)

Description copied from interface: QueryStream

Peek at the items in this stream.

This is useful in cases where the selection can be modified, e.g., setting join ON conditions using Join.on().

Specified by:

peek in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

peek in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

peek in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

peek in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

peek in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

peeker - peeker into stream

Returns:

new stream that peeks into this stream

filter

BooleanValue filter(Function<? super jakarta.persistence.criteria.Expression<Boolean>,? extends jakarta.persistence.criteria.Expression<Boolean>> predicateBuilder)

Description copied from interface: QueryStream

Filter results using the boolean expression produced by the given function.

Adds to any previously specified filters.

Specified by:

filter in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

filter in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

filter in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

filter in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

filter in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

predicateBuilder - function mapping this stream's item to a boolean Expression

Returns:

new filtered stream

withFlushMode

BooleanValue withFlushMode(jakarta.persistence.FlushModeType flushMode)

Description copied from interface: QueryStream

Set the FlushModeType associated with this query.

Specified by:

withFlushMode in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withFlushMode in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withFlushMode in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

withFlushMode in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withFlushMode in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

flushMode - new flush mode

Returns:

new stream with the specified flush mode configured

See Also:

• Query.setFlushMode(jakarta.persistence.FlushModeType)

withLockMode

BooleanValue withLockMode(jakarta.persistence.LockModeType lockMode)

Description copied from interface: QueryStream

Set the LockModeType associated with this query.

Specified by:

withLockMode in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withLockMode in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withLockMode in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

withLockMode in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withLockMode in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

lockMode - new lock mode

Returns:

new stream with the specified lock mode configured

See Also:

• Query.setLockMode(jakarta.persistence.LockModeType)

withHint

BooleanValue withHint(String name,
 Object value)

Description copied from interface: QueryStream

Associate a hint with this query.

Specified by:

withHint in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withHint in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withHint in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

withHint in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withHint in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

name - name of hint

value - value of hint

Returns:

new stream with the specified hint configured

See Also:

• Query.setHint(java.lang.String, java.lang.Object)

withHints

BooleanValue withHints(Map<String,Object> hints)

Description copied from interface: QueryStream

Associate hints with this query.

Specified by:

withHints in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withHints in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withHints in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

withHints in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withHints in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

hints - hints to add

Returns:

new stream with the specified hints added

See Also:

• Query.setHint(java.lang.String, java.lang.Object)

withParam

<T> BooleanValue withParam(jakarta.persistence.Parameter<T> parameter,
 T value)

Description copied from interface: QueryStream

Bind the value of a query parameter.

Replaces any previous binding of the same parameter.

Specified by:

withParam in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParam in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParam in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

withParam in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParam in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Type Parameters:

T - parameter value type

Parameters:

parameter - the parameter to set

value - parameter value

Returns:

new stream with the specified parameter value set

See Also:

• Query.setParameter(Parameter, Object)

withParam

BooleanValue withParam(jakarta.persistence.Parameter<Date> parameter,
 Date value,
 jakarta.persistence.TemporalType temporalType)

Description copied from interface: QueryStream

Bind the value of a query parameter of type Date.

Replaces any previous binding of the same parameter.

Specified by:

withParam in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParam in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParam in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

withParam in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParam in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

parameter - the parameter to set

value - parameter value

temporalType - temporal type for value

Returns:

new stream with the specified parameter value set

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

withParam

BooleanValue withParam(jakarta.persistence.Parameter<Calendar> parameter,
 Calendar value,
 jakarta.persistence.TemporalType temporalType)

Description copied from interface: QueryStream

Bind the value of a query parameter of type Calendar.

Replaces any previous binding of the same parameter.

Specified by:

withParam in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParam in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParam in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

withParam in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParam in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

parameter - the parameter to set

value - parameter value

temporalType - temporal type for value

Returns:

new stream with the specified parameter value set

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

withParams

BooleanValue withParams(Iterable<? extends ParamBinding<?>> params)

Description copied from interface: QueryStream

Associate parameter bindings with this query.

Replaces any previous bindings of the same parameters.

Specified by:

withParams in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParams in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParams in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

withParams in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withParams in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

params - bindings to add

Returns:

new stream with the specified parameter bindings added

See Also:

• Query.setParameter(Parameter, Object)

withLoadGraph

BooleanValue withLoadGraph(String name)

Description copied from interface: QueryStream

Configure a load graph for this query.

Equivalent to withHint("jakarta.persistence.loadgraph", name).

Specified by:

withLoadGraph in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withLoadGraph in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withLoadGraph in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

withLoadGraph in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withLoadGraph in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

name - name of load graph

Returns:

new stream with the specified load graph configured

withFetchGraph

BooleanValue withFetchGraph(String name)

Description copied from interface: QueryStream

Configure a fetch graph for this query.

Equivalent to withHint("jakarta.persistence.fetchgraph", name).

Specified by:

withFetchGraph in interface ExprStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withFetchGraph in interface ExprValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withFetchGraph in interface QueryStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>,jakarta.persistence.criteria.AbstractQuery<?>,jakarta.persistence.criteria.CriteriaQuery<Boolean>,jakarta.persistence.TypedQuery<Boolean>>

Specified by:

withFetchGraph in interface SearchStream<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Specified by:

withFetchGraph in interface SearchValue<Boolean,jakarta.persistence.criteria.Expression<Boolean>>

Parameters:

name - name of fetch graph

Returns:

new stream with the specified fetch graph configured