Hibernate ORM - hibernate-core 5.6.15.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 ArchiveDescriptorFactory	Returns: The ArchiveDescriptorFactory getArchiveDescriptorFactory() Deprecated Use `BootstrapContext#getArchiveDescriptorFactory()` instead. Access to the ArchiveDescriptorFactory to be used for scanning
public List<AttributeConverterInfo>	Returns: The AttributeConverterInfo registered through MetadataBuilder getAttributeConverters() Deprecated Use `BootstrapContext#getAttributeConverters()` instead Access to collected AttributeConverter definitions.
public List<AuxiliaryDatabaseObject>	Returns: The AuxiliaryDatabaseObject registered through MetadataBuilder getAuxiliaryDatabaseObjectList() Deprecated Use `BootstrapContext#getAuxiliaryDatabaseObjectList()` instead. Access to any AuxiliaryDatabaseObject explicitly registered with the MetadataBuilder.
public List<BasicTypeRegistration>	Returns: The BasicType registrations getBasicTypeRegistrations() Access the list of BasicType registrations.
public List<CacheRegionDefinition>	Returns: Explicit cache region mappings. getCacheRegionDefinitions() Deprecated Use `BootstrapContext#getClassmateContext()` instead. Access to all explicit cache region mappings.
public IdGeneratorStrategyInterpreter	getIdGenerationTypeInterpreter()
public AccessType	Returns: The implicit cache AccessType getImplicitCacheAccessType() Access to any implicit cache AccessType.
public ImplicitNamingStrategy	getImplicitNamingStrategy()
public IndexView	Returns: The Jandex index getJandexView() Deprecated Use `BootstrapContext#getJandexView()` instead. Access to the Jandex index passed by call to `org.hibernate.boot.MetadataBuilder#applyIndexView(org.jboss.jandex.IndexView)`, if any.
public MappingDefaults	Returns: The mapping defaults getMappingDefaults() Access to the mapping defaults.
public MultiTenancyStrategy	Returns: The MultiTenancyStrategy getMultiTenancyStrategy() Access to the MultiTenancyStrategy for this environment.
public PhysicalNamingStrategy	getPhysicalNamingStrategy()
public ReflectionManager	Returns: The Hibernate Commons Annotations ReflectionManager to use. getReflectionManager() Deprecated Use `BootstrapContext#getReflectionManager()` instead, The plan is to remove first `MetadataBuildingOptions#getReflectionManager()` keeping `BootstrapContext#getReflectionManager()` till the migration from Hibernate Commons Annotations to Jandex. Retrieve the Hibernate Commons Annotations ReflectionManager to use.
public ScanEnvironment	Returns: The scan environment getScanEnvironment() Deprecated Use `BootstrapContext#getScanEnvironment()` instead. Access to the environment for scanning.
public Object	Returns: The scanner getScanner() Deprecated Use `BootstrapContext#getScanner()` instead. Access to the Scanner to be used for scanning.
public ScanOptions	Returns: The scan options getScanOptions() Deprecated Use `BootstrapContext#getScanOptions()` instead. Access to the options to be used for scanning
public default String	getSchemaCharset()
public StandardServiceRegistry	Returns: The service registry getServiceRegistry() Access to the service registry.
public SharedCacheMode	Returns: The SharedCacheMode getSharedCacheMode() Access to the SharedCacheMode for determining whether we should perform second level caching or not.
public List<MetadataSourceType>	Returns: The order in which sources should be processed. getSourceProcessOrdering() Retrieve the ordering in which sources should be processed.
public Map<String, SQLFunction>	Returns: The SQLFunctions registered through MetadataBuilder getSqlFunctions() Deprecated Use `BootstrapContext#getSqlFunctions()` instead. Access to any SQL functions explicitly registered with the MetadataBuilder.
public ClassLoader	Returns: The tempo ClassLoader getTempClassLoader() Deprecated Use `BootstrapContext#getJpaTempClassLoader()` instead. Access the temporary ClassLoader passed to us as defined by `javax.persistence.spi.PersistenceUnitInfo#getNewTempClassLoader()`, if any.
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	Returns: `true` if not create constraint by default; `false` otherwise. isNoConstraintByDefault() Should we create constraint by 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 (e.g. NVARCHAR rather than VARCHAR) 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

getArchiveDescriptorFactory back to summary

getArchiveDescriptorFactory	back to summary
public ArchiveDescriptorFactory getArchiveDescriptorFactory() Deprecated Use `BootstrapContext#getArchiveDescriptorFactory()` instead. Access to the ArchiveDescriptorFactory to be used for scanning Returns:ArchiveDescriptorFactory The ArchiveDescriptorFactory Annotations @Deprecated

public ArchiveDescriptorFactory getArchiveDescriptorFactory()

Deprecated

Use BootstrapContext#getArchiveDescriptorFactory() instead.

Access to the ArchiveDescriptorFactory to be used for scanning

Returns:ArchiveDescriptorFactory

The ArchiveDescriptorFactory

Annotations

@Deprecated

getAttributeConverters back to summary

getAttributeConverters	back to summary
public List<AttributeConverterInfo> getAttributeConverters() Deprecated Use `BootstrapContext#getAttributeConverters()` instead Access to collected AttributeConverter definitions. Returns:List<AttributeConverterInfo> The AttributeConverterInfo registered through MetadataBuilder Annotations @Deprecated

public List<AttributeConverterInfo> getAttributeConverters()

Deprecated

Use BootstrapContext#getAttributeConverters() instead

Access to collected AttributeConverter definitions.

Returns:List<AttributeConverterInfo>

The AttributeConverterInfo registered through MetadataBuilder

Annotations

@Deprecated

getAuxiliaryDatabaseObjectList back to summary

getAuxiliaryDatabaseObjectList	back to summary
public List<AuxiliaryDatabaseObject> getAuxiliaryDatabaseObjectList() Deprecated Use `BootstrapContext#getAuxiliaryDatabaseObjectList()` instead. Access to any AuxiliaryDatabaseObject explicitly registered with the MetadataBuilder. This does not include AuxiliaryDatabaseObject defined in mappings. Returns:List<AuxiliaryDatabaseObject> The AuxiliaryDatabaseObject registered through MetadataBuilder Annotations @Deprecated

public List<AuxiliaryDatabaseObject> getAuxiliaryDatabaseObjectList()

Deprecated

Use BootstrapContext#getAuxiliaryDatabaseObjectList() instead.

Access to any AuxiliaryDatabaseObject explicitly registered with the MetadataBuilder. This does not include AuxiliaryDatabaseObject defined in mappings.

Returns:List<AuxiliaryDatabaseObject>

The AuxiliaryDatabaseObject registered through MetadataBuilder

Annotations

@Deprecated

getBasicTypeRegistrations back to summary

getBasicTypeRegistrations	back to summary
public List<BasicTypeRegistration> getBasicTypeRegistrations() Access the list of 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, java.lang.String[])` `org.hibernate.boot.MetadataBuilder#applyBasicType(org.hibernate.usertype.CompositeUserType, java.lang.String[])` Returns:List<BasicTypeRegistration> The BasicType registrations

public List<BasicTypeRegistration> getBasicTypeRegistrations()

Access the list of BasicType registrations. These are the BasicTypes explicitly registered via calls to:

Returns:List<BasicTypeRegistration>: The BasicType registrations

getCacheRegionDefinitions back to summary

getCacheRegionDefinitions	back to summary
public List<CacheRegionDefinition> getCacheRegionDefinitions() Deprecated Use `BootstrapContext#getClassmateContext()` instead. Access to all explicit cache region mappings. Returns:List<CacheRegionDefinition> Explicit cache region mappings. Annotations @Deprecated

public List<CacheRegionDefinition> getCacheRegionDefinitions()

Deprecated

Use BootstrapContext#getClassmateContext() instead.

Access to all explicit cache region mappings.

Returns:List<CacheRegionDefinition>

Explicit cache region mappings.

Annotations

@Deprecated

getIdGenerationTypeInterpreter	back to summary
public IdGeneratorStrategyInterpreter getIdGenerationTypeInterpreter()

getImplicitCacheAccessType	back to summary
public AccessType getImplicitCacheAccessType() Access to any implicit cache AccessType. Returns:AccessType The implicit cache AccessType

getImplicitCacheAccessType

back to summary

public AccessType getImplicitCacheAccessType()

Access to any implicit cache AccessType.

Returns:AccessType: The implicit cache AccessType

getImplicitNamingStrategy	back to summary
public ImplicitNamingStrategy getImplicitNamingStrategy()

getJandexView back to summary

getJandexView	back to summary
public IndexView getJandexView() Deprecated Use `BootstrapContext#getJandexView()` instead. Access to the Jandex index passed by call to `org.hibernate.boot.MetadataBuilder#applyIndexView(org.jboss.jandex.IndexView)`, if any. Returns:IndexView The Jandex index Annotations @Deprecated

public IndexView getJandexView()

Deprecated

Use BootstrapContext#getJandexView() instead.

Access to the Jandex index passed by call to org.hibernate.boot.MetadataBuilder#applyIndexView(org.jboss.jandex.IndexView), if any.

Returns:IndexView

The Jandex index

Annotations

@Deprecated

getMappingDefaults	back to summary
public MappingDefaults getMappingDefaults() Access to the mapping defaults. Returns:MappingDefaults The mapping defaults

getMappingDefaults

back to summary

public MappingDefaults getMappingDefaults()

Access to the mapping defaults.

Returns:MappingDefaults: The mapping defaults

getMultiTenancyStrategy	back to summary
public MultiTenancyStrategy getMultiTenancyStrategy() Access to the MultiTenancyStrategy for this environment. Returns:MultiTenancyStrategy The MultiTenancyStrategy

getMultiTenancyStrategy

back to summary

public MultiTenancyStrategy getMultiTenancyStrategy()

Access to the MultiTenancyStrategy for this environment.

Returns:MultiTenancyStrategy: The MultiTenancyStrategy

getPhysicalNamingStrategy	back to summary
public PhysicalNamingStrategy getPhysicalNamingStrategy()

getReflectionManager back to summary

getReflectionManager	back to summary
public ReflectionManager getReflectionManager() Deprecated Use `BootstrapContext#getReflectionManager()` instead, The plan is to remove first `MetadataBuildingOptions#getReflectionManager()` keeping `BootstrapContext#getReflectionManager()` till the migration from Hibernate Commons Annotations to Jandex. Retrieve the Hibernate Commons Annotations ReflectionManager to use. Returns:ReflectionManager The Hibernate Commons Annotations ReflectionManager to use. Annotations @Deprecated

public ReflectionManager getReflectionManager()

Deprecated

Use BootstrapContext#getReflectionManager() instead, The plan is to remove first MetadataBuildingOptions#getReflectionManager() keeping BootstrapContext#getReflectionManager() till the migration from Hibernate Commons Annotations to Jandex.

Retrieve the Hibernate Commons Annotations ReflectionManager to use.

Returns:ReflectionManager

The Hibernate Commons Annotations ReflectionManager to use.

Annotations

@Deprecated

getScanEnvironment back to summary

getScanEnvironment	back to summary
public ScanEnvironment getScanEnvironment() Deprecated Use `BootstrapContext#getScanEnvironment()` instead. Access to the environment for scanning. Consider this temporary; see discussion on `ScanEnvironment` Returns:ScanEnvironment The scan environment Annotations @Deprecated

public ScanEnvironment getScanEnvironment()

Deprecated

Use BootstrapContext#getScanEnvironment() instead.

Access to the environment for scanning. Consider this temporary; see discussion on ScanEnvironment

Returns:ScanEnvironment

The scan environment

Annotations

@Deprecated

getScanner back to summary

getScanner	back to summary
public Object getScanner() Deprecated Use `BootstrapContext#getScanner()` instead. Access to the Scanner to be used for scanning. Can be: A Scanner instance A Class reference to the Scanner implementor A String naming the Scanner implementor Returns:Object The scanner Annotations @Deprecated

public Object getScanner()

Deprecated

Use BootstrapContext#getScanner() instead.

Access to the Scanner to be used for scanning. Can be:

A Scanner instance
A Class reference to the Scanner implementor
A String naming the Scanner implementor

Returns:Object

The scanner

Annotations

@Deprecated

getScanOptions back to summary

getScanOptions	back to summary
public ScanOptions getScanOptions() Deprecated Use `BootstrapContext#getScanOptions()` instead. Access to the options to be used for scanning Returns:ScanOptions The scan options Annotations @Deprecated

public ScanOptions getScanOptions()

Deprecated

Use BootstrapContext#getScanOptions() instead.

Access to the options to be used for scanning

Returns:ScanOptions

The scan options

Annotations

@Deprecated

getSchemaCharset	back to summary
public default String getSchemaCharset()

getServiceRegistry	back to summary
public StandardServiceRegistry getServiceRegistry() Access to the service registry. Returns:StandardServiceRegistry The service registry

getServiceRegistry

back to summary

public StandardServiceRegistry getServiceRegistry()

Access to the service registry.

Returns:StandardServiceRegistry: The service registry

getSharedCacheMode	back to summary
public SharedCacheMode getSharedCacheMode() Access to the SharedCacheMode for determining whether we should perform second level caching or not. Returns:SharedCacheMode The SharedCacheMode

getSharedCacheMode

back to summary

public SharedCacheMode getSharedCacheMode()

Access to the SharedCacheMode for determining whether we should perform second level caching or not.

Returns:SharedCacheMode: The SharedCacheMode

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.

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.

getSqlFunctions back to summary

getSqlFunctions	back to summary
public Map<String, SQLFunction> getSqlFunctions() Deprecated Use `BootstrapContext#getSqlFunctions()` instead. Access to any SQL functions explicitly registered with the MetadataBuilder. This does not include Dialect defined functions, etc. Returns:Map<String, SQLFunction> The SQLFunctions registered through MetadataBuilder Annotations @Deprecated

public Map<String, SQLFunction> getSqlFunctions()

Deprecated

Use BootstrapContext#getSqlFunctions() instead.

Access to any SQL functions explicitly registered with the MetadataBuilder. This does not include Dialect defined functions, etc.

Returns:Map<String, SQLFunction>

The SQLFunctions registered through MetadataBuilder

Annotations

@Deprecated

getTempClassLoader back to summary

getTempClassLoader	back to summary
public ClassLoader getTempClassLoader() Deprecated Use `BootstrapContext#getJpaTempClassLoader()` instead. Access the temporary ClassLoader passed to us as defined by `javax.persistence.spi.PersistenceUnitInfo#getNewTempClassLoader()`, if any. Returns:ClassLoader The tempo ClassLoader Annotations @Deprecated

public ClassLoader getTempClassLoader()

Deprecated

Use BootstrapContext#getJpaTempClassLoader() instead.

Access the temporary ClassLoader passed to us as defined by javax.persistence.spi.PersistenceUnitInfo#getNewTempClassLoader(), if any.

Returns:ClassLoader

The tempo ClassLoader

Annotations

@Deprecated

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

isNoConstraintByDefault back to summary

isNoConstraintByDefault	back to summary
public boolean isNoConstraintByDefault() Should we create constraint by default? Returns:boolean `true` if not create constraint by default; `false` otherwise. See Also `javax.persistence.ConstraintMode#PROVIDER_DEFAULT`, `org.hibernate.cfg.AvailableSettings#DEFAULT_CONSTRAINT_MODE`

public boolean isNoConstraintByDefault()

Should we create constraint by default?

Returns:boolean: true if not create constraint by default; false otherwise.
See Also: javax.persistence.ConstraintMode#PROVIDER_DEFAULT, org.hibernate.cfg.AvailableSettings#DEFAULT_CONSTRAINT_MODE

isSpecjProprietarySyntaxEnabled	back to summary
public boolean isSpecjProprietarySyntaxEnabled()

isXmlMappingEnabled	back to summary
public default boolean isXmlMappingEnabled()

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 (e.g. NVARCHAR rather than VARCHAR) by default? 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 (e.g. NVARCHAR rather than VARCHAR) by default?

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