Top Description Fields Constructors Methods
org.hibernate.metamodel

public final Enum CollectionClassification

extends Enum<CollectionClassification>
Class Inheritance
Annotations
@Incubating
Imports
java.util.SortedMap, .SortedSet, org.hibernate.Incubating, org.hibernate.boot.BootLogging, jakarta.persistence.metamodel.PluralAttribute

Classifications of the plurality.
Since
6.0
See Also
org.hibernate.collection.spi.CollectionSemantics

Field Summary

Modifier and TypeField and Description
public static final CollectionClassification
ARRAY

An Object or primitive array.

public static final CollectionClassification
BAG

A non-unique, unordered collection.

public static final CollectionClassification
ID_BAG

A BAG with a generated id for each element

private final boolean
private final PluralAttribute.CollectionType
public static final CollectionClassification
LIST

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

public static final CollectionClassification
MAP

A collection following the semantics of java.util.Map

public static final CollectionClassification
ORDERED_MAP

A MAP that is ordered using an order-by fragment as the collection is loaded.

public static final CollectionClassification
ORDERED_SET

A SET that is ordered using an order-by fragment as the collection is loaded.

public static final CollectionClassification
SET

A unique, unordered collection following the requirements of java.util.Set

public static final CollectionClassification
SORTED_MAP

A sorted MAP using either natural sorting of the keys or a specified java.util.Comparator.

public static final CollectionClassification
SORTED_SET

A sorted SET using either natural sorting of the elements or a specified java.util.Comparator.

Constructor Summary

AccessConstructor and Description
private
CollectionClassification(PluralAttribute.CollectionType jpaClassification, boolean isIndexed)

Method Summary

Modifier and TypeMethod and Description
private static CollectionClassification
interpretClass(Class<?> configuredClass)

public static CollectionClassification
public boolean
public boolean
public PluralAttribute.CollectionType
public static CollectionClassification
public static CollectionClassification[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ARRAYback to summary
public static final CollectionClassification ARRAY

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

BAGback to summary
public static final CollectionClassification BAG

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

ID_BAGback to summary
public static final CollectionClassification ID_BAG

A BAG with a generated id for each element

isIndexedback to summary
private final boolean isIndexed
jpaClassificationback to summary
private final PluralAttribute.CollectionType jpaClassification
LISTback to summary
public static final CollectionClassification LIST

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

See Also
org.hibernate.cfg.AvailableSettings#DEFAULT_LIST_SEMANTICS
MAPback to summary
public static final CollectionClassification MAP

A collection following the semantics of java.util.Map

ORDERED_MAPback to summary
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 java.util.Map.

See Also
jakarta.persistence.OrderBy, org.hibernate.annotations.OrderBy
ORDERED_SETback to summary
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 java.util.Set.

See Also
jakarta.persistence.OrderBy, org.hibernate.annotations.OrderBy
SETback to summary
public static final CollectionClassification SET

A unique, unordered collection following the requirements of java.util.Set

SORTED_MAPback to summary
public static final CollectionClassification SORTED_MAP

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

See Also
org.hibernate.annotations.SortNatural, org.hibernate.annotations.SortComparator
SORTED_SETback to summary
public static final CollectionClassification SORTED_SET

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

See Also
org.hibernate.annotations.SortNatural, org.hibernate.annotations.SortComparator

Constructor Detail

CollectionClassificationback to summary
private CollectionClassification(PluralAttribute.CollectionType jpaClassification, boolean isIndexed)

Method Detail

interpretClassback to summary
private static CollectionClassification interpretClass(Class<?> configuredClass)
interpretSettingback to summary
public static CollectionClassification interpretSetting(Object value)

One of:

isIndexedback to summary
public boolean isIndexed()
isRowUpdatePossibleback to summary
public boolean isRowUpdatePossible()
toJpaClassificationback to summary
public PluralAttribute.CollectionType toJpaClassification()
valueOfback to summary
public static CollectionClassification valueOf(String name)
valuesback to summary
public static CollectionClassification[] values()