https://github.com/javaee/jpa-spec: Java(TM) Persistence API 
Copyright (c) 2011 - 2013 Oracle Corporation. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
which accompanies this distribution.
The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
and the Eclipse Distribution License is available at
http://www.eclipse.org/org/documents/edl-v10.php.
Contributors:
    Linda DeMichiel - Java Persistence 2.1

/*******************************************************************************
 * Copyright (c) 2011 - 2013 Oracle Corporation. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     Linda DeMichiel - Java Persistence 2.1
 *
 ******************************************************************************/ 
package javax.persistence.criteria;

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

Type parameters:
  • <T> –  the entity type that is the target of the delete
Since:Java Persistence 2.1
/**
 * The <code>CriteriaDelete</code> interface defines functionality for performing
 * bulk delete operations using the Criteria API
 *
 * <p>Criteria API bulk delete operations map directly to database 
 * delete operations.  The persistence context is not synchronized 
 * with the result of the bulk delete.
 *
 * <p> A <code>CriteriaDelete</code> object must have a single root.
 *
 * @param <T>  the entity type that is the target of the delete
 *
 * @since Java Persistence 2.1
 */
public interface CriteriaDelete<T> extends CommonAbstractCriteria {


    
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.

Params:
  • entityClass –  the entity class
Returns:query root corresponding to the given entity
/**
     * Create and add a query root corresponding to the entity
     * that is the target of the delete.
     * A <code>CriteriaDelete</code> object has a single root, the entity that 
     * is being deleted.
     * @param entityClass  the entity class
     * @return query root corresponding to the given entity
     */
    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.

Params:
  • entity –  metamodel entity representing the entity
               of type X
Returns:query root corresponding to the given entity
/**
     * Create and add a query root corresponding to the entity
     * that is the target of the delete.
     * A <code>CriteriaDelete</code> object has a single root, the entity that 
     * is being deleted.
     * @param entity  metamodel entity representing the entity
     *                of type X
     * @return query root corresponding to the given entity
     */
    Root<T> from(EntityType<T> entity);

   
Return the query root.

Returns:the query root
/**
    * Return the query root.
    * @return the query root
    */
   Root<T> getRoot();

    
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.

Params:
  • restriction –  a simple or compound boolean expression
Returns:the modified delete query
/**
     * 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.
     * @param restriction  a simple or compound boolean expression
     * @return the modified delete query
     */    
   CriteriaDelete<T> where(Expression<Boolean> restriction);

    
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.

Params:
  • restrictions –  zero or more restriction predicates
Returns:the modified delete query
/**
     * 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.
     * @param restrictions  zero or more restriction predicates
     * @return the modified delete query
     */
   CriteriaDelete<T> where(Predicate... restrictions);

}