javax.persistence.Version Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-jpa-2.0-api Show documentation

Hibernate definition of the Java Persistence 2.0 (JSR 317) API.

There is a newer version: 1.0.1.Final

Show newest version

// $Id: Version.java 17752 2009-10-15 01:19:21Z [email protected] $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.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;

/**
 * Specifies the version field or property of an entity class that
 * serves as its optimistic lock value.  The version is used to ensure
 * integrity when performing the merge operation and for optimistic
 * concurrency control.
 *
 *  Only a single Version property or field
 * should be used per class; applications that use more than one
 * Version property or field will not be portable.
 *
 * 
 The Version property should be mapped to
 * the primary table for the entity class; applications that
 * map the Version property to a table other than
 * the primary table will not be portable.
 *
 * 
 The following types are supported for version properties:
 * int, Integer, short,
 * Short, long, Long,
 * java.sql.Timestamp.
 *
 * 
 *    Example:
 *
 *    @Version
 *    @Column(name="OPTLOCK")
 *    protected int getVersionNum() { return versionNum; }
 * 
 *
 * @since Java Persistence 1.0
 */
@Target({ METHOD, FIELD })
@Retention(RUNTIME)
public @interface Version {
}