Package org.hibernate.metamodel.model.domain

Class AbstractManagedType<J>

java.lang.Object

org.hibernate.metamodel.model.domain.AbstractDomainType<J>

org.hibernate.metamodel.model.domain.AbstractManagedType<J>

All Implemented Interfaces:

ManagedType<J>, Type<J>, Serializable, DomainType<J>, AttributeContainer<J>, ManagedDomainType<J>, SimpleDomainType<J>, BindableType<J>, SqmExpressible<J>

Direct Known Subclasses:

AbstractIdentifiableType, EmbeddableTypeImpl

public abstract class AbstractManagedType<J>
extends AbstractDomainType<J>
implements ManagedDomainType<J>, AttributeContainer<J>, Serializable

Functionality common to all implementations of ManagedType.

Author:

Steve Ebersole

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractManagedType.InFlightAccessImpl

Nested classes/interfaces inherited from interface org.hibernate.metamodel.model.domain.internal.AttributeContainer

AttributeContainer.InFlightAccess<J>

Nested classes/interfaces inherited from interface jakarta.persistence.metamodel.Type

Type.PersistenceType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractManagedType(String hibernateTypeName, JavaType<J> javaType, ManagedDomainType<? super J> superType, JpaMetamodelImplementor metamodel)

Method Summary

Modifier and Type	Method	Description
void	addSubType(ManagedDomainType<? extends J> subType)
protected AttributeContainer.InFlightAccess<J>	createInFlightAccess()
PersistentAttribute<? super J,?>	findAttribute(String name)
PersistentAttribute<? super J,?>	findAttributeInSuperTypes(String name)
PersistentAttribute<? super J,?>	findConcreteGenericAttribute(String name)
PersistentAttribute<J,?>	findDeclaredAttribute(String name)
PersistentAttribute<J,?>	findDeclaredConcreteGenericAttribute(String name)
PluralPersistentAttribute<J,?,?>	findDeclaredPluralAttribute(String name)
SingularPersistentAttribute<J,?>	findDeclaredSingularAttribute(String name)
PluralPersistentAttribute<? super J,?,?>	findPluralAttribute(String name)
SingularPersistentAttribute<? super J,?>	findSingularAttribute(String name)
PersistentAttribute<?,?>	findSubTypesAttribute(String name)
PersistentAttribute<? super J,?>	getAttribute(String name)	Return the attribute of the managed type that corresponds to the specified name.
Set<Attribute<? super J,?>>	getAttributes()	Return the attributes of the managed type.
BagPersistentAttribute<? super J,?>	getCollection(String name)	Return the Collection-valued attribute of the managed type that corresponds to the specified name.
<E> BagPersistentAttribute<? super J,E>	getCollection(String name, Class<E> elementType)	Return the Collection-valued attribute of the managed type that corresponds to the specified name and Java element type.
PersistentAttribute<J,?>	getDeclaredAttribute(String name)	Return the attribute declared by the managed type that corresponds to the specified name.
Set<Attribute<J,?>>	getDeclaredAttributes()	Return the attributes declared by the managed type.
CollectionAttribute<J,?>	getDeclaredCollection(String name)	Return the Collection-valued attribute declared by the managed type that corresponds to the specified name.
<E> CollectionAttribute<J,E>	getDeclaredCollection(String name, Class<E> elementType)	Return the Collection-valued attribute declared by the managed type that corresponds to the specified name and Java element type.
ListPersistentAttribute<J,?>	getDeclaredList(String name)	Return the List-valued attribute declared by the managed type that corresponds to the specified name.
<E> ListAttribute<J,E>	getDeclaredList(String name, Class<E> elementType)	Return the List-valued attribute declared by the managed type that corresponds to the specified name and Java element type.
MapPersistentAttribute<J,?,?>	getDeclaredMap(String name)	Return the Map-valued attribute declared by the managed type that corresponds to the specified name.
<K, V> MapAttribute<J,K,V>	getDeclaredMap(String name, Class<K> keyType, Class<V> valueType)	Return the Map-valued attribute declared by the managed type that corresponds to the specified name and Java key and value types.
Set<PluralAttribute<J,?,?>>	getDeclaredPluralAttributes()	Return all multi-valued attributes (Collection-, Set-, List-, and Map-valued attributes) declared by the managed type.
SetPersistentAttribute<J,?>	getDeclaredSet(String name)	Return the Set-valued attribute declared by the managed type that corresponds to the specified name.
<E> SetAttribute<J,E>	getDeclaredSet(String name, Class<E> elementType)	Return the Set-valued attribute declared by the managed type that corresponds to the specified name and Java element type.
SingularAttribute<J,?>	getDeclaredSingularAttribute(String name)	Return the single-valued attribute declared by the managed type that corresponds to the specified name.
<Y> SingularPersistentAttribute<J,Y>	getDeclaredSingularAttribute(String name, Class<Y> javaType)	Return the single-valued attribute declared by the managed type that corresponds to the specified name and Java type.
Set<SingularAttribute<J,?>>	getDeclaredSingularAttributes()	Return the single-valued attributes declared by the managed type.
AttributeContainer.InFlightAccess<J>	getInFlightAccess()
ListPersistentAttribute<? super J,?>	getList(String name)	Return the List-valued attribute of the managed type that corresponds to the specified name.
<E> ListAttribute<? super J,E>	getList(String name, Class<E> elementType)	Return the List-valued attribute of the managed type that corresponds to the specified name and Java element type.
MapPersistentAttribute<? super J,?,?>	getMap(String name)	Return the Map-valued attribute of the managed type that corresponds to the specified name.
<K, V> MapAttribute<? super J,K,V>	getMap(String name, Class<K> keyType, Class<V> valueType)	Return the Map-valued attribute of the managed type that corresponds to the specified name and Java key and value types.
Set<PluralAttribute<? super J,?,?>>	getPluralAttributes()	Return all multi-valued attributes (Collection-, Set-, List-, and Map-valued attributes) of the managed type.
RepresentationMode	getRepresentationMode()
SetPersistentAttribute<? super J,?>	getSet(String name)	Return the Set-valued attribute of the managed type that corresponds to the specified name.
<E> SetAttribute<? super J,E>	getSet(String name, Class<E> elementType)	Return the Set-valued attribute of the managed type that corresponds to the specified name and Java element type.
SingularPersistentAttribute<? super J,?>	getSingularAttribute(String name)	Return the single-valued attribute of the managed type that corresponds to the specified name.
<Y> SingularPersistentAttribute<? super J,Y>	getSingularAttribute(String name, Class<Y> type)	Return the single-valued attribute of the managed type that corresponds to the specified name and Java type.
Set<SingularAttribute<? super J,?>>	getSingularAttributes()	Return the single-valued attributes of the managed type.
Collection<? extends ManagedDomainType<? extends J>>	getSubTypes()
ManagedDomainType<? super J>	getSuperType()	The descriptor of the supertype of this type.
String	getTypeName()	Get the type name.
protected <Y> boolean	isPrimitiveVariant(SingularAttribute<?,?> attribute, Class<Y> javaType)
String	toString()
void	visitAttributes(Consumer<? super PersistentAttribute<? super J,?>> action)
void	visitDeclaredAttributes(Consumer<? super PersistentAttribute<J,?>> action)
protected Object	writeReplace()

Methods inherited from class org.hibernate.metamodel.model.domain.AbstractDomainType

getBindableJavaType, getExpressibleJavaType, getJavaType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hibernate.metamodel.model.domain.DomainType

getSqmType, getTupleLength

Methods inherited from interface org.hibernate.query.sqm.SqmExpressible

getExpressibleJavaType, getRelationalJavaType, isInstance, resolveExpressible

Methods inherited from interface jakarta.persistence.metamodel.Type

getJavaType, getPersistenceType

Constructor Details

AbstractManagedType

protected AbstractManagedType(String hibernateTypeName,
 JavaType<J> javaType,
 ManagedDomainType<? super J> superType,
 JpaMetamodelImplementor metamodel)

Method Details

createInFlightAccess

protected AttributeContainer.InFlightAccess<J> createInFlightAccess()

getSuperType

public ManagedDomainType<? super J> getSuperType()

Description copied from interface: ManagedDomainType

The descriptor of the supertype of this type.

Specified by:

getSuperType in interface ManagedDomainType<J>

getSubTypes

public Collection<? extends ManagedDomainType<? extends J>> getSubTypes()

Specified by:

getSubTypes in interface ManagedDomainType<J>

addSubType

public void addSubType(ManagedDomainType<? extends J> subType)

Specified by:

addSubType in interface ManagedDomainType<J>

getRepresentationMode

public RepresentationMode getRepresentationMode()

Specified by:

getRepresentationMode in interface ManagedDomainType<J>

visitAttributes

public void visitAttributes(Consumer<? super PersistentAttribute<? super J,?>> action)

Specified by:

visitAttributes in interface ManagedDomainType<J>

visitDeclaredAttributes

public void visitDeclaredAttributes(Consumer<? super PersistentAttribute<J,?>> action)

Specified by:

visitDeclaredAttributes in interface ManagedDomainType<J>

getAttributes

public Set<Attribute<? super J,?>> getAttributes()

Description copied from interface: ManagedType

Return the attributes of the managed type.

Specified by:

getAttributes in interface ManagedType<J>

Returns:

attributes of the managed type

getDeclaredAttributes

public Set<Attribute<J,?>> getDeclaredAttributes()

Description copied from interface: ManagedType

Return the attributes declared by the managed type. Returns empty set if the managed type has no declared attributes.

Specified by:

getDeclaredAttributes in interface ManagedType<J>

Returns:

declared attributes of the managed type

getAttribute

public PersistentAttribute<? super J,?> getAttribute(String name)

Description copied from interface: ManagedType

Return the attribute of the managed type that corresponds to the specified name.

Specified by:

getAttribute in interface ManagedDomainType<J>

Specified by:

getAttribute in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

attribute with given name

findAttribute

public PersistentAttribute<? super J,?> findAttribute(String name)

Specified by:

findAttribute in interface ManagedDomainType<J>

findAttributeInSuperTypes

public PersistentAttribute<? super J,?> findAttributeInSuperTypes(String name)

Specified by:

findAttributeInSuperTypes in interface ManagedDomainType<J>

findSubTypesAttribute

public PersistentAttribute<?,?> findSubTypesAttribute(String name)

Specified by:

findSubTypesAttribute in interface ManagedDomainType<J>

findDeclaredAttribute

public PersistentAttribute<J,?> findDeclaredAttribute(String name)

Specified by:

findDeclaredAttribute in interface ManagedDomainType<J>

getDeclaredAttribute

public PersistentAttribute<J,?> getDeclaredAttribute(String name)

Description copied from interface: ManagedType

Return the attribute declared by the managed type that corresponds to the specified name.

Specified by:

getDeclaredAttribute in interface ManagedDomainType<J>

Specified by:

getDeclaredAttribute in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

attribute with given name

getTypeName

public String getTypeName()

Description copied from interface: ManagedDomainType

Get the type name.

Specified by:

getTypeName in interface ManagedDomainType<J>

Specified by:

getTypeName in interface SqmExpressible<J>

Returns:

The type name.

See Also:

• ManagedDomainType.getRepresentationMode()

getSingularAttributes

public Set<SingularAttribute<? super J,?>> getSingularAttributes()

Description copied from interface: ManagedType

Return the single-valued attributes of the managed type. Returns empty set if the managed type has no single-valued attributes.

Specified by:

getSingularAttributes in interface ManagedType<J>

Returns:

single-valued attributes

getDeclaredSingularAttributes

public Set<SingularAttribute<J,?>> getDeclaredSingularAttributes()

Description copied from interface: ManagedType

Return the single-valued attributes declared by the managed type. Returns empty set if the managed type has no declared single-valued attributes.

Specified by:

getDeclaredSingularAttributes in interface ManagedType<J>

Returns:

declared single-valued attributes

getSingularAttribute

public SingularPersistentAttribute<? super J,?> getSingularAttribute(String name)

Description copied from interface: ManagedType

Return the single-valued attribute of the managed type that corresponds to the specified name.

Specified by:

getSingularAttribute in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

single-valued attribute with the given name

findSingularAttribute

public SingularPersistentAttribute<? super J,?> findSingularAttribute(String name)

Specified by:

findSingularAttribute in interface ManagedDomainType<J>

getSingularAttribute

public <Y> SingularPersistentAttribute<? super J,Y> getSingularAttribute(String name,
 Class<Y> type)

Description copied from interface: ManagedType

Return the single-valued attribute of the managed type that corresponds to the specified name and Java type.

Specified by:

getSingularAttribute in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

type - the type of the represented attribute

Returns:

single-valued attribute with given name and type

getDeclaredSingularAttribute

public SingularAttribute<J,?> getDeclaredSingularAttribute(String name)

Description copied from interface: ManagedType

Return the single-valued attribute declared by the managed type that corresponds to the specified name.

Specified by:

getDeclaredSingularAttribute in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

declared single-valued attribute of the given name

findDeclaredSingularAttribute

public SingularPersistentAttribute<J,?> findDeclaredSingularAttribute(String name)

Specified by:

findDeclaredSingularAttribute in interface ManagedDomainType<J>

getDeclaredSingularAttribute

public <Y> SingularPersistentAttribute<J,Y> getDeclaredSingularAttribute(String name,
 Class<Y> javaType)

Description copied from interface: ManagedType

Return the single-valued attribute declared by the managed type that corresponds to the specified name and Java type.

Specified by:

getDeclaredSingularAttribute in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

javaType - the type of the represented attribute

Returns:

declared single-valued attribute of the given name and type

isPrimitiveVariant

protected <Y> boolean isPrimitiveVariant(SingularAttribute<?,?> attribute,
 Class<Y> javaType)

getPluralAttributes

public Set<PluralAttribute<? super J,?,?>> getPluralAttributes()

Description copied from interface: ManagedType

Return all multi-valued attributes (Collection-, Set-, List-, and Map-valued attributes) of the managed type. Returns empty set if the managed type has no multi-valued attributes.

Specified by:

getPluralAttributes in interface ManagedType<J>

Returns:

Collection-, Set-, List-, and Map-valued attributes

getDeclaredPluralAttributes

public Set<PluralAttribute<J,?,?>> getDeclaredPluralAttributes()

Description copied from interface: ManagedType

Return all multi-valued attributes (Collection-, Set-, List-, and Map-valued attributes) declared by the managed type. Returns empty set if the managed type has no declared multi-valued attributes.

Specified by:

getDeclaredPluralAttributes in interface ManagedType<J>

Returns:

declared Collection-, Set-, List-, and Map-valued attributes

findPluralAttribute

public PluralPersistentAttribute<? super J,?,?> findPluralAttribute(String name)

Specified by:

findPluralAttribute in interface ManagedDomainType<J>

findDeclaredPluralAttribute

public PluralPersistentAttribute<J,?,?> findDeclaredPluralAttribute(String name)

Specified by:

findDeclaredPluralAttribute in interface ManagedDomainType<J>

findConcreteGenericAttribute

public PersistentAttribute<? super J,?> findConcreteGenericAttribute(String name)

Specified by:

findConcreteGenericAttribute in interface ManagedDomainType<J>

findDeclaredConcreteGenericAttribute

public PersistentAttribute<J,?> findDeclaredConcreteGenericAttribute(String name)

Specified by:

findDeclaredConcreteGenericAttribute in interface ManagedDomainType<J>

getCollection

public BagPersistentAttribute<? super J,?> getCollection(String name)

Description copied from interface: ManagedType

Return the Collection-valued attribute of the managed type that corresponds to the specified name.

Specified by:

getCollection in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

CollectionAttribute of the given name

getDeclaredCollection

public CollectionAttribute<J,?> getDeclaredCollection(String name)

Description copied from interface: ManagedType

Return the Collection-valued attribute declared by the managed type that corresponds to the specified name.

Specified by:

getDeclaredCollection in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

declared CollectionAttribute of the given name

getCollection

public <E> BagPersistentAttribute<? super J,E> getCollection(String name,
 Class<E> elementType)

Description copied from interface: ManagedType

Return the Collection-valued attribute of the managed type that corresponds to the specified name and Java element type.

Specified by:

getCollection in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

elementType - the element type of the represented attribute

Returns:

CollectionAttribute of the given name and element type

getDeclaredCollection

public <E> CollectionAttribute<J,E> getDeclaredCollection(String name,
 Class<E> elementType)

Description copied from interface: ManagedType

Return the Collection-valued attribute declared by the managed type that corresponds to the specified name and Java element type.

Specified by:

getDeclaredCollection in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

elementType - the element type of the represented attribute

Returns:

declared CollectionAttribute of the given name and element type

getSet

public SetPersistentAttribute<? super J,?> getSet(String name)

Description copied from interface: ManagedType

Return the Set-valued attribute of the managed type that corresponds to the specified name.

Specified by:

getSet in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

SetAttribute of the given name

getDeclaredSet

public SetPersistentAttribute<J,?> getDeclaredSet(String name)

Description copied from interface: ManagedType

Return the Set-valued attribute declared by the managed type that corresponds to the specified name.

Specified by:

getDeclaredSet in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

declared SetAttribute of the given name

getSet

public <E> SetAttribute<? super J,E> getSet(String name,
 Class<E> elementType)

Description copied from interface: ManagedType

Return the Set-valued attribute of the managed type that corresponds to the specified name and Java element type.

Specified by:

getSet in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

elementType - the element type of the represented attribute

Returns:

SetAttribute of the given name and element type

getDeclaredSet

public <E> SetAttribute<J,E> getDeclaredSet(String name,
 Class<E> elementType)

Description copied from interface: ManagedType

Return the Set-valued attribute declared by the managed type that corresponds to the specified name and Java element type.

Specified by:

getDeclaredSet in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

elementType - the element type of the represented attribute

Returns:

declared SetAttribute of the given name and element type

getList

public ListPersistentAttribute<? super J,?> getList(String name)

Description copied from interface: ManagedType

Return the List-valued attribute of the managed type that corresponds to the specified name.

Specified by:

getList in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

ListAttribute of the given name

getDeclaredList

public ListPersistentAttribute<J,?> getDeclaredList(String name)

Description copied from interface: ManagedType

Return the List-valued attribute declared by the managed type that corresponds to the specified name.

Specified by:

getDeclaredList in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

declared ListAttribute of the given name

getList

public <E> ListAttribute<? super J,E> getList(String name,
 Class<E> elementType)

Description copied from interface: ManagedType

Return the List-valued attribute of the managed type that corresponds to the specified name and Java element type.

Specified by:

getList in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

elementType - the element type of the represented attribute

Returns:

ListAttribute of the given name and element type

getDeclaredList

public <E> ListAttribute<J,E> getDeclaredList(String name,
 Class<E> elementType)

Description copied from interface: ManagedType

Return the List-valued attribute declared by the managed type that corresponds to the specified name and Java element type.

Specified by:

getDeclaredList in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

elementType - the element type of the represented attribute

Returns:

declared ListAttribute of the given name and element type

getMap

public MapPersistentAttribute<? super J,?,?> getMap(String name)

Description copied from interface: ManagedType

Return the Map-valued attribute of the managed type that corresponds to the specified name.

Specified by:

getMap in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

MapAttribute of the given name

getDeclaredMap

public MapPersistentAttribute<J,?,?> getDeclaredMap(String name)

Description copied from interface: ManagedType

Return the Map-valued attribute declared by the managed type that corresponds to the specified name.

Specified by:

getDeclaredMap in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

Returns:

declared MapAttribute of the given name

getMap

public <K,
V> MapAttribute<? super J,K,V> getMap(String name,
 Class<K> keyType,
 Class<V> valueType)

Description copied from interface: ManagedType

Return the Map-valued attribute of the managed type that corresponds to the specified name and Java key and value types.

Specified by:

getMap in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

keyType - the key type of the represented attribute

valueType - the value type of the represented attribute

Returns:

MapAttribute of the given name and key and value types

getDeclaredMap

public <K,
V> MapAttribute<J,K,V> getDeclaredMap(String name,
 Class<K> keyType,
 Class<V> valueType)

Description copied from interface: ManagedType

Return the Map-valued attribute declared by the managed type that corresponds to the specified name and Java key and value types.

Specified by:

getDeclaredMap in interface ManagedType<J>

Parameters:

name - the name of the represented attribute

keyType - the key type of the represented attribute

valueType - the value type of the represented attribute

Returns:

declared MapAttribute of the given name and key and value types

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Throws:

ObjectStreamException

getInFlightAccess

public AttributeContainer.InFlightAccess<J> getInFlightAccess()

Specified by:

getInFlightAccess in interface AttributeContainer<J>

toString

public String toString()

Overrides:

toString in class Object