javax.persistence.criteria

Interface CriteriaUpdate<T>

Contents
  • Type Parameters:
    T - the entity type that is the target of the update
    All Superinterfaces:
    CommonAbstractCriteria

    public interface CriteriaUpdate<T>
extends CommonAbstractCriteria
    The CriteriaUpdate interface defines functionality for performing bulk update operations using the Criteria API.

    Criteria API bulk update operations map directly to database update operations, bypassing any optimistic locking checks. Portable applications using bulk update operations must manually update the value of the version column, if desired, and/or manually validate the value of the version column. The persistence context is not synchronized with the result of the bulk update.

    A CriteriaUpdate object must have a single root.

    Since:
    Java Persistence 2.1

    • Method Detail

      • from

        Root<T> from(Class<T> entityClass)
        Create and add a query root corresponding to the entity that is the target of the update. A CriteriaUpdate object has a single root, the entity that is being updated.
        Parameters:
        entityClass - the entity class
        Returns:
        query root corresponding to the given entity

      • from

        Root<T> from(EntityType<T> entity)
        Create and add a query root corresponding to the entity that is the target of the update. A CriteriaUpdate object has a single root, the entity that is being updated.
        Parameters:
        entity - metamodel entity representing the entity of type X
        Returns:
        query root corresponding to the given entity

      • getRoot

        Root<T> getRoot()
        Return the query root.
        Returns:
        the query root

      • set

        <Y,X extends Y> CriteriaUpdate<T> set(SingularAttribute<? super T,Y> attribute,
                                      X value)
        Update the value of the specified attribute.
        Parameters:
        attribute - attribute to be updated
        value - new value
        Returns:
        the modified update query

      • set

        <Y> CriteriaUpdate<T> set(SingularAttribute<? super T,Y> attribute,
                          Expression<? extends Y> value)
        Update the value of the specified attribute.
        Parameters:
        attribute - attribute to be updated
        value - new value
        Returns:
        the modified update query

      • set

        <Y,X extends Y> CriteriaUpdate<T> set(Path<Y> attribute,
                                      X value)
        Update the value of the specified attribute.
        Parameters:
        attribute - attribute to be updated
        value - new value
        Returns:
        the modified update query

      • set

        <Y> CriteriaUpdate<T> set(Path<Y> attribute,
                          Expression<? extends Y> value)
        Update the value of the specified attribute.
        Parameters:
        attribute - attribute to be updated
        value - new value
        Returns:
        the modified update query

      • set

        CriteriaUpdate<T> set(String attributeName,
                      Object value)
        Update the value of the specified attribute.
        Parameters:
        attributeName - name of the attribute to be updated
        value - new value
        Returns:
        the modified update query

      • where

        CriteriaUpdate<T> where(Expression<Boolean> restriction)
        Modify the update query to restrict the target of the update according to the specified boolean expression. Replaces the previously added restriction(s), if any.
        Parameters:
        restriction - a simple or compound boolean expression
        Returns:
        the modified update query

      • where

        CriteriaUpdate<T> where(Predicate... restrictions)
        Modify the update query to restrict the target of the update 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 - zero or more restriction predicates
        Returns:
        the modified update query

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/persistence/criteria/criteriaupdate.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.