Skip navigation links

Hibernate JavaDoc (5.2.17.Final)

Hibernate O/RM JavaDocs (aggregated)

See: Description

API 
Package Description
org.hibernate
This package defines the central Hibernate APIs.
org.hibernate.annotations
Package containing all the Hibernate specific annotations.
org.hibernate.boot
This package contains the contracts that make up the Hibernate native bootstrapping API (building a SessionFactory).
org.hibernate.boot.jaxb  
org.hibernate.boot.model  
org.hibernate.boot.model.naming
Represents a proposed new approach to allowing hooks into the process of determining the name of database objects (tables, columns, constraints, etc).
org.hibernate.boot.model.relational  
org.hibernate.boot.registry
Defines service registry contracts application are likely to want to utilize for configuring Hibernate behavior.
org.hibernate.boot.registry.selector
Defines a feature-set around named registration of implementations of various contracts and the ability to select those implementations.
org.hibernate.cache
This package defines API of the Hibernate second level cache service.
org.hibernate.cache.ehcache
Defines the integration with Ehcache as a second-level cache service.
org.hibernate.cache.ehcache.management.impl
Defines JMX support for the Ehcache integration
org.hibernate.cache.infinispan
Defines the integration with Infinispan as a second-level cache service.
org.hibernate.cache.infinispan.access
Internal Infinispan-based implementation of the cache region access strategies
org.hibernate.cache.infinispan.collection
Internal Infinispan-based implementation of the collection cache region
org.hibernate.cache.infinispan.entity
Internal Infinispan-based implementation of the entity cache region
org.hibernate.cache.infinispan.impl
Internal Infinispan-specific base cache region implementations
org.hibernate.cache.infinispan.naturalid
Internal Infinispan-based implementation of the natural-id cache region
org.hibernate.cache.infinispan.query
Internal Infinispan-based implementation of the "query results" cache region
org.hibernate.cache.infinispan.timestamp
Internal Infinispan-based implementation of the "update timestamps" cache region
org.hibernate.cache.infinispan.tm
Internal bridging between Infinispan and Hibernate notions of talking to JTA
org.hibernate.cache.infinispan.util
Internal utilities for the Infinispan integration
org.hibernate.cache.jcache
Hibernate caching provider for JSR-107 compliant caches.
org.hibernate.cache.jcache.access
Access strategies for the JSR-107 Hibernate caching provider.
org.hibernate.cache.jcache.time  
org.hibernate.cfg
This package defines APIs for configuring Hibernate, and classes for building the Hibernate configuration-time metamodel.
org.hibernate.cfg.annotations  
org.hibernate.cfg.annotations.reflection
Defines the capability to merge mapping information from both annotations and orm.xml sources into a unified set of metadata in the Hibernate commons-annotations model.
org.hibernate.cfg.beanvalidation  
org.hibernate.classic
This package implements backward-compatibility with Hibernate 2.1 APIs now deprecated in Hibernate3.
org.hibernate.context
Defines support for "current session" feature.
org.hibernate.criterion
A framework for defining restriction criteria and order criteria.
org.hibernate.dialect
This package abstracts the SQL dialect of the underlying database.
org.hibernate.dialect.function
A framework for defining database-specific SQL functions that are available via the dialect.
org.hibernate.dialect.hint  
org.hibernate.dialect.identity  
org.hibernate.dialect.lock
Support for Dialect-specific locking strategies
org.hibernate.dialect.pagination
Support for Dialect-specific pagination strategies
org.hibernate.dialect.unique
Support for Dialect-specific unique constraint definition
org.hibernate.ejb  
org.hibernate.engine
This package contains classes that are "shared" by other packages, and implementations of some key algorithms.
org.hibernate.engine.jdbc
Support for various aspects of JDBC interaction
org.hibernate.engine.jndi
Support for JNDI within Hibernate
org.hibernate.engine.profile
Models the fetch profiles defined by the application
org.hibernate.envers  
org.hibernate.envers.configuration  
org.hibernate.envers.enhanced  
org.hibernate.envers.exception  
org.hibernate.envers.query  
org.hibernate.envers.query.criteria  
org.hibernate.envers.query.order  
org.hibernate.envers.query.projection  
org.hibernate.envers.strategy  
org.hibernate.envers.tools  
org.hibernate.exception
This package is a fork of Apache commons-lang nestable exceptions.
org.hibernate.id
This package contains internal implementation classes for the main API interfaces.
org.hibernate.id.enhanced
Enhanced/improved versions of table and sequence based identifier generators targeting portability and unified configuration
org.hibernate.id.factory  
org.hibernate.id.insert  
org.hibernate.id.uuid  
org.hibernate.jdbc
Essentially defines Work, ReturningWork and Expectation as well as some exceptions
org.hibernate.jpa  
org.hibernate.jpamodelgen
The main package of this annotation processor.
org.hibernate.jpamodelgen.annotation
Implementation of the model classes backed by annotations.
org.hibernate.jpamodelgen.model  
org.hibernate.jpamodelgen.util
Helper classes for string and type processing as well as access type detection.
org.hibernate.jpamodelgen.util.xml
XML helper classes.
org.hibernate.jpamodelgen.xml
Implementation of the model classes backed by annotations.
org.hibernate.loader
This package defines functionality for processing JDBC result sets and returning complex graphs of persistent objects.
org.hibernate.loader.collection
This package defines collection initializers
org.hibernate.loader.collection.plan  
org.hibernate.loader.criteria
This package defines the criteria query compiler and loader
org.hibernate.loader.custom
This package defines a framework for custom loaders that accept handwritten SQL
org.hibernate.loader.custom.sql  
org.hibernate.loader.entity
This package defines entity loaders
org.hibernate.loader.entity.plan  
org.hibernate.loader.hql
This package defines a loader for the AST-based query parser
org.hibernate.lob  
org.hibernate.mapping
This package defines the Hibernate configuration-time metamodel.
org.hibernate.metadata
This package defines an API for accessing the Hibernate runtime metamodel.
org.hibernate.orm.tooling.maven  
org.hibernate.osgi
Main OSGi support classes
org.hibernate.param  
org.hibernate.persister.collection
This package abstracts the persistence mechanism for collections.
org.hibernate.persister.entity
This package abstracts persistence mechanisms for entities, and defines the Hibernate runtime metamodel.
org.hibernate.pretty
Classes for pretty printing things for exception and log messages.
org.hibernate.procedure  
org.hibernate.proxy
This package defines a framework for lazy-initializing entity proxies.
org.hibernate.proxy.map  
org.hibernate.proxy.pojo  
org.hibernate.proxy.pojo.bytebuddy  
org.hibernate.proxy.pojo.javassist  
org.hibernate.query  
org.hibernate.query.criteria  
org.hibernate.query.procedure  
org.hibernate.resource.jdbc  
org.hibernate.resource.transaction
Defines the resource-level transaction capabilities of Hibernate, which revolves around the TransactionCoordinator contract.
org.hibernate.result  
org.hibernate.service  
org.hibernate.spatial
This package defines the central Hibernate Spatial APIs.
org.hibernate.spatial.criterion
This extends the criterion API with spatial query expressions.
org.hibernate.spatial.dialect
This package contains the Spatial Dialects supported by Hibnerate Spatial
org.hibernate.spatial.dialect.h2geodb
This package contains the H2 Dialect extensions for the GeoDB dialect.
org.hibernate.spatial.dialect.hana  
org.hibernate.spatial.dialect.mysql
This package contains the spatial extensions for the MySQL dialect.
org.hibernate.spatial.dialect.oracle
This package contains the spatial extensions for the Oracle 10g dialect.
org.hibernate.spatial.dialect.oracle.criterion
A criterion API for Oracle Spatial (10g and later) using SDOGeometry.
org.hibernate.spatial.dialect.postgis
This package contains the spatial extensions for the Postgresql dialect.
org.hibernate.spatial.dialect.sqlserver
This package contains the spatial extensions for the SqlServer2008 dialect.
org.hibernate.spatial.integration
This package contains the integration classes to hook into Hibernate-ORM.
org.hibernate.spatial.jts
This package contains utility classes for use with JTS.
org.hibernate.sql
This package defines helper classes for rendering SQL fragments and SQL statements.
org.hibernate.sql.ordering.antlr  
org.hibernate.stat
This package exposes statistics about a running Hibernate instance to the application.
org.hibernate.tool.enhance  
org.hibernate.tool.hbm2ddl
The hbm2ddl tool.
org.hibernate.tool.instrument.javassist  
org.hibernate.tool.schema  
org.hibernate.transform
Defines strategies for post-processing criteria query result sets into a form convenient to the application.
org.hibernate.tuple
This package defines a runtime metamodel for entities at the object level and abstracts the differences between the various entity modes.
org.hibernate.tuple.component  
org.hibernate.tuple.entity  
org.hibernate.type
A Hibernate Type is a strategy for mapping a Java property type to a JDBC type or types.
org.hibernate.type.descriptor  
org.hibernate.type.descriptor.converter
Support for handling JPA AttributeConverter instances as part of the Hibernate Type system.
org.hibernate.type.descriptor.java  
org.hibernate.type.descriptor.sql
Defines handling of the standard JDBC-defined types.
org.hibernate.usertype
Interfaces for user-defined custom types.
SPI 
Package Description
org.hibernate.action.spi
Defines SPI hooks into the ActionQueue.
org.hibernate.boot.archive.scan.spi  
org.hibernate.boot.archive.spi
Defines the SPI for support of "scanning" of "archives".
org.hibernate.boot.cfgxml.spi  
org.hibernate.boot.jaxb.hbm.spi  
org.hibernate.boot.jaxb.spi  
org.hibernate.boot.model.process.spi  
org.hibernate.boot.model.source.spi  
org.hibernate.boot.registry.classloading.spi
The class loading service SPI.
org.hibernate.boot.registry.selector.spi
Defines actual contract used for strategy selection : StrategySelector.
org.hibernate.boot.spi  
org.hibernate.bytecode.enhance.spi
package defining bytecode code enhancement (instrumentation) support.
org.hibernate.bytecode.enhance.spi.interceptor
interceptor implementations
org.hibernate.bytecode.spi
Package defining bytecode code enhancement (instrumentation) support.
org.hibernate.cache.spi
Defines the Hibernate second level caching SPI.
org.hibernate.cache.spi.access
Defines contracts for transactional and concurrent access to cached entity and collection data.
org.hibernate.cache.spi.entry
This package defines formats for disassembled state kept in the second level cache.
org.hibernate.collection.spi
SPI definitions for persistent collections
org.hibernate.context.spi
SPI level contracts around "current session" support.
org.hibernate.engine.config.spi
SPI Package for the configuration service.
org.hibernate.engine.jdbc.batch.spi
Defines contracts for JDBC batching support.
org.hibernate.engine.jdbc.connections.spi
Defines contracts for accessing JDBC Connections
org.hibernate.engine.jdbc.cursor.spi
Defines contracts for JDBC REF_CURSOR support.
org.hibernate.engine.jdbc.dialect.spi
Contracts supporting Dialect resolution (from JDBC metadata) and Dialect building.
org.hibernate.engine.jdbc.env.spi  
org.hibernate.engine.jdbc.spi
SPI contracts for supporting various aspects of JDBC interaction
org.hibernate.engine.jndi.spi
The SPI contracts for Hibernate JNDI support
org.hibernate.engine.query.spi
Defines support for query plans and stored metadata about queries
org.hibernate.engine.query.spi.sql  
org.hibernate.engine.spi  
org.hibernate.engine.transaction.jta.platform.spi  
org.hibernate.engine.transaction.spi  
org.hibernate.envers.event.spi  
org.hibernate.event.service.spi  
org.hibernate.event.spi  
org.hibernate.exception.spi  
org.hibernate.graph.spi  
org.hibernate.hql.spi  
org.hibernate.hql.spi.id
Support for multi-table update and delete statements via id-tables.
org.hibernate.hql.spi.id.cte  
org.hibernate.hql.spi.id.global  
org.hibernate.hql.spi.id.inline  
org.hibernate.hql.spi.id.local  
org.hibernate.hql.spi.id.persistent
Package contains an implementation of MultiTableBulkIdStrategy based on the use of a persistent (ANSI SQL term) table to hold id values.
org.hibernate.id.factory.spi  
org.hibernate.integrator.spi  
org.hibernate.jmx.spi  
org.hibernate.jpa.boot.spi  
org.hibernate.jpa.event.spi  
org.hibernate.jpa.event.spi.jpa  
org.hibernate.jpa.spi  
org.hibernate.loader.plan.build.spi
Defines the SPI for building a metamodel-driven LoadPlan
org.hibernate.loader.plan.exec.process.spi  
org.hibernate.loader.plan.exec.query.spi
Defines the SPI for obtaining values for options that impact the load query.
org.hibernate.loader.plan.exec.spi
Defines the SPI for the load query generated for the LoadPlan and the ResultSet processor.
org.hibernate.loader.plan.spi
Defines the SPI for the building blocks that make up a LoadPlan.
org.hibernate.loader.spi  
org.hibernate.metamodel.spi  
org.hibernate.persister.spi  
org.hibernate.persister.walking.spi  
org.hibernate.procedure.spi  
org.hibernate.property.access.spi
Defines strategies for accessing the persistent properties of an entity or composite.
org.hibernate.query.procedure.spi  
org.hibernate.query.spi  
org.hibernate.resource.jdbc.spi  
org.hibernate.resource.transaction.backend.jdbc.spi  
org.hibernate.resource.transaction.spi
Extended SPI contracts for the resource-level transaction capabilities of Hibernate.
org.hibernate.result.spi  
org.hibernate.secure.spi  
org.hibernate.service.spi  
org.hibernate.stat.spi  
org.hibernate.tool.schema.extract.spi  
org.hibernate.tool.schema.spi  
Internal 
Package Description
org.hibernate.action.internal
Internals for action processing.
org.hibernate.boot.archive.internal
The internals of archive scanning support
org.hibernate.boot.archive.scan.internal  
org.hibernate.boot.cfgxml.internal  
org.hibernate.boot.internal  
org.hibernate.boot.jaxb.hbm.internal
JAXB details.
org.hibernate.boot.jaxb.internal  
org.hibernate.boot.jaxb.internal.stax
Contains basic support for Java XML Processing (JAXP) via Streaming API for XML (StAX)
org.hibernate.boot.model.process.internal  
org.hibernate.boot.model.source.internal  
org.hibernate.boot.model.source.internal.annotations  
org.hibernate.boot.model.source.internal.hbm  
org.hibernate.boot.registry.classloading.internal
The class loading service internals.
org.hibernate.boot.registry.internal
The internals for building service registries.
org.hibernate.boot.registry.selector.internal
Internals for building StrategySelector
org.hibernate.bytecode.enhance.internal.bytebuddy
package containing bytecode enhancement code (internals)
org.hibernate.bytecode.enhance.internal.javassist
package containing bytecode enhancement code (internals)
org.hibernate.bytecode.enhance.internal.tracker
specialized classes to keep track of changes
org.hibernate.bytecode.internal.bytebuddy
Byte Buddy support internals
org.hibernate.bytecode.internal.javassist
Javassist support internals
org.hibernate.c3p0.internal
Implementation of ConnectionProvider using the c3p0 Connection pool.
org.hibernate.cache.ehcache.internal.nonstop
Support for handling non-stop caches.
org.hibernate.cache.ehcache.internal.regions
Defines RegionFactory support for the Ehcache integration
org.hibernate.cache.ehcache.internal.strategy
Defines RegionAccessStrategy support for the Ehcache integration
org.hibernate.cache.ehcache.internal.util
Defines utilities used by the Ehcache integration
org.hibernate.cache.internal
Internal implementations and support for second-level caching.
org.hibernate.collection.internal
Internal implementations and support for persistent collections
org.hibernate.context.internal
Internal implementations and support around "current session" handling.
org.hibernate.engine.config.internal
Internal support for the configuration service implementation
org.hibernate.engine.internal
Support for many of the internal workings of Hibernate.
org.hibernate.engine.jdbc.batch.internal
Internals for JDBC batching support.
org.hibernate.engine.jdbc.connections.internal
Internals for accessing JDBC Connections
org.hibernate.engine.jdbc.cursor.internal
Internals for JDBC REF_CURSOR support.
org.hibernate.engine.jdbc.dialect.internal
Internal support for Dialect resolution (from JDBC metadata) and Dialect building.
org.hibernate.engine.jdbc.env.internal  
org.hibernate.engine.jdbc.internal
Internals for supporting various aspects of JDBC interaction
org.hibernate.engine.jndi.internal
Internal contracts defining the JNDI support within Hibernate
org.hibernate.engine.loading.internal
Internal classes used to track loading of data, potentially across multiple ResultSets
org.hibernate.engine.query.internal  
org.hibernate.engine.transaction.internal  
org.hibernate.engine.transaction.internal.jta  
org.hibernate.engine.transaction.jta.platform.internal  
org.hibernate.envers.boot.internal  
org.hibernate.envers.configuration.internal  
org.hibernate.envers.configuration.internal.metadata  
org.hibernate.envers.configuration.internal.metadata.reader  
org.hibernate.envers.internal  
org.hibernate.envers.internal.entities  
org.hibernate.envers.internal.entities.mapper  
org.hibernate.envers.internal.entities.mapper.id  
org.hibernate.envers.internal.entities.mapper.relation  
org.hibernate.envers.internal.entities.mapper.relation.component  
org.hibernate.envers.internal.entities.mapper.relation.lazy  
org.hibernate.envers.internal.entities.mapper.relation.lazy.initializor  
org.hibernate.envers.internal.entities.mapper.relation.lazy.proxy  
org.hibernate.envers.internal.entities.mapper.relation.query  
org.hibernate.envers.internal.reader  
org.hibernate.envers.internal.revisioninfo  
org.hibernate.envers.internal.synchronization  
org.hibernate.envers.internal.synchronization.work  
org.hibernate.envers.internal.tools  
org.hibernate.envers.internal.tools.graph  
org.hibernate.envers.internal.tools.query  
org.hibernate.envers.query.criteria.internal  
org.hibernate.envers.query.internal.impl  
org.hibernate.envers.query.internal.property  
org.hibernate.envers.query.order.internal  
org.hibernate.envers.query.projection.internal  
org.hibernate.event.internal
This package defines a default set of event listeners that implements the default behaviors of Hibernate.
org.hibernate.event.service.internal  
org.hibernate.exception.internal  
org.hibernate.hikaricp.internal
Implementation of ConnectionProvider using HikariCP.
org.hibernate.hql.internal  
org.hibernate.hql.internal.ast
An ANTLR-based parser for Hibernate Query Language.
org.hibernate.hql.internal.ast.exec  
org.hibernate.hql.internal.ast.tree  
org.hibernate.hql.internal.ast.util  
org.hibernate.hql.internal.classic
This package contains the Hibernate 2.x query parser which is being end-of-lifed.
org.hibernate.id.factory.internal  
org.hibernate.integrator.internal  
org.hibernate.internal
An internal package containing mostly implementations of central Hibernate APIs.
org.hibernate.internal.log  
org.hibernate.internal.util
Internal utility classes.
org.hibernate.internal.util.beans  
org.hibernate.internal.util.collections  
org.hibernate.internal.util.compare  
org.hibernate.internal.util.config  
org.hibernate.internal.util.io  
org.hibernate.internal.util.jndi  
org.hibernate.internal.util.type  
org.hibernate.internal.util.xml  
org.hibernate.jmx.internal  
org.hibernate.jpa.boot.internal  
org.hibernate.jpa.event.internal  
org.hibernate.jpa.event.internal.core  
org.hibernate.jpa.event.internal.jpa  
org.hibernate.jpa.graph.internal  
org.hibernate.jpa.internal
Defines Hibernate implementation of Java Persistence specification.
org.hibernate.jpa.internal.enhance  
org.hibernate.jpa.internal.util  
org.hibernate.loader.plan.build.internal
Contains the internal implementations used for building a metamodel-driven LoadPlan.
org.hibernate.loader.plan.build.internal.returns
Contains the internal implementations of the building blocks that make up a metamodel-driven LoadPlan.
org.hibernate.loader.plan.build.internal.spaces
Contains the internal implementations of query spaces in a metamodel-driven LoadPlan.
org.hibernate.loader.plan.exec.internal
Provides the internal implementations for generating the load query from the LoadPlan and the ResultSet processor.
org.hibernate.loader.plan.exec.process.internal  
org.hibernate.loader.plan.exec.query.internal
Provides the internal implementation for generating the load query for the LoadPlan.
org.hibernate.metamodel.internal  
org.hibernate.persister.internal  
org.hibernate.persister.walking.internal  
org.hibernate.procedure.internal
Defines the internal support for implementing stored procedure calling.
org.hibernate.property.access.internal  
org.hibernate.proxool.internal
Implementation of ConnectionProvider using the proxool Connection pool.
org.hibernate.query.criteria.internal  
org.hibernate.query.criteria.internal.compile  
org.hibernate.query.criteria.internal.expression  
org.hibernate.query.criteria.internal.expression.function  
org.hibernate.query.criteria.internal.path  
org.hibernate.query.criteria.internal.predicate  
org.hibernate.query.internal  
org.hibernate.query.procedure.internal  
org.hibernate.resource.jdbc.internal  
org.hibernate.resource.transaction.backend.jdbc.internal  
org.hibernate.resource.transaction.backend.jta.internal  
org.hibernate.resource.transaction.backend.jta.internal.synchronization
Internal implementation details for reacting to JTA transaction completion via Synchronization callbacks
org.hibernate.resource.transaction.internal
Internal implementation details for the resource-level transaction capabilities of Hibernate.
org.hibernate.result.internal  
org.hibernate.secure.internal  
org.hibernate.service.internal  
org.hibernate.stat.internal  
org.hibernate.tool.schema.extract.internal  
org.hibernate.tool.schema.internal  
org.hibernate.tool.schema.internal.exec  
Testing Support 
Package Description
org.hibernate.testing  
org.hibernate.testing.async  
org.hibernate.testing.boot  
org.hibernate.testing.bytecode.enhancement  
org.hibernate.testing.byteman  
org.hibernate.testing.cache  
org.hibernate.testing.common.connections  
org.hibernate.testing.env  
org.hibernate.testing.jdbc  
org.hibernate.testing.jdbc.leak  
org.hibernate.testing.jta  
org.hibernate.testing.junit4  
org.hibernate.testing.logger  
org.hibernate.testing.schema  
org.hibernate.testing.transaction  
org.hibernate.testing.util  
Other Packages 
Package Description
org.hibernate.boot.jaxb.cfg.spi  
org.hibernate.hql.internal.antlr  
org.hibernate.jpamodelgen.xml.jaxb  

Hibernate O/RM JavaDocs (aggregated)

Hibernate provides both

Native API

In addition to SessionFactory and Session, applications using the native API will often utilize the following interfaces: These interfaces are fully intended to be exposed to application code.


JPA

The JPA interfaces are all defined by the JPA specification. For details see javax.persistence


Package Groups

This documentation groups packages into the following 3 categories: Additionally, we highlight a 4th category Testing Support which is a set of classes useful for building Hibernate test cases.


Complete Hibernate documentation may be found online at http://docs.jboss.org/hibernate/
Skip navigation links

Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.