Interface ManagedDomainType<J>

All Superinterfaces:

DomainType<J>, ManagedType<J>, Type<J>

All Known Subinterfaces:

EmbeddableDomainType<J>, EntityDomainType<J>, IdentifiableDomainType<J>, MappedSuperclassDomainType<J>, SqmEmbeddableDomainType<E>, SqmEntityDomainType<E>, SqmManagedDomainType<J>, SqmMappedSuperclassDomainType<T>, SqmTreatableDomainType<T>, TreatableDomainType<J>

All Known Implementing Classes:

SqmPolymorphicRootDescriptor

public interface ManagedDomainType<J>
extends DomainType<J>, ManagedType<J>

Extensions to the JPA-defined ManagedType contract.

Nested Class Summary

Nested classes/interfaces inherited from interface Type

Type.PersistenceType

Method Summary

Modifier and Type	Method	Description
void	addSubType(ManagedDomainType<? extends J> subType)
@Nullable PersistentAttribute<? super J, ?>	findAttribute(String name)
default @Nullable PersistentAttribute<? super J, ?>	findAttributeInSuperTypes(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Use findAttribute(String)
@Nullable PersistentAttribute<? super J, ?>	findConcreteGenericAttribute(String name)
@Nullable PersistentAttribute<J,?>	findDeclaredAttribute(String name)
@Nullable PersistentAttribute<J,?>	findDeclaredConcreteGenericAttribute(String name)
@Nullable PluralPersistentAttribute<J,?,?>	findDeclaredPluralAttribute(String name)
@Nullable SingularPersistentAttribute<J,?>	findDeclaredSingularAttribute(String name)
@Nullable PluralPersistentAttribute<? super J, ?, ?>	findPluralAttribute(String name)
@Nullable SingularPersistentAttribute<? super J, ?>	findSingularAttribute(String name)
@Nullable PersistentAttribute<?,?>	findSubTypesAttribute(String name)
PersistentAttribute<? super J, ?>	getAttribute(String name)
PersistentAttribute<J,?>	getDeclaredAttribute(String name)
default Class<J>	getJavaType()	The Java class of the entity type.
JpaMetamodel	getMetamodel()	The parent metamodel.
RepresentationMode	getRepresentationMode()	The representation mode.
Collection<? extends ManagedDomainType<? extends J>>	getSubTypes()	The descriptors of all known managed subtypes of this type.
@Nullable ManagedDomainType<? super J>	getSuperType()	The descriptor of the supertype of this type.
String	getTypeName()	The name of the managed type.
void	visitAttributes(Consumer<? super PersistentAttribute<? super J, ?>> action)
void	visitDeclaredAttributes(Consumer<? super PersistentAttribute<J,?>> action)

Methods inherited from interface DomainType

getExpressibleJavaType

Methods inherited from interface ManagedType

getAttributes, getCollection, getCollection, getDeclaredAttributes, getDeclaredCollection, getDeclaredCollection, getDeclaredList, getDeclaredList, getDeclaredMap, getDeclaredMap, getDeclaredPluralAttributes, getDeclaredSet, getDeclaredSet, getDeclaredSingularAttribute, getDeclaredSingularAttribute, getDeclaredSingularAttributes, getList, getList, getMap, getMap, getPluralAttributes, getSet, getSet, getSingularAttribute, getSingularAttribute, getSingularAttributes

Methods inherited from interface Type

getPersistenceType

Method Details

getTypeName

String getTypeName()

The name of the managed type.

Specified by:

getTypeName in interface DomainType<J>

See Also:

• getRepresentationMode()

API Note:

This usually returns the name of the Java class. However, for dynamic models, this returns the symbolic name since the Java type is Map.

getMetamodel

JpaMetamodel getMetamodel()

The parent metamodel.

getRepresentationMode

RepresentationMode getRepresentationMode()

The representation mode.

Returns:

POJO for Java class entities, or MAP for dynamic entities.

getJavaType

default Class<J> getJavaType()

The Java class of the entity type.

Specified by:

getJavaType in interface DomainType<J>

Specified by:

getJavaType in interface Type<J>

See Also:

• Type.getJavaType()

getSuperType

@Nullable ManagedDomainType<? super J> getSuperType()

The descriptor of the supertype of this type.

getSubTypes

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

The descriptors of all known managed subtypes of this type.

addSubType

@Internal
void addSubType(ManagedDomainType<? extends J> subType)

visitAttributes

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

visitDeclaredAttributes

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

getAttribute

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

Specified by:

getAttribute in interface ManagedType<J>

getDeclaredAttribute

PersistentAttribute<J,?> getDeclaredAttribute(String name)

Specified by:

getDeclaredAttribute in interface ManagedType<J>

findAttribute

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

findSubTypesAttribute

@Nullable PersistentAttribute<?,?> findSubTypesAttribute(String name)

findAttributeInSuperTypes

@Deprecated(since="7.0",
            forRemoval=true)
default @Nullable PersistentAttribute<? super J, ?> findAttributeInSuperTypes(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

Use findAttribute(String)

findSingularAttribute

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

findPluralAttribute

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

findConcreteGenericAttribute

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

findDeclaredAttribute

@Nullable PersistentAttribute<J,?> findDeclaredAttribute(String name)

findDeclaredSingularAttribute

@Nullable SingularPersistentAttribute<J,?> findDeclaredSingularAttribute(String name)

findDeclaredPluralAttribute

@Nullable PluralPersistentAttribute<J,?,?> findDeclaredPluralAttribute(String name)

findDeclaredConcreteGenericAttribute

@Nullable PersistentAttribute<J,?> findDeclaredConcreteGenericAttribute(String name)