Module io.ebean.api
Package io.ebean.config.dbplatform

Enum IdType

java.lang.Object
java.lang.Enum<IdType>
io.ebean.config.dbplatform.IdType
All Implemented Interfaces:
Serializable, Comparable<IdType>
public enum IdType extends Enum<IdType>
The types of Identity generation that can be defined.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AUTO
    Auto mapping to platform preferred identity strategy.
    EXTERNAL
    Expected that the identity is externally set (for example a ISO code for country or currency or a user defined code for lookup tables).
    GENERATOR
    Use an IdGenerator to generate the identity (prior to insert).
    IDENTITY
    Use a Database Identity (autoincrement) to generate the identity.
    SEQUENCE
    Use a Database sequence to generate the identity.

  • Method Summary

    Modifier and Type
    Method
    Description
    static IdType
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static IdType[]
    values()
    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

    • IDENTITY

      public static final IdType IDENTITY
      Use a Database Identity (autoincrement) to generate the identity.

    • SEQUENCE

      public static final IdType SEQUENCE
      Use a Database sequence to generate the identity.

      Note: Some databases support getGeneratedKeys with sequences and this then does not involve an extra statement to return the id.

    • GENERATOR

      public static final IdType GENERATOR
      Use an IdGenerator to generate the identity (prior to insert).

      Note: There is a IdGenerator for UUID's and it is automatically assigned to id properties of type UUID.

    • EXTERNAL

      public static final IdType EXTERNAL
      Expected that the identity is externally set (for example a ISO code for country or currency or a user defined code for lookup tables).

      Used when the key is a compound key or lookup table code.

    • AUTO

      public static final IdType AUTO
      Auto mapping to platform preferred identity strategy.

  • Method Details

    • values

      public static IdType[] 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 IdType 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