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

Method Summary

Modifier and Type	Method and Description
public ArchiveDescriptorFactory	Returns: The `ArchiveDescriptorFactory` getArchiveDescriptorFactory() Access to the `ArchiveDescriptorFactory` used for scanning.
public Collection<ConverterDescriptor>	Returns: The `ConverterDescriptor`s registered via `MetadataBuilder` getAttributeConverters() Access to collected `jakarta.persistence.AttributeConverter` definitions.
public Collection<AuxiliaryDatabaseObject>	Returns: The `AuxiliaryDatabaseObject`s registered via `MetadataBuilder` getAuxiliaryDatabaseObjectList() Access to any `AuxiliaryDatabaseObject`s explicitly registered with the `org.hibernate.boot.MetadataBuilder`.
public Collection<CacheRegionDefinition>	Returns: Explicit cache region mappings getCacheRegionDefinitions() Access to all explicit cache region mappings.
public ClassLoaderAccess	getClassLoaderAccess() Access to class loading capabilities.
public ClassmateContext	Returns: Access to the shared `ClassmateContext` delegates. getClassmateContext() Access to the shared `ClassmateContext` object used throughout the bootstrap process.
public BeanInstanceProducer	getCustomTypeProducer() The `BeanInstanceProducer` to use when creating custom type references.
public SqmFunctionRegistry	getFunctionRegistry() The `SqmFunctionRegistry` belonging to this `BootstrapContext`.
public default IdentifierGeneratorFactory	getIdentifierGeneratorFactory()
public IndexView	Returns: The Jandex index getJandexView() Access to the Jandex index passed by call to `org.hibernate.boot.MetadataBuilder#applyIndexView(IndexView)`, if any.
public MutableJpaCompliance	getJpaCompliance() In-flight form of `org.hibernate.jpa.spi.JpaCompliance`
public ClassLoader	Returns: The temporary `ClassLoader` getJpaTempClassLoader() Access the temporary `ClassLoader` passed to us, as defined by `jakarta.persistence.spi.PersistenceUnitInfo#getNewTempClassLoader()`, if any.
public MetadataBuildingOptions	getMetadataBuildingOptions() Options specific to building the boot metamodel
public ReflectionManager	getReflectionManager() Retrieve the Hibernate Commons Annotations `ReflectionManager`.
public ManagedTypeRepresentationResolver	getRepresentationStrategySelector()
public ScanEnvironment	Returns: The scan environment getScanEnvironment() Access to the environment for scanning.
public Object	Returns: The scanner getScanner() Access to the `org.hibernate.boot.archive.scan.spi.Scanner` to be used for scanning.
public ScanOptions	Returns: The scan options getScanOptions() Access to the options to be used for scanning.
public StandardServiceRegistry	getServiceRegistry() The service registry available to bootstrapping
public Map<String, SqmFunctionDescriptor>	Returns: The `SqmFunctionDescriptor`s registered via `MetadataBuilder` getSqlFunctions() Access to any SQL functions explicitly registered with the `org.hibernate.boot.MetadataBuilder`.
public TypeConfiguration	getTypeConfiguration() The `TypeConfiguration` belonging to this `BootstrapContext`.
public boolean	isJpaBootstrap() Whether the bootstrap was initiated from JPA bootstrapping.
public void	markAsJpaBootstrap() Indicates that bootstrap was initiated from JPA bootstrapping.
public void	registerAdHocBasicType(BasicType<?> basicType) To support Envers.
public void	release() Releases the "bootstrap only" resources held by this `BootstrapContext`.
public <T> BasicType<T>	resolveAdHocBasicType(String key) To support Envers.

Method Detail

getArchiveDescriptorFactory back to summary

getArchiveDescriptorFactory	back to summary
public ArchiveDescriptorFactory getArchiveDescriptorFactory() Access to the `ArchiveDescriptorFactory` used for scanning. Returns:ArchiveDescriptorFactory The `ArchiveDescriptorFactory`

public ArchiveDescriptorFactory getArchiveDescriptorFactory()

Access to the ArchiveDescriptorFactory used for scanning.

Returns:ArchiveDescriptorFactory: The ArchiveDescriptorFactory

getAttributeConverters back to summary

getAttributeConverters	back to summary
public Collection<ConverterDescriptor> getAttributeConverters() Access to collected `jakarta.persistence.AttributeConverter` definitions. Should never return `null`. Returns:Collection<ConverterDescriptor> The `ConverterDescriptor`s registered via `MetadataBuilder`

public Collection<ConverterDescriptor> getAttributeConverters()

Access to collected jakarta.persistence.AttributeConverter definitions.

Should never return null.

Returns:Collection<ConverterDescriptor>: The ConverterDescriptors registered via MetadataBuilder

getAuxiliaryDatabaseObjectList back to summary

getAuxiliaryDatabaseObjectList	back to summary
public Collection<AuxiliaryDatabaseObject> getAuxiliaryDatabaseObjectList() Access to any `AuxiliaryDatabaseObject`s explicitly registered with the `org.hibernate.boot.MetadataBuilder`. This does not include `AuxiliaryDatabaseObject`s defined in mappings. Should never return `null`. Returns:Collection<AuxiliaryDatabaseObject> The `AuxiliaryDatabaseObject`s registered via `MetadataBuilder`

public Collection<AuxiliaryDatabaseObject> getAuxiliaryDatabaseObjectList()

Access to any AuxiliaryDatabaseObjects explicitly registered with the org.hibernate.boot.MetadataBuilder. This does not include AuxiliaryDatabaseObjects defined in mappings.

Should never return null.

Returns:Collection<AuxiliaryDatabaseObject>: The AuxiliaryDatabaseObjects registered via MetadataBuilder

getCacheRegionDefinitions back to summary

getCacheRegionDefinitions	back to summary
public Collection<CacheRegionDefinition> getCacheRegionDefinitions() Access to all explicit cache region mappings. Should never return `null`. Returns:Collection<CacheRegionDefinition> Explicit cache region mappings

public Collection<CacheRegionDefinition> getCacheRegionDefinitions()

Access to all explicit cache region mappings.

Should never return null.

Returns:Collection<CacheRegionDefinition>: Explicit cache region mappings

getClassLoaderAccess	back to summary
public ClassLoaderAccess getClassLoaderAccess() Access to class loading capabilities.

getClassmateContext back to summary

getClassmateContext	back to summary
public ClassmateContext getClassmateContext() Access to the shared `ClassmateContext` object used throughout the bootstrap process. Returns:ClassmateContext Access to the shared `ClassmateContext` delegates.

public ClassmateContext getClassmateContext()

Access to the shared ClassmateContext object used throughout the bootstrap process.

Returns:ClassmateContext: Access to the shared ClassmateContext delegates.

getCustomTypeProducer	back to summary
public BeanInstanceProducer getCustomTypeProducer() The `BeanInstanceProducer` to use when creating custom type references. Implementation Note Usually a `org.hibernate.boot.model.TypeBeanInstanceProducer`.

getFunctionRegistry back to summary

getFunctionRegistry	back to summary
public SqmFunctionRegistry getFunctionRegistry() The `SqmFunctionRegistry` belonging to this `BootstrapContext`. See Also `SqmFunctionRegistry`

public SqmFunctionRegistry getFunctionRegistry()

The SqmFunctionRegistry belonging to this BootstrapContext.

See Also: SqmFunctionRegistry

getIdentifierGeneratorFactory	back to summary
public default IdentifierGeneratorFactory getIdentifierGeneratorFactory()

getJandexView back to summary

getJandexView	back to summary
public IndexView getJandexView() Access to the Jandex index passed by call to `org.hibernate.boot.MetadataBuilder#applyIndexView(IndexView)`, if any. API Note Jandex is currently not used, see the roadmap Returns:IndexView The Jandex index

public IndexView getJandexView()

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

API Note

Jandex is currently not used, see the roadmap

Returns:IndexView: The Jandex index

getJpaCompliance	back to summary
public MutableJpaCompliance getJpaCompliance() In-flight form of `org.hibernate.jpa.spi.JpaCompliance`

getJpaTempClassLoader back to summary

getJpaTempClassLoader	back to summary
public ClassLoader getJpaTempClassLoader() Access the temporary `ClassLoader` passed to us, as defined by `jakarta.persistence.spi.PersistenceUnitInfo#getNewTempClassLoader()`, if any. Returns:ClassLoader The temporary `ClassLoader`

public ClassLoader getJpaTempClassLoader()

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

Returns:ClassLoader: The temporary ClassLoader

getMetadataBuildingOptions	back to summary
public MetadataBuildingOptions getMetadataBuildingOptions() Options specific to building the boot metamodel

getReflectionManager back to summary

getReflectionManager	back to summary
public ReflectionManager getReflectionManager() Retrieve the Hibernate Commons Annotations `ReflectionManager`. API Note Supported for internal use only. This method will go away as we migrate away from Hibernate Commons Annotations to Jandex for annotation handling and XMl to annotation merging. Annotations @Internal

public ReflectionManager getReflectionManager()

Retrieve the Hibernate Commons Annotations ReflectionManager.

API Note

Supported for internal use only. This method will go away as we migrate away from Hibernate Commons Annotations to Jandex for annotation handling and XMl to annotation merging.

Annotations

@Internal

getRepresentationStrategySelector	back to summary
public ManagedTypeRepresentationResolver getRepresentationStrategySelector() See Also `ManagedTypeRepresentationResolver`

getScanEnvironment back to summary

getScanEnvironment	back to summary
public ScanEnvironment getScanEnvironment() Access to the environment for scanning. API Note Consider this temporary; see discussion on `ScanEnvironment`. Returns:ScanEnvironment The scan environment

public ScanEnvironment getScanEnvironment()

Access to the environment for scanning.

API Note

Consider this temporary; see discussion on ScanEnvironment.

Returns:ScanEnvironment: The scan environment

getScanner back to summary

getScanner	back to summary
public Object getScanner() Access to the `org.hibernate.boot.archive.scan.spi.Scanner` to be used for scanning. Can be: An instance of `org.hibernate.boot.archive.scan.spi.Scanner`, a `Class` reference to the `Scanner` implementor, or a string naming the `Scanner` implementor. Returns:Object The scanner

public Object getScanner()

Access to the org.hibernate.boot.archive.scan.spi.Scanner to be used for scanning.

Can be:

An instance of org.hibernate.boot.archive.scan.spi.Scanner,
a Class reference to the Scanner implementor, or
a string naming the Scanner implementor.

Returns:Object: The scanner

getScanOptions	back to summary
public ScanOptions getScanOptions() Access to the options to be used for scanning. Returns:ScanOptions The scan options

getScanOptions

back to summary

public ScanOptions getScanOptions()

Access to the options to be used for scanning.

Returns:ScanOptions: The scan options

getServiceRegistry	back to summary
public StandardServiceRegistry getServiceRegistry() The service registry available to bootstrapping

getSqlFunctions back to summary

getSqlFunctions	back to summary
public Map<String, SqmFunctionDescriptor> getSqlFunctions() Access to any SQL functions explicitly registered with the `org.hibernate.boot.MetadataBuilder`. This does not include `Dialect`-registered functions. Should never return `null`. Returns:Map<String, SqmFunctionDescriptor> The `SqmFunctionDescriptor`s registered via `MetadataBuilder`

public Map<String, SqmFunctionDescriptor> getSqlFunctions()

Access to any SQL functions explicitly registered with the org.hibernate.boot.MetadataBuilder. This does not include Dialect-registered functions.

Should never return null.

Returns:Map<String, SqmFunctionDescriptor>: The SqmFunctionDescriptors registered via MetadataBuilder

getTypeConfiguration back to summary

getTypeConfiguration	back to summary
public TypeConfiguration getTypeConfiguration() The `TypeConfiguration` belonging to this `BootstrapContext`. See Also `TypeConfiguration`

public TypeConfiguration getTypeConfiguration()

The TypeConfiguration belonging to this BootstrapContext.

See Also: TypeConfiguration

isJpaBootstrap back to summary

isJpaBootstrap	back to summary
public boolean isJpaBootstrap() Whether the bootstrap was initiated from JPA bootstrapping. Implementation Specification This is used See Also `markAsJpaBootstrap()`

public boolean isJpaBootstrap()

Whether the bootstrap was initiated from JPA bootstrapping.

Implementation Specification

This is used

See Also: markAsJpaBootstrap()

markAsJpaBootstrap	back to summary
public void markAsJpaBootstrap() Indicates that bootstrap was initiated from JPA bootstrapping. Implementation Specification Internally, `false` is the assumed value. We only need to call this to mark it `true`.

registerAdHocBasicType	back to summary
public void registerAdHocBasicType(BasicType<?> basicType) To support Envers.

release	back to summary
public void release() Releases the "bootstrap only" resources held by this `BootstrapContext`.

resolveAdHocBasicType	back to summary
public <T> BasicType<T> resolveAdHocBasicType(String key) To support Envers.

public Interface BootstrapContext

Method Summary

Method Detail