Hibernate Core 3.3.2.GA Javadocs

Core API

See:
          Description

Core API
org.hibernate This package defines the central Hibernate APIs.
org.hibernate.cfg This package defines APIs for configuring Hibernate, and classes for building the Hibernate configuration-time metamodel.
org.hibernate.classic This package implements backward-compatibility with Hibernate 2.1 APIs now deprecated in Hibernate3.
org.hibernate.criterion A framework for defining restriction criteria and order criteria.
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.stat This package exposes statistics about a running Hibernate instance to the application.

 

Extension SPI/API
org.hibernate.action This package defines "actions" that are scheduled for asycnchronous execution by the event listeners.
org.hibernate.cache This package defines APIs/SPIs and implementations for the Hibernate second-level cache.
org.hibernate.cache.access Defines contracts for transactional and concurrent access to cached entity and collection data.
org.hibernate.cache.entry This package defines formats for disassembled state kept in the second level cache.
org.hibernate.cache.impl  
org.hibernate.cache.impl.bridge  
org.hibernate.collection This package defines a framework for collection wrappers.
org.hibernate.connection This package abstracts the mechanism for obtaining a JDBC connection.
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.lock  
org.hibernate.dialect.resolver  
org.hibernate.event This package defines an event framework for Hibernate.
org.hibernate.event.def This package defines a default set of event listeners that implements the default behaviors of Hibernate.
org.hibernate.id This package contains internal implementation classes for the main API interfaces.
org.hibernate.jdbc This package abstracts the mechanism for dispatching SQL statements to the database, and implements interaction with JDBC.
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.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.hql This package defines a loader for the AST-based query parser
org.hibernate.persister A persister defines a mapping strategy for a collection or entity.
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.property This package abstracts the notion of a "property" of an entity.
org.hibernate.proxy This package defines a framework for lazy-initializing entity proxies.
org.hibernate.transaction This package abstracts the underlying transaction mechanism (JTA or JDBC) and provides strategies for obtaining application server TransactionManagers.
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.type A Hibernate Type is a strategy for mapping a Java property type to a JDBC type or types.
org.hibernate.usertype Interfaces for user-defined custom types.

 

Cache Region Integrations
org.hibernate.cache.jbc2  
org.hibernate.cache.jbc2.access  
org.hibernate.cache.jbc2.builder  
org.hibernate.cache.jbc2.collection  
org.hibernate.cache.jbc2.entity  
org.hibernate.cache.jbc2.query  
org.hibernate.cache.jbc2.timestamp  
org.hibernate.cache.jbc2.util  

 

Miscellaneous API
org.hibernate.jmx This package exposes a Hibernate instance via JMX.
org.hibernate.tool.hbm2ddl The hbm2ddl tool.
org.hibernate.tool.instrument The instrument tool for adding field-interception hooks to persistent classes using built-time bytecode processing.
org.hibernate.tool.instrument.cglib  
org.hibernate.tool.instrument.javassist  

 

Other Packages
org.hibernate.auction  
org.hibernate.bytecode This package defines the API for plugging in bytecode libraries for usage by Hibernate.
org.hibernate.bytecode.buildtime  
org.hibernate.bytecode.cglib  
org.hibernate.bytecode.javassist  
org.hibernate.bytecode.util  
org.hibernate.context  
org.hibernate.engine This package contains classes that are "shared" by other packages, and implementations of some key algorithms.
org.hibernate.engine.loading  
org.hibernate.engine.query  
org.hibernate.engine.query.sql  
org.hibernate.engine.transaction  
org.hibernate.exception This package is a fork of Apache commons-lang nestable exceptions.
org.hibernate.hql This package defines the interface between Hibernate and the HQL query parser implementation (to allow switching between the 2.x and 3.0 HQL parsers).
org.hibernate.hql.antlr A special package for ANTLR-generated parser classes.
org.hibernate.hql.ast An ANTLR-based parser for Hibernate Query Language.
org.hibernate.hql.ast.exec  
org.hibernate.hql.ast.tree  
org.hibernate.hql.ast.util  
org.hibernate.hql.classic This package contains the Hibernate 2.x query parser which is being end-of-lifed.
org.hibernate.id.enhanced  
org.hibernate.id.insert  
org.hibernate.impl This package contains implementations of the central Hibernate APIs, especially the Hibernate session.
org.hibernate.intercept This package implements an interception mechanism for lazy property fetching, based on CGLIB bytecode instrumentation.
org.hibernate.intercept.cglib  
org.hibernate.intercept.javassist  
org.hibernate.jdbc.util  
org.hibernate.junit  
org.hibernate.junit.functional  
org.hibernate.lob This package defines dummy and wrapper implementations of java.sql.Clob and java.sql.Blob.
org.hibernate.maven  
org.hibernate.param  
org.hibernate.pretty Classes for pretty printing things for exception and log messages.
org.hibernate.proxy.dom4j  
org.hibernate.proxy.map  
org.hibernate.proxy.pojo  
org.hibernate.proxy.pojo.cglib  
org.hibernate.proxy.pojo.javassist  
org.hibernate.secure Declarative security for CRUD operations on entities.
org.hibernate.sql This package defines helper classes for rendering SQL fragments and SQL statements.
org.hibernate.test.cache  
org.hibernate.test.tm Defines a simplified JTA TransactionManager and transactional connection pool designed for use in test suite and simple usage scenarios.
org.hibernate.tuple.component  
org.hibernate.tuple.entity  
org.hibernate.tutorial.domain  
org.hibernate.tutorial.util  
org.hibernate.tutorial.web  
org.hibernate.util Utility classes.

 

Core API

These packages contain Hibernate classes and interfaces fully expected to be exposed to application code. This is constitues the public API of Hibernate and is therefore stable between minor releases (except in very rare cases).

Extension SPI/API

These packages contain interfaces and classes programmers are expected to use to extend Hibernate functionality. None of these contracts are intended to be called by the application; they are called internally by Hibernate in reaction to application driven actions. This API is less stable than the Core API.

The safest way to extend Hibernate functionality is to contribute extensions back to the project such that they will be updated when the given extension SPI changes.

JBoss Cache Integration

Defines the integration with JBoss Cache using the RegionFactory SPI.

Miscellaneous API

Defines (oddly) various miscellaneous APIs with which users may need to interact in different scenarios.

Other Packages

Defines various internal Hibernate classes and APIs. These classes should be treated as internal implementation details.



Copyright © null-null Red Hat Middleware, LLC. All Rights Reserved