Module jakarta.persistence

Package jakarta.persistence

Enum Class EnumType

java.lang.Object

java.lang.Enum<EnumType>

jakarta.persistence.EnumType

All Implemented Interfaces:

Serializable, Comparable<EnumType>, Constable

public enum EnumType
extends Enum<EnumType>

Enumerates available options for mapping enumerated types. The values of this enumeration specify how a persistent property or field whose type is a Java enum type should be persisted.

Since:

1.0

See Also:

• Enumerated
• EnumeratedValue

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ORDINAL	Persist enumerated type property or field as an integer.
STRING	Persist enumerated type property or field as a string.

Method Summary

Modifier and Type	Method	Description
static EnumType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EnumType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ORDINAL

public static final EnumType ORDINAL

Persist enumerated type property or field as an integer. The ordinal value of an enum instance with no EnumeratedValue field is the value of its Enum.ordinal() member.

STRING

public static final EnumType STRING

Persist enumerated type property or field as a string. The string value of an enum instance with no EnumeratedValue field is the value of its Enum.name() member.

Method Details

values

public static EnumType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EnumType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null