Top Description Methods
javax.persistence.criteria

public Interface CriteriaUpdate<T>

extends CommonAbstractCriteria
Type Parameters
<T>
the entity type that is the target of the update
Imports
javax.persistence.metamodel.SingularAttribute, .EntityType
The CriteriaUpdate interface defines functionality for performing bulk update operations using the Criteria API.

Criteria API bulk update operations map directly to database update operations, bypassing any optimistic locking checks. Portable applications using bulk update operations must manually update the value of the version column, if desired, and/or manually validate the value of the version column. The persistence context is not synchronized with the result of the bulk update.

A CriteriaUpdate object must have a single root.

Since
Java Persistence 2.1

Method Summary

Modifier and TypeMethod and Description
public Root<T>

Returns:

query root corresponding to the given entity
from(Class<T>
the entity class
entityClass)

Create and add a query root corresponding to the entity that is the target of the update.

public Root<T>

Returns:

query root corresponding to the given entity
from(EntityType<T>
metamodel entity representing the entity of type X
entity)

Create and add a query root corresponding to the entity that is the target of the update.

public Root<T>

Returns:

the query root
getRoot()

Return the query root.

public <Y, X extends Y> CriteriaUpdate<T>

Returns:

the modified update query
set(SingularAttribute<? super T, Y>
attribute to be updated
attribute, X
new value
value)

Update the value of the specified attribute.

public <Y> CriteriaUpdate<T>

Returns:

the modified update query
set(SingularAttribute<? super T, Y>
attribute to be updated
attribute, Expression<? extends Y>
new value
value)

Update the value of the specified attribute.

public <Y, X extends Y> CriteriaUpdate<T>

Returns:

the modified update query
set(Path<Y>
attribute to be updated
attribute, X
new value
value)

Update the value of the specified attribute.

public <Y> CriteriaUpdate<T>

Returns:

the modified update query
set(Path<Y>
attribute to be updated
attribute, Expression<? extends Y>
new value
value)

Update the value of the specified attribute.

public CriteriaUpdate<T>

Returns:

the modified update query
set(String
name of the attribute to be updated
attributeName, Object
new value
value)

Update the value of the specified attribute.

public CriteriaUpdate<T>

Returns:

the modified update query
where(Expression<Boolean>
a simple or compound boolean expression
restriction)

Modify the update query to restrict the target of the update according to the specified boolean expression.

public CriteriaUpdate<T>

Returns:

the modified update query
where(Predicate...
zero or more restriction predicates
restrictions)

Modify the update query to restrict the target of the update according to the conjunction of the specified restriction predicates.

Inherited from javax.persistence.criteria.CommonAbstractCriteria:
getRestrictionsubquery

Method Detail

fromback to summary
public Root<T> from(Class<T> entityClass)

Create and add a query root corresponding to the entity that is the target of the update. A CriteriaUpdate object has a single root, the entity that is being updated.

Parameters
entityClass:Class<T>

the entity class

Returns:Root<T>

query root corresponding to the given entity

fromback to summary
public Root<T> from(EntityType<T> entity)

Create and add a query root corresponding to the entity that is the target of the update. A CriteriaUpdate object has a single root, the entity that is being updated.

Parameters
entity:EntityType<T>

metamodel entity representing the entity of type X

Returns:Root<T>

query root corresponding to the given entity

getRootback to summary
public Root<T> getRoot()

Return the query root.

Returns:Root<T>

the query root

setback to summary
public <Y, X extends Y> CriteriaUpdate<T> set(SingularAttribute<? super T, Y> attribute, X value)

Update the value of the specified attribute.

Parameters
attribute:SingularAttribute<? super T, Y>

attribute to be updated

value:X

new value

Returns:CriteriaUpdate<T>

the modified update query

setback to summary
public <Y> CriteriaUpdate<T> set(SingularAttribute<? super T, Y> attribute, Expression<? extends Y> value)

Update the value of the specified attribute.

Parameters
attribute:SingularAttribute<? super T, Y>

attribute to be updated

value:Expression<? extends Y>

new value

Returns:CriteriaUpdate<T>

the modified update query

setback to summary
public <Y, X extends Y> CriteriaUpdate<T> set(Path<Y> attribute, X value)

Update the value of the specified attribute.

Parameters
attribute:Path<Y>

attribute to be updated

value:X

new value

Returns:CriteriaUpdate<T>

the modified update query

setback to summary
public <Y> CriteriaUpdate<T> set(Path<Y> attribute, Expression<? extends Y> value)

Update the value of the specified attribute.

Parameters
attribute:Path<Y>

attribute to be updated

value:Expression<? extends Y>

new value

Returns:CriteriaUpdate<T>

the modified update query

setback to summary
public CriteriaUpdate<T> set(String attributeName, Object value)

Update the value of the specified attribute.

Parameters
attributeName:String

name of the attribute to be updated

value:Object

new value

Returns:CriteriaUpdate<T>

the modified update query

whereback to summary
public CriteriaUpdate<T> where(Expression<Boolean> restriction)

Modify the update query to restrict the target of the update according to the specified boolean expression. Replaces the previously added restriction(s), if any.

Parameters
restriction:Expression<Boolean>

a simple or compound boolean expression

Returns:CriteriaUpdate<T>

the modified update query

whereback to summary
public CriteriaUpdate<T> where(Predicate... restrictions)

Modify the update query to restrict the target of the update according to the conjunction of the specified restriction predicates. Replaces the previously added restriction(s), if any. If no restrictions are specified, any previously added restrictions are simply removed.

Parameters
restrictions:Predicate[]

zero or more restriction predicates

Returns:CriteriaUpdate<T>

the modified update query