Top Inners Fields Constructors Methods
org.eclipse.persistence.internal.jpa.querydef

public Class CriteriaBuilderImpl

extends Object
implements JpaCriteriaBuilder, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.eclipse.persistence.jpa.JpaCriteriaBuilder, jakarta.persistence.criteria.CriteriaBuilder
Imports
java.io.Serializable, java.math.BigDecimal, .BigInteger, java.util.ArrayList, .Collection, .List, .Map, .Set, jakarta.persistence.Tuple, jakarta.persistence.criteria.CollectionJoin, .CompoundSelection, .CriteriaDelete, .CriteriaQuery, .CriteriaUpdate, .Expression, .Join, .ListJoin, .MapJoin, .Order, .ParameterExpression, .Path, .Predicate, .Predicate.BooleanOperator, .Root, .Selection, .SetJoin, .Subquery, jakarta.persistence.metamodel.EntityType, .Metamodel, .Type.PersistenceType, org.eclipse.persistence.expressions.ExpressionBuilder, .ExpressionMath, .ExpressionOperator, org.eclipse.persistence.internal.expressions.ArgumentListFunctionExpression, .ConstantExpression, .FunctionExpression, .SubSelectExpression, org.eclipse.persistence.internal.helper.BasicTypeHelperImpl, .ClassConstants, org.eclipse.persistence.internal.jpa.metamodel.MetamodelImpl, .TypeImpl, org.eclipse.persistence.internal.jpa.querydef.AbstractQueryImpl.ResultType, org.eclipse.persistence.internal.localization.ExceptionLocalization, org.eclipse.persistence.jpa.JpaCriteriaBuilder, org.eclipse.persistence.queries.ReportQuery

Nested and Inner Type Summary

Modifier and TypeClass and Description
public class
CriteriaBuilderImpl.CaseImpl<R>

Implementation of Case interface from Criteria Builder

public class
CriteriaBuilderImpl.CoalesceImpl<X>

Interface used to build coalesce expressions.

public class
CriteriaBuilderImpl.SimpleCaseImpl<C, R>

Implementation of SimpleCase interface from CriteriaBuilder

Field Summary

Modifier and TypeField and Description
public static final String
protected Metamodel
public static final String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public <N extends Number> Expression<N>

Returns:

absolute value
abs
(Expression<N>
expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.abs.

Create an expression that returns the absolute value of its argument.
public <Y> Expression<Y>

Returns:

all expression
all
(Subquery<Y>
subquery
subquery
)

Implements jakarta.persistence.criteria.CriteriaBuilder.all.

Create a predicate corresponding to an all expression over the subquery results.
public Predicate

Returns:

and predicate
and
(Expression<Boolean>
boolean expression
x
,
Expression<Boolean>
boolean expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.and.

Create a conjunction of the given boolean expressions.
public Predicate

Returns:

and predicate
and
(Predicate...
zero or more restriction predicates
restrictions
)

Implements jakarta.persistence.criteria.CriteriaBuilder.and.

Create a conjunction of the given restriction predicates.
public <Y> Expression<Y>

Returns:

any expression
any
(Subquery<Y>
subquery
subquery
)

Implements jakarta.persistence.criteria.CriteriaBuilder.any.

Create a predicate corresponding to an any expression over the subquery results.
public CompoundSelection<Object[]>

Returns:

array-valued compound selection
array
(Selection<?>...
selection items
selections
)

Implements jakarta.persistence.criteria.CriteriaBuilder.array.

Create an array-valued selection item
public Order

Returns:

ascending ordering corresponding to the expression
asc
(Expression<?>
expression used to define the ordering
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.asc.

Create an ordering by the ascending value of the expression.
public <N extends Number> Expression<Double>

Returns:

avg expression
avg
(Expression<N>
expression representing input value to avg operation
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.avg.

Create an expression applying the avg operation.
public <Y extends Comparable<? super Y>> Predicate

Returns:

between predicate
between
(Expression<? extends Y>
expression
v
,
Expression<? extends Y>
expression
x
,
Expression<? extends Y>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.between, jakarta.persistence.criteria.CriteriaBuilder.between.

Create a predicate for testing whether the first argument is between the second and third arguments in value.
public <Y extends Comparable<? super Y>> Predicate

Returns:

between predicate
between
(Expression<? extends Y>
expression
v
,
Y
value
x
,
Y
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.between.

Create a predicate for testing whether the first argument is between the second and third arguments in value.
protected List<Expression<?>>
buildList(Expression<?>... expressions)

public <N extends Number> Expression<N>

Returns:

ceiling
ceiling
(Expression<N>
expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.ceiling.

Create an expression that returns the ceiling of its argument, that is, the smallest integer greater than or equal to its argument.
public <Y> Expression<Y>

Returns:

expression corresponding to the given coalesce expression
coalesce
(Expression<? extends Y>
expression
x
,
Expression<? extends Y>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.coalesce, jakarta.persistence.criteria.CriteriaBuilder.coalesce.

Create an expression that returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.
public <Y> Expression<Y>

Returns:

coalesce expression
coalesce
(Expression<? extends Y>
expression
x
,
Y
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.coalesce.

Create an expression that returns null if all its arguments evaluate to null, and the value of the first non-null argument otherwise.
public <T> CriteriaBuilder.Coalesce<T>

Returns:

coalesce expression
coalesce
()

Implements jakarta.persistence.criteria.CriteriaBuilder.coalesce.

Create a coalesce expression.
public Expression<String>

Returns:

expression corresponding to concatenation
concat
(Expression<String>
string expression
x
,
Expression<String>
string expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.concat.

String concatenation operation.
public Expression<String>

Returns:

expression corresponding to concatenation
concat
(Expression<String>
string expression
x
,
String
string
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.concat.

String concatenation operation.
public Expression<String>

Returns:

expression corresponding to concatenation
concat
(String
string
x
,
Expression<String>
string expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.concat.

String concatenation operation.
public Predicate

Returns:

and predicate
conjunction
()

Implements jakarta.persistence.criteria.CriteriaBuilder.conjunction.

Create a conjunction (with zero conjuncts).
public <Y> CompoundSelection<Y>

Returns:

selection item
construct
(Class<Y>
class whose instance is to be constructed
result
,
Selection<?>...
arguments to the constructor
selections
)

Implements jakarta.persistence.criteria.CriteriaBuilder.construct.

Define a select list item corresponding to a constructor.
public Expression<Long>

Returns:

count expression
count
(Expression<?>
expression representing input value to count operation
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.count.

Create an expression applying the count operation.
public Expression<Long>

Returns:

count distinct expression
countDistinct
(Expression<?>
expression representing input value to count distinct operation
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.countDistinct.

Create an expression applying the count distinct operation.
public <T> CriteriaDelete<T>
createCriteriaDelete(Class<T>
target type for delete operation
targetEntity
)

Implements jakarta.persistence.criteria.CriteriaBuilder.createCriteriaDelete.

Create a CriteriaDelete query object to perform a bulk delete operation.
public <T> CriteriaUpdate<T>
createCriteriaUpdate(Class<T>
target type for update operation
targetEntity
)

Implements jakarta.persistence.criteria.CriteriaBuilder.createCriteriaUpdate.

Create a CriteriaUpdate query object to perform a bulk update operation.
public CriteriaQuery<Object>

Returns:

query object
createQuery
()

Implements jakarta.persistence.criteria.CriteriaBuilder.createQuery.

Create a Criteria query object.
public <T> CriteriaQuery<T>

Returns:

query object
createQuery
(Class<T>
type of the query result
resultClass
)

Implements jakarta.persistence.criteria.CriteriaBuilder.createQuery.

Create a Criteria query object.
public CriteriaQuery<Tuple>

Returns:

query object
createTupleQuery
()

Implements jakarta.persistence.criteria.CriteriaBuilder.createTupleQuery.

Create a Criteria query object that returns a tuple of objects as its result.
public Expression<Date>

Returns:

expression for current date
currentDate
()

Implements jakarta.persistence.criteria.CriteriaBuilder.currentDate.

Create expression to return current date.
public Expression<Time>

Returns:

expression for current time
currentTime
()

Implements jakarta.persistence.criteria.CriteriaBuilder.currentTime.

Create expression to return current time.
public Expression<Timestamp>

Returns:

expression for current timestamp
currentTimestamp
()

Implements jakarta.persistence.criteria.CriteriaBuilder.currentTimestamp.

Create expression to return current timestamp.
public Order

Returns:

descending ordering corresponding to the expression
desc
(Expression<?>
expression used to define the ordering
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.desc.

Create an ordering by the descending value of the expression.
public <N extends Number> Expression<N>

Returns:

difference
diff
(Expression<? extends N>
expression
x
,
Expression<? extends N>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.diff, jakarta.persistence.criteria.CriteriaBuilder.diff, jakarta.persistence.criteria.CriteriaBuilder.diff.

Create an expression that returns the difference between its arguments.
public <N extends Number> Expression<N>

Returns:

difference
diff
(Expression<? extends N>
expression
x
,
N
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.diff.

Create an expression that returns the difference between its arguments.
public <N extends Number> Expression<N>

Returns:

difference
diff
(N
value
x
,
Expression<? extends N>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.diff.

Create an expression that returns the difference between its arguments.
public Predicate

Returns:

or predicate
disjunction
()

Implements jakarta.persistence.criteria.CriteriaBuilder.disjunction.

Create a disjunction (with zero disjuncts).
public Predicate

Returns:

equality predicate
equal
(Expression<?>
expression
x
,
Expression<?>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.equal.

Create a predicate for testing the arguments for equality.
public Predicate

Returns:

equality predicate
equal
(Expression<?>
expression
x
,
Object
object
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.equal.

Create a predicate for testing the arguments for equality.
public Predicate

Returns:

exists predicate
exists
(Subquery<?>
subquery whose result is to be tested
subquery
)

Implements jakarta.persistence.criteria.CriteriaBuilder.exists.

Create a predicate testing the existence of a subquery result.
public Expression<Double>

Returns:

exponential
exp
(Expression<? extends Number>
expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.exp.

Create an expression that returns the exponential of its argument, that is, Euler's number e raised to the power of its argument.
public <N extends Number> Expression<N>

Returns:

floor
floor
(Expression<N>
expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.floor.

Create an expression that returns the floor of its argument, that is, the largest integer smaller than or equal to its argument.
public <T> Expression<T>
fromExpression(Expression expression, Class<T> type)

Implements org.eclipse.persistence.jpa.JpaCriteriaBuilder.fromExpression.

ADVANCED: Allow a Criteria Expression to be built from a EclipseLink native API Expression object.
public Expression<T>
fromExpression(Expression expression)

Implements org.eclipse.persistence.jpa.JpaCriteriaBuilder.fromExpression.

ADVANCED: Allow a Criteria Expression to be built from a EclipseLink native API Expression object.
public <T> Expression<T>

Returns:

expression
function
(String
function name
name
,
Class<T>
expected result type
type
,
Expression<?>...
function arguments
args
)

Implements jakarta.persistence.criteria.CriteriaBuilder.function.

Create an expression for execution of a database function.
public Predicate

Returns:

greater-than-or-equal predicate
ge
(Expression<? extends Number>
expression
x
,
Expression<? extends Number>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.ge.

Create a predicate for testing whether the first argument is greater than or equal to the second.
public Predicate

Returns:

greater-than-or-equal predicate
ge
(Expression<? extends Number>
expression
x
,
Number
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.ge.

Create a predicate for testing whether the first argument is greater than or equal to the second.
public <Y extends Comparable<? super Y>> Predicate

Returns:

greater-than predicate
greaterThan
(Expression<? extends Y>
expression
x
,
Expression<? extends Y>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.greaterThan, jakarta.persistence.criteria.CriteriaBuilder.greaterThan.

Create a predicate for testing whether the first argument is greater than the second.
public <Y extends Comparable<? super Y>> Predicate

Returns:

greater-than predicate
greaterThan
(Expression<? extends Y>
expression
x
,
Y
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.greaterThan.

Create a predicate for testing whether the first argument is greater than the second.
public <Y extends Comparable<? super Y>> Predicate

Returns:

greater-than-or-equal predicate
greaterThanOrEqualTo
(Expression<? extends Y>
expression
x
,
Expression<? extends Y>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.greaterThanOrEqualTo, jakarta.persistence.criteria.CriteriaBuilder.greaterThanOrEqualTo.

Create a predicate for testing whether the first argument is greater than or equal to the second.
public <Y extends Comparable<? super Y>> Predicate

Returns:

greater-than-or-equal predicate
greaterThanOrEqualTo
(Expression<? extends Y>
expression
x
,
Y
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.greaterThanOrEqualTo.

Create a predicate for testing whether the first argument is greater than or equal to the second.
public <X extends Comparable<? super X>> Expression<X>

Returns:

greatest expression
greatest
(Expression<X>
expression representing input value to greatest operation
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.greatest.

Create an aggregate expression for finding the greatest of the values (strings, dates, etc).
public Predicate

Returns:

greater-than predicate
gt
(Expression<? extends Number>
expression
x
,
Expression<? extends Number>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.gt.

Create a predicate for testing whether the first argument is greater than the second.
public Predicate

Returns:

greater-than predicate
gt
(Expression<? extends Number>
expression
x
,
Number
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.gt.

Create a predicate for testing whether the first argument is greater than the second.
public <T> CriteriaBuilder.In<T>

Returns:

in predicate
in
(Expression<? extends T>
to be tested against list of values
expression
)

Implements jakarta.persistence.criteria.CriteriaBuilder.in.

Create predicate to test whether given expression is contained in a list of values.
protected <T> Expression<T>

Returns:

expression literal
internalLiteral
(T value)

Create an expression literal but without null validation.

public <C extends Collection<?>> Predicate

Returns:

predicate
isEmpty
(Expression<C>
expression
collection
)

Implements jakarta.persistence.criteria.CriteriaBuilder.isEmpty.

Create a predicate that tests whether a collection is empty.
public Predicate

Returns:

predicate
isFalse
(Expression<Boolean>
expression to be tested if false
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.isFalse.

Create a predicate testing for a false value.
public <E, C extends Collection<E>> Predicate

Returns:

predicate
isMember
(E
element
elem
,
Expression<C>
expression
collection
)

Implements jakarta.persistence.criteria.CriteriaBuilder.isMember.

Create a predicate that tests whether an element is a member of a collection.
public <E, C extends Collection<E>> Predicate

Returns:

predicate
isMember
(Expression<E>
element expression
elem
,
Expression<C>
expression
collection
)

Implements jakarta.persistence.criteria.CriteriaBuilder.isMember, jakarta.persistence.criteria.CriteriaBuilder.isMember.

Create a predicate that tests whether an element is a member of a collection.
public <C extends Collection<?>> Predicate

Returns:

predicate
isNotEmpty
(Expression<C>
expression
collection
)

Implements jakarta.persistence.criteria.CriteriaBuilder.isNotEmpty.

Create a predicate that tests whether a collection is not empty.
public <E, C extends Collection<E>> Predicate

Returns:

predicate
isNotMember
(E
element
elem
,
Expression<C>
expression
collection
)

Implements jakarta.persistence.criteria.CriteriaBuilder.isNotMember.

Create a predicate that tests whether an element is not a member of a collection.
public <E, C extends Collection<E>> Predicate

Returns:

predicate
isNotMember
(Expression<E>
element expression
elem
,
Expression<C>
expression
collection
)

Implements jakarta.persistence.criteria.CriteriaBuilder.isNotMember, jakarta.persistence.criteria.CriteriaBuilder.isNotMember.

Create a predicate that tests whether an element is not a member of a collection.
public Predicate

Returns:

predicate
isNotNull
(Expression<?>
expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.isNotNull.

Create a predicate to test whether the expression is not null.
public Predicate

Returns:

predicate
isNull
(Expression<?>
expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.isNull.

Create a predicate to test whether the expression is null.
public Predicate

Returns:

predicate
isTrue
(Expression<Boolean>
expression to be tested if true
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.isTrue.

Create a predicate testing for a true value.
public <K, M extends Map<K, ?>> Expression<Set<K>>

Returns:

set expression
keys
(M
map
map
)

Implements jakarta.persistence.criteria.CriteriaBuilder.keys.

Create an expression that returns the keys of a map.
public Predicate

Returns:

less-than-or-equal predicate
le
(Expression<? extends Number>
expression
x
,
Expression<? extends Number>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.le.

Create a predicate for testing whether the first argument is less than or equal to the second.
public Predicate

Returns:

less-than-or-equal predicate
le
(Expression<? extends Number>
expression
x
,
Number
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.le.

Create a predicate for testing whether the first argument is less than or equal to the second.
public <X extends Comparable<? super X>> Expression<X>

Returns:

least expression
least
(Expression<X>
expression representing input value to least operation
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.least.

Create an aggregate expression for finding the least of the values (strings, dates, etc).
public Expression<Integer>

Returns:

length expression
length
(Expression<String>
string expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.length.

Create expression to return length of a string.
public <Y extends Comparable<? super Y>> Predicate

Returns:

less-than predicate
lessThan
(Expression<? extends Y>
expression
x
,
Expression<? extends Y>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.lessThan, jakarta.persistence.criteria.CriteriaBuilder.lessThan.

Create a predicate for testing whether the first argument is less than the second.
public <Y extends Comparable<? super Y>> Predicate

Returns:

less-than predicate
lessThan
(Expression<? extends Y>
expression
x
,
Y
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.lessThan.

Create a predicate for testing whether the first argument is less than the second.
public <Y extends Comparable<? super Y>> Predicate

Returns:

less-than-or-equal predicate
lessThanOrEqualTo
(Expression<? extends Y>
expression
x
,
Expression<? extends Y>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.lessThanOrEqualTo, jakarta.persistence.criteria.CriteriaBuilder.lessThanOrEqualTo.

Create a predicate for testing whether the first argument is less than or equal to the second.
public <Y extends Comparable<? super Y>> Predicate

Returns:

less-than-or-equal predicate
lessThanOrEqualTo
(Expression<? extends Y>
expression
x
,
Y
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.lessThanOrEqualTo.

Create a predicate for testing whether the first argument is less than or equal to the second.
public Predicate

Returns:

like predicate
like
(Expression<String>
string expression
x
,
Expression<String>
string expression
pattern
)

Implements jakarta.persistence.criteria.CriteriaBuilder.like.

Create a predicate for testing whether the expression satisfies the given pattern.
public Predicate

Returns:

like predicate
like
(Expression<String>
string expression
x
,
Expression<String>
string expression
pattern
,
Expression<Character>
escape character expression
escapeChar
)

Implements jakarta.persistence.criteria.CriteriaBuilder.like.

Create a predicate for testing whether the expression satisfies the given pattern.
public Predicate

Returns:

like predicate
like
(Expression<String>
string expression
x
,
Expression<String>
string expression
pattern
,
char
escape character
escapeChar
)

Implements jakarta.persistence.criteria.CriteriaBuilder.like.

Create a predicate for testing whether the expression satisfies the given pattern.
public Predicate

Returns:

like predicate
like
(Expression<String>
string expression
x
,
String
string
pattern
)

Implements jakarta.persistence.criteria.CriteriaBuilder.like.

Create a predicate for testing whether the expression satisfies the given pattern.
public Predicate

Returns:

like predicate
like
(Expression<String>
string expression
x
,
String
string
pattern
,
Expression<Character>
escape character expression
escapeChar
)

Implements jakarta.persistence.criteria.CriteriaBuilder.like.

Create a predicate for testing whether the expression satisfies the given pattern.
public Predicate

Returns:

like predicate
like
(Expression<String>
string expression
x
,
String
string
pattern
,
char
escape character
escapeChar
)

Implements jakarta.persistence.criteria.CriteriaBuilder.like.

Create a predicate for testing whether the expression satisfies the given pattern.
public <T> Expression<T>

Returns:

expression literal
literal
(T
value represented by the expression
value
)

Implements jakarta.persistence.criteria.CriteriaBuilder.literal.

Create an expression literal.
public Expression<Double>

Returns:

natural logarithm
ln
(Expression<? extends Number>
expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.ln.

Create an expression that returns the natural logarithm of its argument.
public Expression<LocalDate>

Returns:

expression for local date
localDate
()

Implements jakarta.persistence.criteria.CriteriaBuilder.localDate.

Create expression to return local date.
public Expression<LocalDateTime>

Returns:

expression for local timestamp
localDateTime
()

Implements jakarta.persistence.criteria.CriteriaBuilder.localDateTime.

Create expression to return local datetime.
public Expression<LocalTime>

Returns:

expression for local time
localTime
()

Implements jakarta.persistence.criteria.CriteriaBuilder.localTime.

Create expression to return local time.
public Expression<Integer>

Returns:

expression corresponding to position
locate
(Expression<String>
expression for string to be searched
x
,
Expression<String>
expression for string to be located
pattern
)

Implements jakarta.persistence.criteria.CriteriaBuilder.locate.

Create expression to locate the position of one string within another, returning position of first character if found.
public Expression<Integer>

Returns:

expression corresponding to position
locate
(Expression<String>
expression for string to be searched
x
,
Expression<String>
expression for string to be located
pattern
,
Expression<Integer>
expression for position at which to start search
from
)

Implements jakarta.persistence.criteria.CriteriaBuilder.locate.

Create expression to locate the position of one string within another, returning position of first character if found.
public Expression<Integer>

Returns:

expression corresponding to position
locate
(Expression<String>
expression for string to be searched
x
,
String
string to be located
pattern
)

Implements jakarta.persistence.criteria.CriteriaBuilder.locate.

Create expression to locate the position of one string within another, returning position of first character if found.
public Expression<Integer>

Returns:

expression corresponding to position
locate
(Expression<String>
expression for string to be searched
x
,
String
string to be located
pattern
,
int
position at which to start search
from
)

Implements jakarta.persistence.criteria.CriteriaBuilder.locate.

Create expression to locate the position of one string within another, returning position of first character if found.
public Expression<String>

Returns:

expression to convert to lowercase
lower
(Expression<String>
string expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.lower.

Create expression for converting a string to lowercase.
public Predicate

Returns:

less-than predicate
lt
(Expression<? extends Number>
expression
x
,
Expression<? extends Number>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.lt.

Create a predicate for testing whether the first argument is less than the second.
public Predicate

Returns:

less-than predicate
lt
(Expression<? extends Number>
expression
x
,
Number
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.lt.

Create a predicate for testing whether the first argument is less than the second.
public <N extends Number> Expression<N>

Returns:

max expression
max
(Expression<N>
expression representing input value to max operation
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.max.

Create an expression applying the numerical max operation.
public <N extends Number> Expression<N>

Returns:

min expression
min
(Expression<N>
expression representing input value to min operation
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.min.

Create an expression applying the numerical min operation.
public Expression<Integer>

Returns:

modulus
mod
(Expression<Integer>
expression
x
,
Expression<Integer>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.mod.

Create an expression that returns the modulus of its arguments.
public Expression<Integer>

Returns:

modulus
mod
(Expression<Integer>
expression
x
,
Integer
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.mod.

Create an expression that returns the modulus of its arguments.
public Expression<Integer>

Returns:

modulus
mod
(Integer
value
x
,
Expression<Integer>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.mod.

Create an expression that returns the modulus of its arguments.
public <N extends Number> Expression<N>

Returns:

negated expression
neg
(Expression<N>
expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.neg.

Create an expression that returns the arithmetic negation of its argument.
public Predicate

Returns:

not predicate
not
(Expression<Boolean>
restriction expression
restriction
)

Implements jakarta.persistence.criteria.CriteriaBuilder.not.

Create a negation of the given restriction.
public Predicate

Returns:

inequality predicate
notEqual
(Expression<?>
expression
x
,
Expression<?>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.notEqual.

Create a predicate for testing the arguments for inequality.
public Predicate

Returns:

inequality predicate
notEqual
(Expression<?>
expression
x
,
Object
object
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.notEqual.

Create a predicate for testing the arguments for inequality.
public Predicate

Returns:

like predicate
notLike
(Expression<String>
string expression
x
,
Expression<String>
string expression
pattern
)

Implements jakarta.persistence.criteria.CriteriaBuilder.notLike.

Create a predicate for testing whether the expression does not satisfy the given pattern.
public Predicate

Returns:

like predicate
notLike
(Expression<String>
string expression
x
,
Expression<String>
string expression
pattern
,
Expression<Character>
escape character expression
escapeChar
)

Implements jakarta.persistence.criteria.CriteriaBuilder.notLike.

Create a predicate for testing whether the expression does not satisfy the given pattern.
public Predicate

Returns:

like predicate
notLike
(Expression<String>
string expression
x
,
Expression<String>
string expression
pattern
,
char
escape character
escapeChar
)

Implements jakarta.persistence.criteria.CriteriaBuilder.notLike.

Create a predicate for testing whether the expression does not satisfy the given pattern.
public Predicate

Returns:

like predicate
notLike
(Expression<String>
string expression
x
,
String
string
pattern
)

Implements jakarta.persistence.criteria.CriteriaBuilder.notLike.

Create a predicate for testing whether the expression does not satisfy the given pattern.
public Predicate

Returns:

like predicate
notLike
(Expression<String>
string expression
x
,
String
string
pattern
,
Expression<Character>
escape character expression
escapeChar
)

Implements jakarta.persistence.criteria.CriteriaBuilder.notLike.

Create a predicate for testing whether the expression does not satisfy the given pattern.
public Predicate

Returns:

like predicate
notLike
(Expression<String>
string expression
x
,
String
string
pattern
,
char
escape character
escapeChar
)

Implements jakarta.persistence.criteria.CriteriaBuilder.notLike.

Create a predicate for testing whether the expression does not satisfy the given pattern.
public <Y> Expression<Y>

Returns:

expression corresponding to the given nullif expression
nullif
(Expression<Y>
expression
x
,
Expression<?>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.nullif, jakarta.persistence.criteria.CriteriaBuilder.nullif.

Create an expression that tests whether its argument are equal, returning null if they are and the value of the first expression if they are not.
public <Y> Expression<Y>

Returns:

expression corresponding to the given nullif expression
nullif
(Expression<Y>
expression
x
,
Y
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.nullif.

Create an expression that tests whether its argument are equal, returning null if they are and the value of the first expression if they are not.
public <T> Expression<T>

Returns:

null expression literal
nullLiteral
(Class<T>
type of the null literal
resultClass
)

Implements jakarta.persistence.criteria.CriteriaBuilder.nullLiteral.

Create an expression for a null literal with the given type.
public Predicate

Returns:

or predicate
or
(Expression<Boolean>
boolean expression
x
,
Expression<Boolean>
boolean expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.or.

Create a disjunction of the given boolean expressions.
public Predicate

Returns:

and predicate
or
(Predicate...
zero or more restriction predicates
restrictions
)

Implements jakarta.persistence.criteria.CriteriaBuilder.or.

Create a disjunction of the given restriction predicates.
public <T> ParameterExpression<T>

Returns:

parameter expression
parameter
(Class<T>
parameter class
paramClass
)

Implements jakarta.persistence.criteria.CriteriaBuilder.parameter.

Create a parameter.
public <T> ParameterExpression<T>

Returns:

parameter
parameter
(Class<T>
parameter class
paramClass
,
String
name that can be used to refer to the parameter
name
)

Implements jakarta.persistence.criteria.CriteriaBuilder.parameter.

Create a parameter expression with the given name.
public Expression<Double>

Returns:

the base raised to the power of the exponent
power
(Expression<? extends Number>
base
x
,
Expression<? extends Number>
exponent
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.power.

Create an expression that returns the first argument raised to the power of its second argument.
public Expression<Double>

Returns:

the base raised to the power of the exponent
power
(Expression<? extends Number>
base
x
,
Number
exponent
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.power.

Create an expression that returns the first argument raised to the power of its second argument.
public <N extends Number> Expression<N>

Returns:

product
prod
(Expression<? extends N>
expression
x
,
Expression<? extends N>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.prod, jakarta.persistence.criteria.CriteriaBuilder.prod, jakarta.persistence.criteria.CriteriaBuilder.prod.

Create an expression that returns the product of its arguments.
public <N extends Number> Expression<N>

Returns:

product
prod
(Expression<? extends N>
expression
x
,
N
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.prod.

Create an expression that returns the product of its arguments.
public <N extends Number> Expression<N>

Returns:

product
prod
(N
value
x
,
Expression<? extends N>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.prod.

Create an expression that returns the product of its arguments.
public Expression<Number>

Returns:

quotient
quot
(Expression<? extends Number>
expression
x
,
Expression<? extends Number>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.quot.

Create an expression that returns the quotient of its arguments.
public Expression<Number>

Returns:

quotient
quot
(Expression<? extends Number>
expression
x
,
Number
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.quot.

Create an expression that returns the quotient of its arguments.
public Expression<Number>

Returns:

quotient
quot
(Number
value
x
,
Expression<? extends Number>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.quot.

Create an expression that returns the quotient of its arguments.
public <T extends Number> Expression<T>

Returns:

the rounded value
round
(Expression<T>
base
x
,
Integer
number of decimal places
n
)

Implements jakarta.persistence.criteria.CriteriaBuilder.round.

Create an expression that returns the first argument rounded to the number of decimal places given by the second argument.
public <C, R> CriteriaBuilder.SimpleCase<C, R>

Returns:

simple case expression
selectCase
(Expression<? extends C>
to be tested against the case conditions
expression
)

Implements jakarta.persistence.criteria.CriteriaBuilder.selectCase.

Create simple case expression.
public <R> CriteriaBuilder.Case<R>

Returns:

general case expression
selectCase
()

Implements jakarta.persistence.criteria.CriteriaBuilder.selectCase.

Create a general case expression.
public Expression<Integer>

Returns:

sign
sign
(Expression<? extends Number>
expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.sign.

Create an expression that returns the sign of its argument, that is, 1 if its argument is positive, -1 if its argument is negative, or 0 if its argument is exactly zero.
public <C extends Collection<?>> Expression<Integer>

Returns:

size expression
size
(C
collection
collection
)

Implements jakarta.persistence.criteria.CriteriaBuilder.size.

Create an expression that tests the size of a collection.
public <C extends Collection<?>> Expression<Integer>

Returns:

size expression
size
(Expression<C>
expression
collection
)

Implements jakarta.persistence.criteria.CriteriaBuilder.size, jakarta.persistence.criteria.CriteriaBuilder.size.

Create an expression that tests the size of a collection.
public <Y> Expression<Y>

Returns:

all expression
some
(Subquery<Y>
subquery
subquery
)

Implements jakarta.persistence.criteria.CriteriaBuilder.some.

Create a predicate corresponding to a some expression over the subquery results.
public Expression<Double>

Returns:

modulus
sqrt
(Expression<? extends Number>
expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.sqrt.

Create an expression that returns the square root of its argument.
public Expression<String>

Returns:

expression corresponding to substring extraction
substring
(Expression<String>
string expression
x
,
Expression<Integer>
start position expression
from
)

Implements jakarta.persistence.criteria.CriteriaBuilder.substring.

Substring extraction operation.
public Expression<String>

Returns:

expression corresponding to substring extraction
substring
(Expression<String>
string expression
x
,
int
start position
from
)

Implements jakarta.persistence.criteria.CriteriaBuilder.substring.

Substring extraction operation.
public Expression<String>

Returns:

expression corresponding to substring extraction
substring
(Expression<String>
string expression
x
,
Expression<Integer>
start position expression
from
,
Expression<Integer>
length expression
len
)

Implements jakarta.persistence.criteria.CriteriaBuilder.substring.

Substring extraction operation.
public Expression<String>

Returns:

expression corresponding to substring extraction
substring
(Expression<String>
string expression
x
,
int
start position
from
,
int
length
len
)

Implements jakarta.persistence.criteria.CriteriaBuilder.substring.

Substring extraction operation.
public <N extends Number> Expression<N>

Returns:

sum expression
sum
(Expression<N>
expression representing input value to sum operation
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.sum.

Create an expression applying the sum operation.
public <N extends Number> Expression<N>

Returns:

sum
sum
(Expression<? extends N>
expression
x
,
Expression<? extends N>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.sum, jakarta.persistence.criteria.CriteriaBuilder.sum, jakarta.persistence.criteria.CriteriaBuilder.sum.

Create an expression that returns the sum of its arguments.
public <N extends Number> Expression<N>

Returns:

sum
sum
(Expression<? extends N>
expression
x
,
N
value
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.sum.

Create an expression that returns the sum of its arguments.
public <N extends Number> Expression<N>

Returns:

sum
sum
(N
value
x
,
Expression<? extends N>
expression
y
)

Implements jakarta.persistence.criteria.CriteriaBuilder.sum.

Create an expression that returns the sum of its arguments.
public Expression<Double>

Returns:

sum expression
sumAsDouble
(Expression<Float>
expression representing input value to sum operation
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.sumAsDouble.

Create an aggregate expression applying the sum operation to a Float-valued expression, returning a Double result.
public Expression<Long>

Returns:

sum expression
sumAsLong
(Expression<Integer>
expression representing input value to sum operation
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.sumAsLong.

Create an aggregate expression applying the sum operation to an Integer-valued expression, returning a Long result.
public Expression<BigDecimal>

Returns:

Expression<BigDecimal>
toBigDecimal
(Expression<? extends Number>
numeric expression
number
)

Implements jakarta.persistence.criteria.CriteriaBuilder.toBigDecimal.

Typecast.
public Expression<BigInteger>

Returns:

Expression<BigInteger>
toBigInteger
(Expression<? extends Number>
numeric expression
number
)

Implements jakarta.persistence.criteria.CriteriaBuilder.toBigInteger.

Typecast.
public Expression<Double>

Returns:

Expression<Double>
toDouble
(Expression<? extends Number>
numeric expression
number
)

Implements jakarta.persistence.criteria.CriteriaBuilder.toDouble.

Typecast.
public Expression
toExpression(Expression<T> expression)

Implements org.eclipse.persistence.jpa.JpaCriteriaBuilder.toExpression.

ADVANCED: Allow a Criteria Expression to be converted to a EclipseLink native API Expression object.
public Expression<Float>

Returns:

Expression<Float>
toFloat
(Expression<? extends Number>
numeric expression
number
)

Implements jakarta.persistence.criteria.CriteriaBuilder.toFloat.

Typecast.
public Expression<Integer>

Returns:

Expression<Integer>
toInteger
(Expression<? extends Number>
numeric expression
number
)

Implements jakarta.persistence.criteria.CriteriaBuilder.toInteger.

Typecast.
public Expression<Long>

Returns:

Expression<Long>
toLong
(Expression<? extends Number>
numeric expression
number
)

Implements jakarta.persistence.criteria.CriteriaBuilder.toLong.

Typecast.
public Expression<String>

Returns:

Expression<String>
toString
(Expression<Character>
expression
character
)

Implements jakarta.persistence.criteria.CriteriaBuilder.toString.

Typecast.
public <X, T, V extends T> Join<X, V>
treat(Join<X, T>
Join object
join
,
Class<V>
type to be downcast to
type
)

Implements jakarta.persistence.criteria.CriteriaBuilder.treat.

Downcast Join object to the specified type.
public <X, T, E extends T> CollectionJoin<X, E>
treat(CollectionJoin<X, T>
CollectionJoin object
join
,
Class<E>
type to be downcast to
type
)

Implements jakarta.persistence.criteria.CriteriaBuilder.treat.

Downcast CollectionJoin object to the specified type.
public <X, T, E extends T> SetJoin<X, E>
treat(SetJoin<X, T>
SetJoin object
join
,
Class<E>
type to be downcast to
type
)

Implements jakarta.persistence.criteria.CriteriaBuilder.treat.

Downcast SetJoin object to the specified type.
public <X, T, E extends T> ListJoin<X, E>
treat(ListJoin<X, T>
ListJoin object
join
,
Class<E>
type to be downcast to
type
)

Implements jakarta.persistence.criteria.CriteriaBuilder.treat.

Downcast ListJoin object to the specified type.
public <X, K, T, V extends T> MapJoin<X, K, V>
treat(MapJoin<X, K, T>
MapJoin object
join
,
Class<V>
type to be downcast to
type
)

Implements jakarta.persistence.criteria.CriteriaBuilder.treat.

Downcast MapJoin object to the specified type.
public <X, T extends X> Path<T>
treat(Path<X>
path
path
,
Class<T>
type to be downcast to
type
)

Implements jakarta.persistence.criteria.CriteriaBuilder.treat.

Downcast Path object to the specified type.
public <X, T extends X> Root<T>
treat(Root<X>
root
root
,
Class<T>
type to be downcast to
type
)

Implements jakarta.persistence.criteria.CriteriaBuilder.treat.

Downcast Root object to the specified type.
public Expression<String>

Returns:

trim expression
trim
(Expression<String>
expression for string to trim
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.trim.

Create expression to trim blanks from both ends of a string.
public Expression<String>

Returns:

trim expression
trim
(CriteriaBuilder.Trimspec
trim specification
ts
,
Expression<String>
expression for string to trim
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.trim.

Create expression to trim blanks from a string.
public Expression<String>

Returns:

trim expression
trim
(Expression<Character>
expression for character to be trimmed
t
,
Expression<String>
expression for string to trim
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.trim.

Create expression to trim character from both ends of a string.
public Expression<String>

Returns:

trim expression
trim
(CriteriaBuilder.Trimspec
trim specification
ts
,
Expression<Character>
expression for character to be trimmed
t
,
Expression<String>
expression for string to trim
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.trim.

Create expression to trim character from a string.
public Expression<String>

Returns:

trim expression
trim
(char
character to be trimmed
t
,
Expression<String>
expression for string to trim
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.trim.

Create expression to trim character from both ends of a string.
public Expression<String>

Returns:

trim expression
trim
(CriteriaBuilder.Trimspec
trim specification
ts
,
char
character to be trimmed
t
,
Expression<String>
expression for string to trim
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.trim.

Create expression to trim character from a string.
public CompoundSelection<Tuple>
tuple(Selection<?>...
selection items
selections
)

Implements jakarta.persistence.criteria.CriteriaBuilder.tuple.

Create a tuple-valued selection item.
public Expression<String>

Returns:

expression to convert to uppercase
upper
(Expression<String>
string expression
x
)

Implements jakarta.persistence.criteria.CriteriaBuilder.upper.

Create expression for converting a string to uppercase.
public <V, M extends Map<?, V>> Expression<Collection<V>>

Returns:

collection expression
values
(M
map
map
)

Implements jakarta.persistence.criteria.CriteriaBuilder.values.

Create an expression that returns the values of a map.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait