Package org.springframework.data.jpa.domain

Interface DeleteSpecification<T>

All Superinterfaces:

Serializable

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface DeleteSpecification<T>
extends Serializable

Specification in the sense of Domain Driven Design to handle Criteria Deletes.

Specifications can be composed into higher order functions from other specifications using and(DeleteSpecification), or(DeleteSpecification) or factory methods such as allOf(Iterable). Composition considers whether one or more specifications contribute to the overall predicate by returning a Predicate or null. Specifications returning null are considered to not contribute to the overall predicate and their result is not considered in the final predicate.

Since:

4.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method	Description
static <T> DeleteSpecification<T>	allOf(Iterable<DeleteSpecification<T>> specifications)	Applies an AND operation to all the given DeleteSpecifications.
static <T> DeleteSpecification<T>	allOf(DeleteSpecification<T>... specifications)	Applies an AND operation to all the given DeleteSpecifications.
default DeleteSpecification<T>	and(DeleteSpecification<T> other)	ANDs the given DeleteSpecification to the current one.
default DeleteSpecification<T>	and(PredicateSpecification<T> other)	ANDs the given DeleteSpecification to the current one.
static <T> DeleteSpecification<T>	anyOf(Iterable<DeleteSpecification<T>> specifications)	Applies an OR operation to all the given DeleteSpecifications.
static <T> DeleteSpecification<T>	anyOf(DeleteSpecification<T>... specifications)	Applies an OR operation to all the given DeleteSpecifications.
static <T> DeleteSpecification<T>	not(DeleteSpecification<T> spec)	Negates the given DeleteSpecification.
default DeleteSpecification<T>	or(DeleteSpecification<T> other)	ORs the given specification to the current one.
default DeleteSpecification<T>	or(PredicateSpecification<T> other)	ORs the given specification to the current one.
@Nullable jakarta.persistence.criteria.Predicate	toPredicate(jakarta.persistence.criteria.Root<T> root, jakarta.persistence.criteria.CriteriaDelete<T> delete, jakarta.persistence.criteria.CriteriaBuilder criteriaBuilder)	Creates a WHERE clause for a query of the referenced entity in form of a Predicate for the given Root and CriteriaDelete.
static <T> DeleteSpecification<T>	unrestricted()	Simple static factory method to create a specification deleting all objects.
static <T> DeleteSpecification<T>	where(DeleteSpecification<T> spec)	Simple static factory method to add some syntactic sugar around a DeleteSpecification.
static <T> DeleteSpecification<T>	where(PredicateSpecification<T> spec)	Simple static factory method to add some syntactic sugar translating PredicateSpecification to DeleteSpecification.

Method Details

unrestricted

static <T> DeleteSpecification<T> unrestricted()

Simple static factory method to create a specification deleting all objects.

Type Parameters:

T - the type of the Root the resulting DeleteSpecification operates on.

Returns:

guaranteed to be not null.

where

static <T> DeleteSpecification<T> where(DeleteSpecification<T> spec)

Simple static factory method to add some syntactic sugar around a DeleteSpecification.

Type Parameters:

T - the type of the Root the resulting DeleteSpecification operates on.

Parameters:

spec - must not be null.

Returns:

guaranteed to be not null.

where

static <T> DeleteSpecification<T> where(PredicateSpecification<T> spec)

Simple static factory method to add some syntactic sugar translating PredicateSpecification to DeleteSpecification.

Type Parameters:

T - the type of the Root the resulting DeleteSpecification operates on.

Parameters:

spec - the PredicateSpecification to wrap.

Returns:

guaranteed to be not null.

and

@Contract("_ -> new")
@CheckReturnValue
default DeleteSpecification<T> and(DeleteSpecification<T> other)

ANDs the given DeleteSpecification to the current one.

Parameters:

other - the other DeleteSpecification.

Returns:

the conjunction of the specifications.

and

@Contract("_ -> new")
@CheckReturnValue
default DeleteSpecification<T> and(PredicateSpecification<T> other)

ANDs the given DeleteSpecification to the current one.

Parameters:

other - the other PredicateSpecification.

Returns:

the conjunction of the specifications.

or

@Contract("_ -> new")
@CheckReturnValue
default DeleteSpecification<T> or(DeleteSpecification<T> other)

ORs the given specification to the current one.

Parameters:

other - the other DeleteSpecification.

Returns:

the disjunction of the specifications.

or

@Contract("_ -> new")
@CheckReturnValue
default DeleteSpecification<T> or(PredicateSpecification<T> other)

ORs the given specification to the current one.

Parameters:

other - the other PredicateSpecification.

Returns:

the disjunction of the specifications.

not

@Contract("_ -> new")
static <T> DeleteSpecification<T> not(DeleteSpecification<T> spec)

Negates the given DeleteSpecification.

Type Parameters:

T - the type of the Root the resulting DeleteSpecification operates on.

Parameters:

spec - can be null.

Returns:

guaranteed to be not null.

allOf

@SafeVarargs
static <T> DeleteSpecification<T> allOf(DeleteSpecification<T>... specifications)

Applies an AND operation to all the given DeleteSpecifications. If specifications is empty, the resulting DeleteSpecification will be unrestricted applying to all objects.

Parameters:

specifications - the DeleteSpecifications to compose.

Returns:

the conjunction of the specifications.

See Also:

• and(DeleteSpecification)
• allOf(Iterable)

allOf

static <T> DeleteSpecification<T> allOf(Iterable<DeleteSpecification<T>> specifications)

Applies an AND operation to all the given DeleteSpecifications. If specifications is empty, the resulting DeleteSpecification will be unrestricted applying to all objects.

Parameters:

specifications - the DeleteSpecifications to compose.

Returns:

the conjunction of the specifications.

See Also:

• and(DeleteSpecification)
• allOf(DeleteSpecification[])

anyOf

@SafeVarargs
static <T> DeleteSpecification<T> anyOf(DeleteSpecification<T>... specifications)

Applies an OR operation to all the given DeleteSpecifications. If specifications is empty, the resulting DeleteSpecification will be unrestricted applying to all objects.

Parameters:

specifications - the DeleteSpecifications to compose.

Returns:

the disjunction of the specifications.

See Also:

• or(DeleteSpecification)
• anyOf(Iterable)

anyOf

static <T> DeleteSpecification<T> anyOf(Iterable<DeleteSpecification<T>> specifications)

Applies an OR operation to all the given DeleteSpecifications. If specifications is empty, the resulting DeleteSpecification will be unrestricted applying to all objects.

Parameters:

specifications - the DeleteSpecifications to compose.

Returns:

the disjunction of the specifications.

See Also:

• or(DeleteSpecification)
• anyOf(Iterable)

toPredicate

@Nullable jakarta.persistence.criteria.Predicate toPredicate(jakarta.persistence.criteria.Root<T> root,
 jakarta.persistence.criteria.CriteriaDelete<T> delete,
 jakarta.persistence.criteria.CriteriaBuilder criteriaBuilder)

Creates a WHERE clause for a query of the referenced entity in form of a Predicate for the given Root and CriteriaDelete.

Parameters:

root - must not be null.

delete - the delete criteria.

criteriaBuilder - must not be null.

Returns:

a Predicate, may be null.