Package org.springframework.data.jpa.domain

Interface UpdateSpecification<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 UpdateSpecification<T>
extends Serializable

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

Specifications can be composed into higher order functions from other specifications using and(UpdateSpecification), or(UpdateSpecification) 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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	UpdateSpecification.UpdateOperation<T>	Simplified extension to UpdateSpecification that only considers the UPDATE part without specifying a predicate.

Method Summary

Modifier and Type	Method	Description
static <T> UpdateSpecification<T>	allOf(Iterable<UpdateSpecification<T>> specifications)	Applies an AND operation to all the given UpdateSpecifications.
static <T> UpdateSpecification<T>	allOf(UpdateSpecification<T>... specifications)	Applies an AND operation to all the given UpdateSpecifications.
default UpdateSpecification<T>	and(PredicateSpecification<T> other)	ANDs the given UpdateSpecification to the current one.
default UpdateSpecification<T>	and(UpdateSpecification<T> other)	ANDs the given UpdateSpecification to the current one.
static <T> UpdateSpecification<T>	anyOf(Iterable<UpdateSpecification<T>> specifications)	Applies an OR operation to all the given UpdateSpecifications.
static <T> UpdateSpecification<T>	anyOf(UpdateSpecification<T>... specifications)	Applies an OR operation to all the given UpdateSpecifications.
static <T> UpdateSpecification<T>	not(UpdateSpecification<T> spec)	Negates the given UpdateSpecification.
default UpdateSpecification<T>	or(PredicateSpecification<T> other)	ORs the given specification to the current one.
default UpdateSpecification<T>	or(UpdateSpecification<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.CriteriaUpdate<T> update, 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 CriteriaUpdate.
static <T> UpdateSpecification<T>	unrestricted()	Simple static factory method to create a specification updating all objects.
static <T> UpdateSpecification.UpdateOperation<T>	update(UpdateSpecification.UpdateOperation<T> spec)	Simple static factory method to add some syntactic sugar around a UpdateOperation.
static <T> UpdateSpecification<T>	where(PredicateSpecification<T> spec)	Simple static factory method to add some syntactic sugar translating PredicateSpecification to UpdateSpecification.
static <T> UpdateSpecification<T>	where(UpdateSpecification<T> spec)	Simple static factory method to add some syntactic sugar around a UpdateSpecification.

Method Details

unrestricted

static <T> UpdateSpecification<T> unrestricted()

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

Type Parameters:

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

Returns:

guaranteed to be not null.

update

static <T> UpdateSpecification.UpdateOperation<T> update(UpdateSpecification.UpdateOperation<T> spec)

Simple static factory method to add some syntactic sugar around a UpdateOperation. For example:

 UpdateSpecification<User> updateLastname = UpdateOperation
                .<User> update((root, update, criteriaBuilder) -> update.set("lastname", "Heisenberg"))
                .where(userHasFirstname("Walter").and(userHasLastname("White")));

 repository.update(updateLastname);
 

Type Parameters:

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

Parameters:

spec - must not be null.

Returns:

guaranteed to be not null.

where

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

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

Type Parameters:

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

Parameters:

spec - must not be null.

Returns:

guaranteed to be not null.

where

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

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

Type Parameters:

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

Parameters:

spec - the PredicateSpecification to wrap.

Returns:

guaranteed to be not null.

and

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

ANDs the given UpdateSpecification to the current one.

Parameters:

other - the other UpdateSpecification.

Returns:

the conjunction of the specifications.

and

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

ANDs the given UpdateSpecification to the current one.

Parameters:

other - the other PredicateSpecification.

Returns:

the conjunction of the specifications.

or

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

ORs the given specification to the current one.

Parameters:

other - the other UpdateSpecification.

Returns:

the disjunction of the specifications.

or

@Contract("_ -> new")
@CheckReturnValue
default UpdateSpecification<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

static <T> UpdateSpecification<T> not(UpdateSpecification<T> spec)

Negates the given UpdateSpecification.

Type Parameters:

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

Parameters:

spec - can be null.

Returns:

guaranteed to be not null.

allOf

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

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

Parameters:

specifications - the UpdateSpecifications to compose.

Returns:

the conjunction of the specifications.

See Also:

• and(UpdateSpecification)
• allOf(Iterable)

allOf

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

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

Parameters:

specifications - the UpdateSpecifications to compose.

Returns:

the conjunction of the specifications.

See Also:

• and(UpdateSpecification)
• allOf(UpdateSpecification[])

anyOf

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

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

Parameters:

specifications - the UpdateSpecifications to compose.

Returns:

the disjunction of the specifications.

See Also:

• or(UpdateSpecification)
• anyOf(Iterable)

anyOf

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

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

Parameters:

specifications - the UpdateSpecifications to compose.

Returns:

the disjunction of the specifications.

See Also:

• or(UpdateSpecification)
• anyOf(Iterable)

toPredicate

@Nullable jakarta.persistence.criteria.Predicate toPredicate(jakarta.persistence.criteria.Root<T> root,
 jakarta.persistence.criteria.CriteriaUpdate<T> update,
 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 CriteriaUpdate.

Parameters:

root - must not be null.

update - the update criteria.

criteriaBuilder - must not be null.

Returns:

a Predicate, may be null.