jakarta.persistence.Version Maven / Gradle / Ivy
/*
* Copyright (c) 2008, 2023 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Linda DeMichiel - 2.1
// Linda DeMichiel - 2.0
package jakarta.persistence;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Declares the version field or property of an entity class, which
* is used to detect optimistic lock failures, ensuring the integrity
* of optimistic transactions. The version field or property holds a
* version number or timestamp identifying the revision of the entity
* data held by an entity class instance.
*
* An {@linkplain OptimisticLockException optimistic lock failure}
* occurs when verification of the version or timestamp fails
* during an attempt to update the entity, that is, if the version
* or timestamp held in the database changes between reading the
* state of an entity instance and attempting to update or delete
* the state of the instance.
*
*
The version attribute must be of one of the following basic
* types: {@code int}, {@link Integer}, {@code short}, {@link Short},
* {@code long}, {@link Long}, {@code java.sql.Timestamp},
* {@link java.time.Instant}, {@link java.time.LocalDateTime}.
*
*
This field declares a version number:
*
* {@snippet :
* @Version
* @Column(name = "REVISION")
* protected int version;
* }
*
*
This field declares a revision timestamp:
*
* {@snippet :
* @Version
* @Column(name = "LAST_UPDATED")
* private Instant lastUpdated;
* }
*
*
An entity class should have at most one {@code Version} field
* or property. The version field or property should be declared by
* the root entity class in an entity class hierarchy, or by one of
* its mapped superclasses.
*
*
The {@code Version} field or property should be mapped to the
* primary table of the entity.
*
* @see LockModeType
* @see PersistenceUnitUtil#getVersion(Object)
*
* @since 1.0
*/
@Target({METHOD, FIELD})
@Retention(RUNTIME)
public @interface Version {}