org.jooby.mongodb

Enum IdGen

java.lang.Object

java.lang.Enum<IdGen>

org.jooby.mongodb.IdGen

All Implemented Interfaces:

Serializable, Comparable<IdGen>

public enum IdGen
extends Enum<IdGen>

Setup up an EntityInterceptor on PrePersist events that generates an incremental ID.

Usage:

 {
   use(new Monphia().idGen(IdGen.GLOBAL);
 }
 

ID must be of type: Long and annotated with GeneratedValue:

 @Entity
 public class MyEntity {
   @Id @GeneratedValue Long id;
 }
 

Since:

0.13.0

Author:

edgar

Enum Constant Summary

Enum Constants

Enum Constant and Description
GLOBAL A global unique ID regardless of the entity type.
LOCAL A unique ID per entity type.

Method Summary

Modifier and Type	Method and Description
abstract String	value(Class<?> mappedClass) Get an unique value for the given mapped class.
static IdGen	valueOf(String name) Returns the enum constant of this type with the specified name.
static IdGen[]	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 Detail

GLOBAL

public static final IdGen GLOBAL

A global unique ID regardless of the entity type.

LOCAL

public static final IdGen LOCAL

A unique ID per entity type.

Method Detail

values

public static IdGen[] 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 (IdGen c : IdGen.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IdGen 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

value

public abstract String value(Class<?> mappedClass)

Get an unique value for the given mapped class.

Parameters:

mappedClass - A mapped class.

Returns:

Get an unique value for the given mapped class.