Package org.hibernate.query.specification

Interface DeleteSpecification<T>

Type Parameters:

T - The entity type which is the target of the mutation.

All Superinterfaces:

MutationSpecification<T>, QuerySpecification<T>

@Incubating
public interface DeleteSpecification<T>
extends MutationSpecification<T>

Specialization of MutationSpecification for programmatic customization of delete queries.

Since:

7.2

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.query.specification.MutationSpecification

MutationSpecification.Augmentation<T>

Method Summary

Modifier and Type	Method	Description
DeleteSpecification<T>	augment(MutationSpecification.Augmentation<T> augmentation)	Add an augmentation to the specification.
static <T> DeleteSpecification<T>	create(CriteriaDelete<T> criteriaDelete)	Returns a specification reference which can be used to programmatically, iteratively build a MutationQuery based on the given criteria delete, allowing the addition of restrictions.
static <T> DeleteSpecification<T>	create(Class<T> targetEntityClass)	Returns a specification reference which can be used to programmatically, iteratively build a MutationQuery which deletes the given entity type.
DeleteSpecification<T>	restrict(Restriction<? super T> restriction)	Adds a restriction to the query specification.
DeleteSpecification<T>	validate(CriteriaBuilder builder)	Validate the query.

Methods inherited from interface org.hibernate.query.specification.MutationSpecification

createQuery, createQuery, reference

Methods inherited from interface org.hibernate.query.specification.QuerySpecification

buildCriteria, createQuery

Method Details

restrict

DeleteSpecification<T> restrict(Restriction<? super T> restriction)

Description copied from interface: QuerySpecification

Adds a restriction to the query specification.

Specified by:

restrict in interface MutationSpecification<T>

Specified by:

restrict in interface QuerySpecification<T>

Parameters:

restriction - The restriction predicate to be added.

Returns:

this for method chaining.

augment

DeleteSpecification<T> augment(MutationSpecification.Augmentation<T> augmentation)

Description copied from interface: MutationSpecification

Add an augmentation to the specification.

Specified by:

augment in interface MutationSpecification<T>

Parameters:

augmentation - A function capable of modifying or augmenting a criteria query.

Returns:

this for method chaining.

validate

DeleteSpecification<T> validate(CriteriaBuilder builder)

Description copied from interface: QuerySpecification

Validate the query.

Specified by:

validate in interface MutationSpecification<T>

Specified by:

validate in interface QuerySpecification<T>

Returns:

this if everything is fine

create

static <T> DeleteSpecification<T> create(Class<T> targetEntityClass)

Returns a specification reference which can be used to programmatically, iteratively build a MutationQuery which deletes the given entity type.

Type Parameters:

T - The root entity type for the mutation (the "target").

Parameters:

targetEntityClass - The target entity type

create

static <T> DeleteSpecification<T> create(CriteriaDelete<T> criteriaDelete)

Returns a specification reference which can be used to programmatically, iteratively build a MutationQuery based on the given criteria delete, allowing the addition of restrictions.

Type Parameters:

T - The root entity type for the mutation (the "target").

Parameters:

criteriaDelete - The criteria delete query