Module jakarta.persistence

Package jakarta.persistence.criteria

Interface Expression<T>

Type Parameters:

T - the type of the expression

All Superinterfaces:

Selection<T>, TupleElement<T>

All Known Subinterfaces:

CollectionJoin<Z,E>, CriteriaBuilder.Case<R>, CriteriaBuilder.Coalesce<T>, CriteriaBuilder.In<T>, CriteriaBuilder.SimpleCase<C,R>, From<Z,X>, Join<Z,X>, ListJoin<Z,E>, MapJoin<Z,K,V>, ParameterExpression<T>, Path<X>, PluralJoin<Z,C,E>, Predicate, Root<X>, SetJoin<Z,E>, Subquery<T>

public interface Expression<T>
extends Selection<T>

Type for query expressions.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
<X> Expression<X>	as(java.lang.Class<X> type)	Perform a typecast upon the expression, returning a new expression object.
<X> Expression<X>	cast(java.lang.Class<X> type)	Cast this expression to the specified type, returning a new expression object.
Predicate	equalTo(Expression<?> value)	Create a predicate to test whether the expression is equal to the argument.
Predicate	equalTo(java.lang.Object value)	Create a predicate to test whether the expression is equal to the argument.
Predicate	in(Expression<?>... values)	Create a predicate to test whether the expression is a member of the argument list.
Predicate	in(Expression<java.util.Collection<?>> values)	Create a predicate to test whether the expression is a member of the collection.
Predicate	in(java.lang.Object... values)	Create a predicate to test whether the expression is a member of the argument list.
Predicate	in(java.util.Collection<?> values)	Create a predicate to test whether the expression is a member of the collection.
Predicate	isNotNull()	Create a predicate to test whether the expression is not null.
Predicate	isNull()	Create a predicate to test whether the expression is null.
Predicate	notEqualTo(Expression<?> value)	Create a predicate to test whether the expression is unequal to the argument.
Predicate	notEqualTo(java.lang.Object value)	Create a predicate to test whether the expression is unequal to the argument.

Methods inherited from interface jakarta.persistence.criteria.Selection

alias, getCompoundSelectionItems, isCompoundSelection

Methods inherited from interface jakarta.persistence.TupleElement

getAlias, getJavaType

Method Detail

isNull

Predicate isNull()

Create a predicate to test whether the expression is null.

Returns:

predicate testing whether the expression is null

isNotNull

Predicate isNotNull()

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

Returns:

predicate testing whether the expression is not null

equalTo

Predicate equalTo(Expression<?> value)

Create a predicate to test whether the expression is equal to the argument.

Parameters:

value - expression to be tested against

Returns:

predicate testing for equality

Since:

3.2

equalTo

Predicate equalTo(java.lang.Object value)

Create a predicate to test whether the expression is equal to the argument.

Parameters:

value - value to be tested against

Returns:

predicate testing for equality

Since:

3.2

notEqualTo

Predicate notEqualTo(Expression<?> value)

Create a predicate to test whether the expression is unequal to the argument.

Parameters:

value - expression to be tested against

Returns:

predicate testing for inequality

Since:

3.2

notEqualTo

Predicate notEqualTo(java.lang.Object value)

Create a predicate to test whether the expression is unequal to the argument.

Parameters:

value - value to be tested against

Returns:

predicate testing for inequality

Since:

3.2

in

Predicate in(java.lang.Object... values)

Create a predicate to test whether the expression is a member of the argument list.

Parameters:

values - values to be tested against

Returns:

predicate testing for membership

in

Predicate in(Expression<?>... values)

Create a predicate to test whether the expression is a member of the argument list.

Parameters:

values - expressions to be tested against

Returns:

predicate testing for membership

in

Predicate in(java.util.Collection<?> values)

Create a predicate to test whether the expression is a member of the collection.

Parameters:

values - collection of values to be tested against

Returns:

predicate testing for membership

in

Predicate in(Expression<java.util.Collection<?>> values)

Create a predicate to test whether the expression is a member of the collection.

Parameters:

values - expression corresponding to collection to be tested against

Returns:

predicate testing for membership

as

<X> Expression<X> as(java.lang.Class<X> type)

Perform a typecast upon the expression, returning a new expression object. Unlike cast(Class), this method does not cause type conversion: the runtime type is not changed.

Warning: may result in a runtime failure.

Parameters:

type - intended type of the expression

Returns:

new expression of the given type

See Also:

cast(Class)

cast

<X> Expression<X> cast(java.lang.Class<X> type)

Cast this expression to the specified type, returning a new expression object. Unlike as(Class), this method does result in a runtime type conversion.

Providers are required to support casting scalar expressions to String, and String expressions to Integer, Long, Float, and Double. Support for typecasts between other basic types is not required.

Parameters:

type - a basic type

Returns:

a scalar expression of the given basic type

Since:

3.2