Top Description Methods
javax.persistence

public @Interface SequenceGenerator

extends Annotation
Annotations
@Repeatable:SequenceGenerators
@Target:TYPE, METHOD, FIELD
@Retention:RUNTIME
Imports
java.lang.annotation.Target, .Retention, .Repeatable

Defines a primary key generator that may be referenced by name when a generator element is specified for the GeneratedValue annotation. A sequence generator may be specified on the entity class or on the primary key field or property. The scope of the generator name is global to the persistence unit (across all generator types).
  Example:

  @SequenceGenerator(name="EMP_SEQ", allocationSize=25)
Since
Java Persistence 1.0

Method Summary

Modifier and TypeMethod and Description
public int
allocationSize()

(Optional) The amount to increment by when allocating sequence numbers from the sequence.

public String
catalog()

(Optional) The catalog of the sequence generator.

public int
initialValue()

(Optional) The value from which the sequence object is to start generating.

public String
name()

(Required) A unique generator name that can be referenced by one or more classes to be the generator for primary key values.

public String
schema()

(Optional) The schema of the sequence generator.

public String
sequenceName()

(Optional) The name of the database sequence object from which to obtain primary key values.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

allocationSizeback to summary
public int allocationSize()

(Optional) The amount to increment by when allocating sequence numbers from the sequence.

catalogback to summary
public String catalog()

(Optional) The catalog of the sequence generator.

Since
Java Persistence 2.0
initialValueback to summary
public int initialValue()

(Optional) The value from which the sequence object is to start generating.

nameback to summary
public String name()

(Required) A unique generator name that can be referenced by one or more classes to be the generator for primary key values.

schemaback to summary
public String schema()

(Optional) The schema of the sequence generator.

Since
Java Persistence 2.0
sequenceNameback to summary
public String sequenceName()

(Optional) The name of the database sequence object from which to obtain primary key values.

Defaults to a provider-chosen value.