1 /* 2 * The contents of this file are subject to the terms 3 * of the Common Development and Distribution License 4 * (the License). You may not use this file except in 5 * compliance with the License. 6 * 7 * You can obtain a copy of the license at 8 * https://glassfish.dev.java.net/public/CDDLv1.0.html or 9 * glassfish/bootstrap/legal/CDDLv1.0.txt. 10 * See the License for the specific language governing 11 * permissions and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL 14 * Header Notice in each file and include the License file 15 * at glassfish/bootstrap/legal/CDDLv1.0.txt. 16 * If applicable, add the following below the CDDL Header, 17 * with the fields enclosed by brackets [] replaced by 18 * you own identifying information: 19 * "Portions Copyrighted [year] [name of copyright owner]" 20 * 21 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 22 */ 23 package javax.persistence; 24 25 import java.lang.annotation.Target; 26 import java.lang.annotation.Retention; 27 import static java.lang.annotation.ElementType.METHOD; 28 import static java.lang.annotation.ElementType.FIELD; 29 import static java.lang.annotation.RetentionPolicy.RUNTIME; 30 31 /** 32 * This annotation specifies the version field or property of 33 * an entity class that serves as its optimistic lock value. 34 * The version is used to ensure integrity when performing the 35 * merge operation and for optimistic concurrency control. 36 * 37 * <p> Only a single <code>Version</code> property or field 38 * should be used per class; applications that use more than one 39 * <code>Version</code> property or field will not be portable. 40 * 41 * <p> The <code>Version</code> property should be mapped to 42 * the primary table for the entity class; applications that 43 * map the <code>Version</code> property to a table other than 44 * the primary table will not be portable. 45 * 46 * <p> The following types are supported for version properties: 47 * <code>int</code>, {@link Integer}, <code>short</code>, 48 * {@link Short}, <code>long</code>, {@link Long}, 49 * {@link java.sql.Timestamp Timestamp}. 50 * 51 * <pre> 52 * Example: 53 * 54 * @Version 55 * @Column(name="OPTLOCK") 56 * protected int getVersionNum() { return versionNum; } 57 * </pre> 58 * 59 * @since Java Persistence 1.0 60 */ 61 @Target({METHOD, FIELD}) 62 @Retention(RUNTIME) 63 64 public @interface Version {} 65