package io.ebean.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

Specify a method on an Enum that returns the value that should be stored in the DB.

This is the preferred option for mapping Enum's to DB values (preferred over the JPA
standard @Enumerated and Ebean's @EnumValue annotations).

Example:

  public enum Status {
    NEW("N"),
    ACTIVE("A"),
    INACTIVE("I");
    String dbValue;
    Status(String dbValue) {
      this.dbValue = dbValue;
    }
    @DbEnumValue
    public String getValue() {
      return dbValue;
    }
  }

/**
 * Specify a method on an Enum that returns the value that should be stored in the DB.
 * <p>
 * This is the preferred option for mapping Enum's to DB values (preferred over the JPA
 * standard @Enumerated and Ebean's @EnumValue annotations).
 * </p>
 * <h3>Example:</h3>
 * <pre>{@code
 *
 *   public enum Status {
 *     NEW("N"),
 *     ACTIVE("A"),
 *     INACTIVE("I");
 *
 *     String dbValue;
 *     Status(String dbValue) {
 *       this.dbValue = dbValue;
 *     }
 *
 *     @DbEnumValue
 *     public String getValue() {
 *       return dbValue;
 *     }
 *   }
 *
 * }</pre>
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface DbEnumValue {

  
Specify the database type used to store the values (VARCHAR or INTEGER).
/**
   * Specify the database type used to store the values (VARCHAR or INTEGER).
   */
  DbEnumType storage() default DbEnumType.VARCHAR;

  
The column length for VARCHAR.

When 0 the length is determined automatically based on the maximum length of the values used.

Specify this to allow for future string enum values that might be larger then the automatically
determined maximum length.
/**
   * The column length for VARCHAR.
   * <p>
   * When 0 the length is determined automatically based on the maximum length of the values used.
   * <p>
   * Specify this to allow for future string enum values that might be larger then the automatically
   * determined maximum length.
   */
  int length() default 0;

  
When true DDL should generate a database constraint for the enum values.
/**
   * When true DDL should generate a database constraint for the enum values.
   */
  boolean withConstraint() default true;

}