SequenceGenerator


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.ElementType.TYPE  ;
30  import static java.lang.annotation.RetentionPolicy.RUNTIME  ;
31  
32  /**
33   * This annotation defines a primary key generator that may 
34   * be referenced by name when a generator element is specified 
35   * for the {@link GeneratedValue} annotation. A sequence generator 
36   * may be specified on the entity class or on the primary key 
37   * field or property. The scope of the generator name is global 
38   * to the persistence unit (across all generator types).
39   *
40   * <pre>
41   *   Example:
42   *
43   *   &#064;SequenceGenerator(name="EMP_SEQ", allocationSize=25)
44   * </pre>
45   *
46   * @since Java Persistence 1.0
47   */
48  @Target  ({TYPE, METHOD, FIELD}) 
49  @Retention  (RUNTIME)
50  
51  public @interface SequenceGenerator {
52  
53      /** 
54       * (Required) A unique generator name that can be referenced 
55       * by one or more classes to be the generator for primary key 
56       * values.
57       */
58      String   name();
59  
60      /**
61       * (Optional) The name of the database sequence object from 
62       * which to obtain primary key values.
63       * <p> Defaults to a provider-chosen value.
64       */
65      String   sequenceName() default "";
66  
67      /** 
68       * (Optional) The value from which the sequence object 
69       * is to start generating.
70       */
71      int initialValue() default 1;
72  
73      /**
74       * (Optional) The amount to increment by when allocating 
75       * sequence numbers from the sequence.
76       */
77      int allocationSize() default 50;
78  }
79
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags