io.ebean.annotation

Annotation Type DbEnumValue

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface DbEnumValue

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;
    }
  }

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	length The column length for VARCHAR.
DbEnumType	storage Specify the database type used to store the values (VARCHAR or INTEGER).

Element Detail

storage

public abstract DbEnumType storage

Specify the database type used to store the values (VARCHAR or INTEGER).

Default:

io.ebean.annotation.DbEnumType.VARCHAR

length

public abstract int length

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.

Default:

0