Enum GenerationType

java.lang.Object
java.lang.Enum<GenerationType>
jakarta.persistence.GenerationType
All Implemented Interfaces:
Serializable, Comparable<GenerationType>

public enum GenerationType extends Enum<GenerationType>
Enumerates the defined primary key generation strategies.
Since:
1.0
See Also:
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Indicates that the persistence provider should pick an appropriate strategy for the particular database.
    Indicates that the persistence provider must assign primary keys for the entity using a database identity column.
    Indicates that the persistence provider must assign primary keys for the entity using a database sequence.
    Indicates that the persistence provider must assign primary keys for the entity using an underlying database table to ensure uniqueness.
    Indicates that the persistence provider must assign primary keys for the entity by generating an RFC 4122 Universally Unique IDentifier.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this type with the specified name.
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • TABLE

      public static final GenerationType TABLE
      Indicates that the persistence provider must assign primary keys for the entity using an underlying database table to ensure uniqueness.

      May be used to generate primary keys of type Long, Integer, long, or int.

    • SEQUENCE

      public static final GenerationType SEQUENCE
      Indicates that the persistence provider must assign primary keys for the entity using a database sequence.

      May be used to generate primary keys of type Long, Integer, long, or int.

    • IDENTITY

      public static final GenerationType IDENTITY
      Indicates that the persistence provider must assign primary keys for the entity using a database identity column.

      May be used to generate primary keys of type Long, Integer, long, or int.

    • UUID

      public static final GenerationType UUID
      Indicates that the persistence provider must assign primary keys for the entity by generating an RFC 4122 Universally Unique IDentifier.

      May be used to generate primary keys of type UUID or String.

    • AUTO

      public static final GenerationType AUTO
      Indicates that the persistence provider should pick an appropriate strategy for the particular database.

      The AUTO generation strategy may expect a database resource to exist, or it may attempt to create one. A vendor may provide documentation on how to create such resources in the event that it does not support schema generation or cannot create the schema resource at runtime.

  • Constructor Details

    • GenerationType

      private GenerationType()
  • Method Details

    • values

      public static GenerationType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static GenerationType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null