Enum type fields in JPA Entity

Question

Is it possible to use Enums as a type of a field (column) in custom JPA entities? Here is an example:

@Getter @Setter
@Entity
@Table(name = "payments")
public class PaymentEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @Column(name = "status")
    private Integer statusId;

    public PaymentStatuses getStatus() {
        return PaymentStatuses.valueOf(statusId);
    }

    public PaymentEntity setStatus(PaymentStatuses status) {
        statusId = status == null ? null : status.getId();
        return this;
    }
}

public enum PaymentStatuses {
    CREATED(1),
    COMPLETED(2),
    CANCELED(3);


    private Integer id;

    private PaymentStatuses(Integer id) {
        this.id = id;
    }

    public Integer getId() {
         return id;
    }

    public static PaymentStatuses valueOf(Integer id) {
        for (PaymentStatuses value : values())
            if (value.getId().equals(id))
                return value;
        return null;
    }
}

Code above works fine, but approach with statusId and getStatus setStatus looks ugly a little bit.

I wanna use PaymentStatuses as a type of the field in my entity. Like this:

@Getter @Setter
@Entity
@Table(name = "payments")
public class PaymentEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @Column(name = "status")
    private PaymentStatuses status;
}

Tell me please, is it possible?

@Klaimmore ORDINAL starts to 0. It is not compatible with the id used (1, 2, 3) to represent the enum in DB. — davidxxx
– davidxxx, Commented Feb 19, 2018 at 14:20

davidxxx · Accepted Answer · 2018-02-19 14:30:08Z

8

Using @Enumerated(EnumType.ORDINAL) will not work because the ORDINAL mode starts to 0.
So the 3 first values of the enum will be represented in DB with the 0, 1 and 2 values.
while the id field in the enum to represent it in the DB goes from 1 to 3 :

CREATED(1),
COMPLETED(2),
CANCELED(3);

Besides, this way would correlate the order of elements defined in the enum with the way to represent them in database. Which not a good thing as enum values could be added/removed in the future.

A better way to address your issue is defining a javax.persistence.AttributeConverter and using it with @Convert.
So create a AttributeConverter implementation to indicate how to convert from the DB to the enum and the enum to the DB.
Then declare a PaymentStatuses status in your entity and annotate it with @Convert by specifying the AttributeConverter implementation class.

@Getter @Setter
@Entity
@Table(name = "payments")
public class PaymentEntity {
  ...
  @Convert(converter = PaymentStatusesConverter.class)
  private PaymentStatuses status;
  ...    
}

public class PaymentStatusesConverter  implements AttributeConverter<PaymentStatuses, Integer> {

    @Override
    public Integer convertToDatabaseColumn(PaymentStatuses status) {
        return status.getId();
    }

    @Override
    public PaymentStatuses convertToEntityAttribute(Integer status) {
         return PaymentStatuses.valueOf(status); 
    }
}

edited Feb 19, 2018 at 14:30

answered Feb 19, 2018 at 14:14

davidxxx

132k23 gold badges231 silver badges228 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Bohdan Petrenko Over a year ago

Thank you. All works fine. Spring data jpa find queries works fine too.

davidxxx Over a year ago

@Bohdan Petrenko Thanks for the feedback. You are welcome.

Rajesh Over a year ago

this is working fine while bringing the values from database. But while insert into database throws casting exception. Thanks in advance.

SrThompson · Accepted Answer · 2018-02-19 13:59:05Z

1

Yes, but when you save to the database it will persist the current index of the enum value (in your case 0 for CREATED, 1 for COMPLETED, etc.) which will give you trouble if you change the enum values. To avoid this you can use the @Enumerated annotation like:

@Getter @Setter
@Entity
@Table(name = "payments")
public class PaymentEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @Column(name = "status")
    @Enumerated(EnumType.ORDINAL) // There is also EnumType.STRING, or you can define a custom EnumType
    private PaymentStatuses status;
}

answered Feb 19, 2018 at 13:59

SrThompson

5,7582 gold badges20 silver badges25 bronze badges

Comments

Federico Scardina · Accepted Answer · 2018-02-19 16:12:17Z

0

You can use @Enumerated(EnumType.STRING) if you want your data to be stored in the db like the name of the Java enum name (CREATED, COMPLETED, CANCELED)

answered Feb 19, 2018 at 16:12

Federico Scardina

1501 silver badge11 bronze badges

Collectives™ on Stack Overflow

Enum type fields in JPA Entity

3 Answers 3

3 Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related