Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.boot.spi.MetadataBuildingOptions

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` indicates we should do discrimination; `false` we should not. createImplicitDiscriminatorsForJoinedInheritance() Whether we should do discrimination implicitly joined subclass style inheritance when no discriminator info is provided.
public default boolean	disallowExtensionsInCdi() Deprecated for removal. Use `isAllowExtensionsInCdi()` Check to see if extensions can be hosted in CDI
public List<BasicTypeRegistration>	Returns: The `BasicTypes` registrations getBasicTypeRegistrations() Access the list of `org.hibernate.type.BasicType` registrations.
public ColumnOrderingStrategy	getColumnOrderingStrategy()
public List<CompositeUserType<?>>	getCompositeUserTypes() Access the list of `CompositeUserType` registrations.
public TimeZoneStorageStrategy	Returns: the `TimeZoneStorageStrategy` determined by the global configuration property and the time zone support of the configured `org.hibernate.dialect.Dialect` getDefaultTimeZoneStorage()
public IdentifierGeneratorFactory	getIdentifierGeneratorFactory() The service implementing `IdentifierGeneratorFactory`.
public AccessType	Returns: The implicit cache `AccessType` getImplicitCacheAccessType() Access to any implicit cache `AccessType`.
public ImplicitNamingStrategy	getImplicitNamingStrategy()
public default ManagedTypeRepresentationResolver	getManagedTypeRepresentationResolver()
public MappingDefaults	getMappingDefaults() Access to the `MappingDefaults`.
public default CollectionSemanticsResolver	getPersistentCollectionRepresentationResolver()
public PhysicalNamingStrategy	getPhysicalNamingStrategy()
public default String	getSchemaCharset()
public StandardServiceRegistry	getServiceRegistry() Access to the `StandardServiceRegistry`.
public SharedCacheMode	Returns: The `SharedCacheMode` getSharedCacheMode() Access to the `SharedCacheMode` to determine if the second-level cache is enabled.
public List<MetadataSourceType>	Returns: The order in which sources should be processed. getSourceProcessOrdering() Retrieve the ordering in which sources should be processed.
public TimeZoneSupport	Returns: the `TimeZoneSupport` of the configured `org.hibernate.dialect.Dialect` getTimeZoneSupport()
public TypeConfiguration	Returns: the `TypeConfiguration` belonging to the `BootstrapContext` getTypeConfiguration()
public WrapperArrayHandling	Returns: the `WrapperArrayHandling` to use for wrapper arrays `Byte[]` and `Character[]`. getWrapperArrayHandling()
public boolean	Returns: `true` indicates they should be ignored; `false` indicates they should not be ignored. ignoreExplicitDiscriminatorsForJoinedInheritance() Whether explicit discriminator declarations should be ignored for joined subclass style inheritance.
public boolean	isAllowExtensionsInCdi() Check to see if extensions can be hosted in CDI
public boolean	Returns: `true` is multi-tenancy is enabled isMultiTenancyEnabled() Is multi-tenancy enabled?
public boolean	Returns: `true` if we should not create constraints by default; `false` if we should. isNoConstraintByDefault() Should we disable constraint creation when `jakarta.persistence.ConstraintMode#PROVIDER_DEFAULT`?
public boolean	isSpecjProprietarySyntaxEnabled()
public default boolean	isXmlMappingEnabled()
public boolean	Returns: `true` indicates we should force the discriminator in selects for any mappings which do not say explicitly. shouldImplicitlyForceDiscriminatorInSelect() Whether we should implicitly force discriminators into SQL selects.
public boolean	Returns: `true` if nationalized character data should be used by default; `false` otherwise. useNationalizedCharacterData() Should we use nationalized variants of character data by default?

Method Detail

createImplicitDiscriminatorsForJoinedInheritance back to summary

createImplicitDiscriminatorsForJoinedInheritance	back to summary
public boolean createImplicitDiscriminatorsForJoinedInheritance() Whether we should do discrimination implicitly joined subclass style inheritance when no discriminator info is provided. Returns:boolean `true` indicates we should do discrimination; `false` we should not. See Also `org.hibernate.boot.MetadataBuilder#enableImplicitDiscriminatorsForJoinedSubclassSupport`, `org.hibernate.cfg.AvailableSettings#IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS`

public boolean createImplicitDiscriminatorsForJoinedInheritance()

Whether we should do discrimination implicitly joined subclass style inheritance when no discriminator info is provided.

Returns:boolean: true indicates we should do discrimination; false we should not.
See Also: org.hibernate.boot.MetadataBuilder#enableImplicitDiscriminatorsForJoinedSubclassSupport, org.hibernate.cfg.AvailableSettings#IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS

disallowExtensionsInCdi back to summary

disallowExtensionsInCdi	back to summary
public default boolean disallowExtensionsInCdi() Deprecated for removal. Use `isAllowExtensionsInCdi()` Check to see if extensions can be hosted in CDI Annotations @Deprecated forRemoval:true

public default boolean disallowExtensionsInCdi()

Deprecated

for removal.

Use isAllowExtensionsInCdi()

Check to see if extensions can be hosted in CDI

Annotations

@Deprecated
forRemoval:true

getBasicTypeRegistrations back to summary

getBasicTypeRegistrations	back to summary
public List<BasicTypeRegistration> getBasicTypeRegistrations() Access the list of `org.hibernate.type.BasicType` registrations. These are the `BasicTypes` explicitly registered via calls to: `org.hibernate.boot.MetadataBuilder#applyBasicType(org.hibernate.type.BasicType)` `org.hibernate.boot.MetadataBuilder#applyBasicType(org.hibernate.type.BasicType, String[])` `org.hibernate.boot.MetadataBuilder#applyBasicType(org.hibernate.usertype.UserType, String[])` Returns:List<BasicTypeRegistration> The `BasicTypes` registrations

public List<BasicTypeRegistration> getBasicTypeRegistrations()

Access the list of org.hibernate.type.BasicType registrations.

These are the BasicTypes explicitly registered via calls to:

Returns:List<BasicTypeRegistration>: The BasicTypes registrations

getColumnOrderingStrategy	back to summary
public ColumnOrderingStrategy getColumnOrderingStrategy() See Also `org.hibernate.cfg.AvailableSettings#COLUMN_ORDERING_STRATEGY`

getCompositeUserTypes	back to summary
public List<CompositeUserType<?>> getCompositeUserTypes() Access the list of `CompositeUserType` registrations.

getDefaultTimeZoneStorage	back to summary
public TimeZoneStorageStrategy getDefaultTimeZoneStorage() Returns:TimeZoneStorageStrategy the `TimeZoneStorageStrategy` determined by the global configuration property and the time zone support of the configured `org.hibernate.dialect.Dialect` See Also `org.hibernate.cfg.AvailableSettings#TIMEZONE_DEFAULT_STORAGE`, `org.hibernate.dialect.Dialect#getTimeZoneSupport()`

getIdentifierGeneratorFactory back to summary

getIdentifierGeneratorFactory	back to summary
public IdentifierGeneratorFactory getIdentifierGeneratorFactory() The service implementing `IdentifierGeneratorFactory`. Implementation Note Almost always a `org.hibernate.id.factory.internal.StandardIdentifierGeneratorFactory`.

public IdentifierGeneratorFactory getIdentifierGeneratorFactory()

The service implementing IdentifierGeneratorFactory.

Implementation Note

Almost always a org.hibernate.id.factory.internal.StandardIdentifierGeneratorFactory.

getImplicitCacheAccessType back to summary

getImplicitCacheAccessType	back to summary
public AccessType getImplicitCacheAccessType() Access to any implicit cache `AccessType`. Returns:AccessType The implicit cache `AccessType` See Also `org.hibernate.cfg.AvailableSettings#DEFAULT_CACHE_CONCURRENCY_STRATEGY`

public AccessType getImplicitCacheAccessType()

Access to any implicit cache AccessType.

Returns:AccessType: The implicit cache AccessType
See Also: org.hibernate.cfg.AvailableSettings#DEFAULT_CACHE_CONCURRENCY_STRATEGY

getImplicitNamingStrategy	back to summary
public ImplicitNamingStrategy getImplicitNamingStrategy() See Also `org.hibernate.cfg.AvailableSettings#IMPLICIT_NAMING_STRATEGY`

getManagedTypeRepresentationResolver	back to summary
public default ManagedTypeRepresentationResolver getManagedTypeRepresentationResolver()

getMappingDefaults	back to summary
public MappingDefaults getMappingDefaults() Access to the `MappingDefaults`.

getPersistentCollectionRepresentationResolver	back to summary
public default CollectionSemanticsResolver getPersistentCollectionRepresentationResolver()

getPhysicalNamingStrategy	back to summary
public PhysicalNamingStrategy getPhysicalNamingStrategy() See Also `org.hibernate.cfg.AvailableSettings#PHYSICAL_NAMING_STRATEGY`

getSchemaCharset	back to summary
public default String getSchemaCharset() See Also `org.hibernate.cfg.AvailableSettings#HBM2DDL_CHARSET_NAME`

getServiceRegistry	back to summary
public StandardServiceRegistry getServiceRegistry() Access to the `StandardServiceRegistry`.

getSharedCacheMode back to summary

getSharedCacheMode	back to summary
public SharedCacheMode getSharedCacheMode() Access to the `SharedCacheMode` to determine if the second-level cache is enabled. Returns:SharedCacheMode The `SharedCacheMode` See Also `org.hibernate.cfg.AvailableSettings#JAKARTA_SHARED_CACHE_MODE`

public SharedCacheMode getSharedCacheMode()

Access to the SharedCacheMode to determine if the second-level cache is enabled.

Returns:SharedCacheMode: The SharedCacheMode
See Also: org.hibernate.cfg.AvailableSettings#JAKARTA_SHARED_CACHE_MODE

getSourceProcessOrdering back to summary

getSourceProcessOrdering	back to summary
public List<MetadataSourceType> getSourceProcessOrdering() Retrieve the ordering in which sources should be processed. Returns:List<MetadataSourceType> The order in which sources should be processed. See Also `org.hibernate.cfg.AvailableSettings#ARTIFACT_PROCESSING_ORDER`

public List<MetadataSourceType> getSourceProcessOrdering()

Retrieve the ordering in which sources should be processed.

Returns:List<MetadataSourceType>: The order in which sources should be processed.
See Also: org.hibernate.cfg.AvailableSettings#ARTIFACT_PROCESSING_ORDER

getTimeZoneSupport	back to summary
public TimeZoneSupport getTimeZoneSupport() Returns:TimeZoneSupport the `TimeZoneSupport` of the configured `org.hibernate.dialect.Dialect` See Also `org.hibernate.dialect.Dialect#getTimeZoneSupport()`

getTypeConfiguration	back to summary
public TypeConfiguration getTypeConfiguration() Returns:TypeConfiguration the `TypeConfiguration` belonging to the `BootstrapContext`

getWrapperArrayHandling	back to summary
public WrapperArrayHandling getWrapperArrayHandling() Returns:WrapperArrayHandling the `WrapperArrayHandling` to use for wrapper arrays `Byte[]` and `Character[]`. See Also `org.hibernate.cfg.AvailableSettings#WRAPPER_ARRAY_HANDLING`

ignoreExplicitDiscriminatorsForJoinedInheritance back to summary

ignoreExplicitDiscriminatorsForJoinedInheritance	back to summary
public boolean ignoreExplicitDiscriminatorsForJoinedInheritance() Whether explicit discriminator declarations should be ignored for joined subclass style inheritance. Returns:boolean `true` indicates they should be ignored; `false` indicates they should not be ignored. See Also `org.hibernate.boot.MetadataBuilder#enableExplicitDiscriminatorsForJoinedSubclassSupport`, `org.hibernate.cfg.AvailableSettings#IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS`

public boolean ignoreExplicitDiscriminatorsForJoinedInheritance()

Whether explicit discriminator declarations should be ignored for joined subclass style inheritance.

Returns:boolean: true indicates they should be ignored; false indicates they should not be ignored.
See Also: org.hibernate.boot.MetadataBuilder#enableExplicitDiscriminatorsForJoinedSubclassSupport, org.hibernate.cfg.AvailableSettings#IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS

isAllowExtensionsInCdi	back to summary
public boolean isAllowExtensionsInCdi() Check to see if extensions can be hosted in CDI

isMultiTenancyEnabled back to summary

isMultiTenancyEnabled	back to summary
public boolean isMultiTenancyEnabled() Is multi-tenancy enabled? Multi-tenancy is enabled implicitly if a `MultiTenantConnectionProvider` is available. Returns:boolean `true` is multi-tenancy is enabled See Also `org.hibernate.cfg.AvailableSettings#MULTI_TENANT_CONNECTION_PROVIDER`

public boolean isMultiTenancyEnabled()

Is multi-tenancy enabled?

Multi-tenancy is enabled implicitly if a MultiTenantConnectionProvider is available.

Returns:boolean: true is multi-tenancy is enabled
See Also: org.hibernate.cfg.AvailableSettings#MULTI_TENANT_CONNECTION_PROVIDER

isNoConstraintByDefault back to summary

isNoConstraintByDefault	back to summary
public boolean isNoConstraintByDefault() Should we disable constraint creation when `jakarta.persistence.ConstraintMode#PROVIDER_DEFAULT`? Returns:boolean `true` if we should not create constraints by default; `false` if we should. See Also `jakarta.persistence.ConstraintMode#PROVIDER_DEFAULT`, `org.hibernate.cfg.AvailableSettings#HBM2DDL_DEFAULT_CONSTRAINT_MODE`

public boolean isNoConstraintByDefault()

Should we disable constraint creation when jakarta.persistence.ConstraintMode#PROVIDER_DEFAULT?

Returns:boolean: true if we should not create constraints by default; false if we should.
See Also: jakarta.persistence.ConstraintMode#PROVIDER_DEFAULT, org.hibernate.cfg.AvailableSettings#HBM2DDL_DEFAULT_CONSTRAINT_MODE

isSpecjProprietarySyntaxEnabled	back to summary
public boolean isSpecjProprietarySyntaxEnabled()

isXmlMappingEnabled	back to summary
public default boolean isXmlMappingEnabled() See Also `org.hibernate.cfg.AvailableSettings#XML_MAPPING_ENABLED`

shouldImplicitlyForceDiscriminatorInSelect back to summary

shouldImplicitlyForceDiscriminatorInSelect	back to summary
public boolean shouldImplicitlyForceDiscriminatorInSelect() Whether we should implicitly force discriminators into SQL selects. By default, Hibernate will not. This can be specified per discriminator in the mapping as well. Returns:boolean `true` indicates we should force the discriminator in selects for any mappings which do not say explicitly. See Also `org.hibernate.cfg.AvailableSettings#FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT`

public boolean shouldImplicitlyForceDiscriminatorInSelect()

Whether we should implicitly force discriminators into SQL selects. By default, Hibernate will not. This can be specified per discriminator in the mapping as well.

Returns:boolean: true indicates we should force the discriminator in selects for any mappings which do not say explicitly.
See Also: org.hibernate.cfg.AvailableSettings#FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT

useNationalizedCharacterData back to summary

useNationalizedCharacterData	back to summary
public boolean useNationalizedCharacterData() Should we use nationalized variants of character data by default? For example, should `NVARCHAR` be used in preference to `VARCHAR`? Returns:boolean `true` if nationalized character data should be used by default; `false` otherwise. See Also `org.hibernate.boot.MetadataBuilder#enableGlobalNationalizedCharacterDataSupport`, `org.hibernate.cfg.AvailableSettings#USE_NATIONALIZED_CHARACTER_DATA`

public boolean useNationalizedCharacterData()

Should we use nationalized variants of character data by default?

For example, should NVARCHAR be used in preference to VARCHAR?

Returns:boolean: true if nationalized character data should be used by default; false otherwise.
See Also: org.hibernate.boot.MetadataBuilder#enableGlobalNationalizedCharacterDataSupport, org.hibernate.cfg.AvailableSettings#USE_NATIONALIZED_CHARACTER_DATA

public Interface MetadataBuildingOptions

Method Summary

Method Detail