org.hibernate.annotations.OptimisticLock Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of beangle-hibernate-core Show documentation

Hibernate Orm Core Shade,Support Scala Collection

There is a newer version: 6.6.2.Final

Show newest version

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Specifies whether mutating the annotated attribute should trigger an increment
 * to the {@link jakarta.persistence.Version version} of the entity instance. Or,
 * if {@link OptimisticLockType#ALL} or {@link OptimisticLockType#DIRTY} are used,
 * specifies whether the attribute should be included or excluded from the list of
 * checked attributes.
 * 
 * If this annotation is not present, mutating an attribute does cause the
 * version to be incremented.
 *
 * @author Logi Ragnarsson
 */
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface OptimisticLock {
	/**
	 * {@code true} if changing the annotated attribute should not cause
	 * the version to be incremented.
	 */
	boolean excluded();
}