IdType (Ebean 2.6.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

com.avaje.ebean.config.dbplatform
Enum IdType

java.lang.Object
  java.lang.Enum<IdType>
      com.avaje.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
`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
`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
`compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

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.

Method Detail

values

public static IdType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IdType c : IdType.values())
    System.out.println(c);

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