Package org.hibernate.metamodel

Enum Class CollectionClassification

java.lang.Object

java.lang.Enum<CollectionClassification>

org.hibernate.metamodel.CollectionClassification

All Implemented Interfaces:

Serializable, Comparable<CollectionClassification>, Constable

@Incubating
public enum CollectionClassification
extends Enum<CollectionClassification>

Classifications of the plurality.

Since:

6.0

See Also:

• CollectionSemantics

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
ARRAY	An Object or primitive array.
BAG	A non-unique, unordered collection.
ID_BAG	A BAG with a generated id for each element
LIST	A non-unique, ordered collection following the requirements of List
MAP	A collection following the semantics of Map
ORDERED_MAP	A MAP that is ordered using an order-by fragment as the collection is loaded.
ORDERED_SET	A SET that is ordered using an order-by fragment as the collection is loaded.
SET	A unique, unordered collection following the requirements of Set
SORTED_MAP	A sorted MAP using either natural sorting of the keys or a specified Comparator.
SORTED_SET	A sorted SET using either natural sorting of the elements or a specified Comparator.

Method Summary

Modifier and Type	Method	Description
static CollectionClassification	interpretSetting(Object value)	One of: CollectionClassification instance CollectionClassification name (case insensitive) Class reference for either List or Collection
boolean	isIndexed()
boolean	isRowUpdatePossible()
PluralAttribute.CollectionType	toJpaClassification()
static CollectionClassification	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CollectionClassification[]	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

ARRAY

public static final CollectionClassification ARRAY

An Object or primitive array. Roughly follows the semantics of LIST

BAG

public static final CollectionClassification BAG

A non-unique, unordered collection. Represented as Collection or List

ID_BAG

public static final CollectionClassification ID_BAG

A BAG with a generated id for each element

LIST

public static final CollectionClassification LIST

A non-unique, ordered collection following the requirements of List

See Also:

• MappingSettings.DEFAULT_LIST_SEMANTICS

SET

public static final CollectionClassification SET

A unique, unordered collection following the requirements of Set

SORTED_SET

public static final CollectionClassification SORTED_SET

A sorted SET using either natural sorting of the elements or a specified Comparator. Represented as SortedSet or Set

See Also:

• SortNatural
• SortComparator

ORDERED_SET

public static final CollectionClassification ORDERED_SET

A SET that is ordered using an order-by fragment as the collection is loaded. Does not maintain ordering while in memory if the contents change. Represented as Set.

See Also:

• OrderBy
• SQLOrder

MAP

public static final CollectionClassification MAP

A collection following the semantics of Map

SORTED_MAP

public static final CollectionClassification SORTED_MAP

A sorted MAP using either natural sorting of the keys or a specified Comparator. Represented as SortedMap or Map

See Also:

• SortNatural
• SortComparator

ORDERED_MAP

public static final CollectionClassification ORDERED_MAP

A MAP that is ordered using an order-by fragment as the collection is loaded. Does not maintain ordering while in memory if the contents change. Represented as Map.

See Also:

• OrderBy
• SQLOrder

Method Details

values

public static CollectionClassification[] 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 CollectionClassification 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

toJpaClassification

public PluralAttribute.CollectionType toJpaClassification()

isIndexed

public boolean isIndexed()

isRowUpdatePossible

public boolean isRowUpdatePossible()

interpretSetting

public static CollectionClassification interpretSetting(Object value)

One of:

• CollectionClassification instance
• CollectionClassification name (case insensitive)
• Class reference for either List or Collection