Jakarta Persistence (JPA) Interface

jakarta.persistence.criteria.CriteriaBuilder.In<T>

Super Interfaces:
Predicate, Expression<Boolean>, Selection<T>, TupleElement<X>
Interface used to build in predicates.
Since:
Jakarta Persistence (JPA) 1.0

Public Instance Methods

Selection<X> alias(String name)
Assigns an alias to the selection item.
Once assigned, an alias cannot be changed or reassigned. Returns the same selection item.
Inherited from Selection<X>
Parameters:
name - alias
Returns:
selection item.
Since:
Jakarta Persistence (JPA) 1.0
Expression<X> as(Class<X> type)
Perform a typecast upon the expression, returning a new expression object.
Unlike Expression.cast, this method does not cause type conversion: the runtime type is not changed.

Warning: may result in a runtime failure.

Inherited from Expression<T>
Parameters:
type - intended type of the expression
Returns:
new expression of the given type.
See Also:
Since:
Jakarta Persistence (JPA) 1.0
Expression<X> cast(Class<X> type)
Cast this expression to the specified type, returning a new expression object.
Unlike Expression.as, 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.

Inherited from Expression<T>
Parameters:
type - a basic type
Returns:
a scalar expression of the given basic type.
Since:
Jakarta Persistence (JPA) 3.2
Predicate equalTo(Expression<?> value)
Create a predicate to test whether the expression is equal to the argument.
Inherited from Expression<T>
Parameters:
value - expression to be tested against
Returns:
predicate testing for equality.
Since:
Jakarta Persistence (JPA) 3.2
Predicate equalTo(Object value)
Create a predicate to test whether the expression is equal to the argument.
Inherited from Expression<T>
Parameters:
value - value to be tested against
Returns:
predicate testing for equality.
Since:
Jakarta Persistence (JPA) 3.2
String getAlias()
Return the alias assigned to the tuple element or null, if no alias has been assigned.
Inherited from TupleElement<X>
Returns:
alias.
Since:
Jakarta Persistence (JPA) 1.0
List<Selection<?>> getCompoundSelectionItems()
Return the selection items composing a compound selection.
Modifications to the list do not affect the query.
Inherited from Selection<X>
Returns:
list of selection items.
Throws:
IllegalStateException - if selection is not a compound selection.
Since:
Jakarta Persistence (JPA) 1.0
Expression<T> getExpression()
Return the expression to be tested against the list of values.
Returns:
expression.
Since:
Jakarta Persistence (JPA) 1.0
List<Expression<Boolean>> getExpressions()
Return the top-level conjuncts or disjuncts of the predicate.
Returns empty list if there are no top-level conjuncts or disjuncts of the predicate. Modifications to the list do not affect the query.
Inherited from Predicate
Returns:
list of boolean expressions forming the predicate.
Since:
Jakarta Persistence (JPA) 1.0
Class<? extends X> getJavaType()
Return the Java type of the tuple element.
Inherited from TupleElement<X>
Returns:
the Java type of the tuple element.
Since:
Jakarta Persistence (JPA) 1.0
BooleanOperator getOperator()
Return the boolean operator for the predicate.
If the predicate is simple, this is AND.
Inherited from Predicate
Returns:
boolean operator for the predicate.
Since:
Jakarta Persistence (JPA) 1.0
Predicate in(Object... values)
Create a predicate to test whether the expression is a member of the argument list.
Inherited from Expression<T>
Parameters:
values - values to be tested against
Returns:
predicate testing for membership.
Since:
Jakarta Persistence (JPA) 1.0
Predicate in(Expression<?>... values)
Create a predicate to test whether the expression is a member of the argument list.
Inherited from Expression<T>
Parameters:
values - expressions to be tested against
Returns:
predicate testing for membership.
Since:
Jakarta Persistence (JPA) 1.0
Predicate in(Collection<?> values)
Create a predicate to test whether the expression is a member of the collection.
Inherited from Expression<T>
Parameters:
values - collection of values to be tested against
Returns:
predicate testing for membership.
Since:
Jakarta Persistence (JPA) 1.0
Predicate in(Expression<Collection<?>> values)
Create a predicate to test whether the expression is a member of the collection.
Inherited from Expression<T>
Parameters:
values - expression corresponding to collection to be tested against
Returns:
predicate testing for membership.
Since:
Jakarta Persistence (JPA) 1.0
boolean isCompoundSelection()
Whether the selection item is a compound selection.
Inherited from Selection<X>
Returns:
boolean indicating whether the selection is a compound selection.
Since:
Jakarta Persistence (JPA) 1.0
boolean isNegated()
Whether the predicate has been created from another predicate by applying Predicate.not or by calling CriteriaBuilder.not.
Inherited from Predicate
Returns:
boolean indicating if the predicate is a negated predicate.
Since:
Jakarta Persistence (JPA) 1.0
Predicate isNotNull()
Create a predicate to test whether the expression is not null.
Inherited from Expression<T>
Returns:
predicate testing whether the expression is not null.
Since:
Jakarta Persistence (JPA) 1.0
Predicate isNull()
Create a predicate to test whether the expression is null.
Inherited from Expression<T>
Returns:
predicate testing whether the expression is null.
Since:
Jakarta Persistence (JPA) 1.0
Predicate not()
Create a negation of the predicate.
Inherited from Predicate
Returns:
negated predicate.
Since:
Jakarta Persistence (JPA) 1.0
Predicate notEqualTo(Expression<?> value)
Create a predicate to test whether the expression is unequal to the argument.
Inherited from Expression<T>
Parameters:
value - expression to be tested against
Returns:
predicate testing for inequality.
Since:
Jakarta Persistence (JPA) 3.2
Predicate notEqualTo(Object value)
Create a predicate to test whether the expression is unequal to the argument.
Inherited from Expression<T>
Parameters:
value - value to be tested against
Returns:
predicate testing for inequality.
Since:
Jakarta Persistence (JPA) 3.2
In<T> value(T value)
Add to list of values to be tested against.
Parameters:
value - value
Returns:
in predicate.
Since:
Jakarta Persistence (JPA) 1.0
In<T> value(Expression<? extends T> value)
Add to list of values to be tested against.
Parameters:
value - expression
Returns:
in predicate.
Since:
Jakarta Persistence (JPA) 1.0