Module jakarta.nosql.core

Package jakarta.nosql

Enum Class Embeddable.EmbeddableType

java.lang.Object

java.lang.Enum<Embeddable.EmbeddableType>

jakarta.nosql.Embeddable.EmbeddableType

All Implemented Interfaces:

Serializable, Comparable<Embeddable.EmbeddableType>, Constable

Enclosing class:

Embeddable

public static enum Embeddable.EmbeddableType
extends Enum<Embeddable.EmbeddableType>

Defines the strategy for how fields of the embeddable class are stored.

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
FLAT	Fields of the embeddable class are embedded directly into the data structure of the parent entity or embeddable.
GROUPING	Fields of the embeddable class are stored in a structured type, such as a user-defined type (UDT).

Method Summary

Modifier and Type	Method	Description
static Embeddable.EmbeddableType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Embeddable.EmbeddableType[]	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

FLAT

public static final Embeddable.EmbeddableType FLAT

Fields of the embeddable class are embedded directly into the data structure of the parent entity or embeddable.

GROUPING

public static final Embeddable.EmbeddableType GROUPING

Fields of the embeddable class are stored in a structured type, such as a user-defined type (UDT).

Method Details

values

public static Embeddable.EmbeddableType[] 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 Embeddable.EmbeddableType 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