Top Description Methods
javax.persistence.criteria

public Interface CriteriaDelete<T>

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

Criteria API bulk delete operations map directly to database delete operations. The persistence context is not synchronized with the result of the bulk delete.

A CriteriaDelete 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 delete.

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 delete.

public Root<T>

Returns:

the query root
getRoot()

Return the query root.

public CriteriaDelete<T>

Returns:

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

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

public CriteriaDelete<T>

Returns:

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

Modify the delete query to restrict the target of the deletion 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 delete. A CriteriaDelete object has a single root, the entity that is being deleted.

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 delete. A CriteriaDelete object has a single root, the entity that is being deleted.

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

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

Modify the delete query to restrict the target of the deletion 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:CriteriaDelete<T>

the modified delete query

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

Modify the delete query to restrict the target of the deletion 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:CriteriaDelete<T>

the modified delete query