Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

lots of package-info.java files!

This commit is contained in:
Gavin 2022-12-21 21:22:36 +01:00 committed by Gavin King
parent 32cc739f39
commit 39ffcc91f4
112 changed files with 787 additions and 663 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
hibernate-core/src/main/java/org/hibernate/JDBCException.java
View File

@ -9,7 +9,8 @@ package org.hibernate;
import java.sql.SQLException;
/**
* Wraps a {@link SQLException}. Indicates that an exception occurred during a JDBC call.
* Wraps a {@link SQLException} arising from the JDBC driver.
* Indicates that an error occurred during a JDBC call.
*
* @author Gavin King
*

18
hibernate-core/src/main/java/org/hibernate/action/package-info.java Normal file
View File

@ -0,0 +1,18 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* This package defines the notion of an "action" which is scheduled for
* asynchronous execution by the event listeners. Every action implements
* {@link org.hibernate.action.spi.Executable}.
* <p>
* The {@link org.hibernate.engine.spi.ActionQueue} is responsible for
* scheduling and execution of the actions.
*
* @see org.hibernate.event
*/
package org.hibernate.action;

17
hibernate-core/src/main/java/org/hibernate/action/package.html
View File

@ -1,17 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head>
</head>
<body>
<p>
This package defines "actions" that are scheduled for asynchronous execution by the event listeners.
The {@link org.hibernate.engine.ActionQueue} is responsible for execution of these actions.
</p>
</body>
</html>

5
hibernate-core/src/main/java/org/hibernate/action/spi/package-info.java
View File

@ -6,7 +6,8 @@
*/
/**
* Defines SPI hooks into the {@link org.hibernate.engine.spi.ActionQueue}. Mainly for registering custom
* {@link org.hibernate.action.spi.AfterTransactionCompletionProcess} and {@link org.hibernate.action.spi.BeforeTransactionCompletionProcess} hooks.
* Defines SPI hooks into the {@link org.hibernate.engine.spi.ActionQueue}, mainly for
* registering custom {@link org.hibernate.action.spi.AfterTransactionCompletionProcess}
* and {@link org.hibernate.action.spi.BeforeTransactionCompletionProcess} hooks.
*/
package org.hibernate.action.spi;

10
hibernate-core/src/main/java/org/hibernate/annotations/package-info.java
View File

@ -10,7 +10,8 @@
*
* <h2 id="basic-value-mapping">Basic value mapping</h2>
*
* Hibernate supports 2 approaches to defining a mapping strategy for basic values:<ul>
* Hibernate supports two approaches to defining a mapping strategy for basic values:
* <ul>
* <li>
* A "compositional" approach using a combination of the following influencers for
* various parts of mapping<ul>
@ -36,11 +37,10 @@
* custom-types as well.
* </li>
* </ul>
*
* These 2 approaches are not intended to be mixed. Specifying a custom-type takes precedence over
* the compositional approach. Though the compositional approach is recommended, both forms are
* These two approaches are not intended to be mixed. Specifying a custom-type takes precedence over
* the compositional approach. Although the compositional approach is recommended, both forms are
* fully supported.
*
* <p>
* Please see the user guide for a more in-depth discussion.
*/
package org.hibernate.annotations;

18
hibernate-core/src/main/java/org/hibernate/binder/package-info.java Normal file
View File

@ -0,0 +1,18 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package defines an easy way to extend Hibernate with
* user-defined annotations that define customized O/R mappings
* of annotated entity attributes.
* <p>
* The meta-annotation
* {@link org.hibernate.annotations.AttributeBinderType}
* associates an {@link org.hibernate.binder.AttributeBinder}
* with a user-written annotation.
*/
package org.hibernate.binder;

10
hibernate-core/src/main/java/org/hibernate/boot/package-info.java
View File

@ -6,9 +6,11 @@
*/
/**
* This package contains the contracts that make up the Hibernate native
* bootstrapping API (building a SessionFactory).
*
* See the <i>Native Bootstrapping</i> guide for details.
* This package contains the contracts that make up the bootstrap API
* for Hibernate. That is, they collectively provide a way to specify
* configuration information and construct a new instance of
* {@link org.hibernate.SessionFactory}.
* <p>
* See the <i>Native Bootstrapping</i> guide for more details.
*/
package org.hibernate.boot;

2
hibernate-core/src/main/java/org/hibernate/boot/query/package-info.java
View File

@ -6,7 +6,7 @@
*/
/**
* Support for handling named-queries
* Support for handling named queries during the bootstrap process.
*
* @author Steve Ebersole
*/

6
hibernate-core/src/main/java/org/hibernate/boot/registry/package-info.java
View File

@ -8,16 +8,16 @@
/**
* Defines service registry contracts application are likely to want to utilize for
* configuring Hibernate behavior.
*
* <p>
* Service registries are designed to be hierarchical. This works in 2 fashions. First registries can "hide" or
* "override" services from parent registries. It also allows granular building of registries as services
* become available.
*
* <p>
* {@link org.hibernate.boot.registry.BootstrapServiceRegistry} is the base service registry, intended to be built via
* {@link org.hibernate.boot.registry.BootstrapServiceRegistryBuilder} if you need customization. For non-customized
* {@link org.hibernate.boot.registry.BootstrapServiceRegistry} usage, the {@link org.hibernate.boot.registry.BootstrapServiceRegistryBuilder} and
* {@link org.hibernate.boot.registry.BootstrapServiceRegistry} can be bypassed altogether.
*
* <p>
* Usually the next level in a standard registry set up is the {@link org.hibernate.boot.registry.StandardServiceRegistry}, intended to be built
* by the {@link org.hibernate.boot.registry.StandardServiceRegistryBuilder} if you need customization. The builder optionally takes the
* {@link org.hibernate.boot.registry.BootstrapServiceRegistry} to use as a base; if none is provided a default one is generated assuming sensible

1
hibernate-core/src/main/java/org/hibernate/bytecode/BytecodeLogging.java
View File

@ -6,7 +6,6 @@
*/
package org.hibernate.bytecode;
import org.hibernate.boot.jaxb.JaxbLogger;
import org.hibernate.internal.log.SubSystemLogging;
import org.jboss.logging.Logger;

27
hibernate-core/src/main/java/org/hibernate/bytecode/package-info.java Normal file
View File

@ -0,0 +1,27 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* This package defines an SPI for integrating bytecode libraries with Hibernate.
* A bytecode library is used for:
* <ol>
* <li>
* <b>Reflection optimization</b> - to speed up the performance of entity
* and component construction and field/property access,
* </li>
* <li>
* <b>Proxy generation</b> - runtime building of proxies used to defer
* loading of lazy entities, and
* </li>
* <li>
* <b>Field-level interception</b> - build-time instrumentation of entity
* classes for the purpose of intercepting field-level access, for both
* lazy loading and dirty tracking.
* </li>
* </ol>
*/
package org.hibernate.bytecode;

42
hibernate-core/src/main/java/org/hibernate/bytecode/package.html
View File

@ -1,42 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package defines the API for plugging in bytecode libraries
for usage by Hibernate. Hibernate uses these bytecode libraries
in three scenarios:<ol>
<li>
<b>Reflection optimization</b> - to speed up the performance of
POJO entity and component construction and field/property access
</li>
<li>
<b>Proxy generation</b> - runtime building of proxies used for
deferred loading of lazy entities
</li>
<li>
<b>Field-level interception</b> - build-time instrumentation of entity
classes for the purpose of intercepting field-level access (read/write)
for both lazy loading and dirty tracking.
</li>
</ol>
</p>
<p>
Note that for field-level interception, simply plugging in a new {@link BytecodeProvider}
is not enough for Hibernate to be able to recognize new providers. You would additionally
need to make appropriate code changes to the {@link org.hibernate.intercept.Helper}
class. This is because the detection of these enhanced classes is needed in a static
environment (i.e. outside the scope of any {@link org.hibernate.SessionFactory}.
</p>
<p>
Note that in the current form the ability to specify a different bytecode provider
is actually considered a global settings (global to the JVM).
</p>
</body>
</html>

2
hibernate-core/src/main/java/org/hibernate/cache/CacheException.java vendored
View File

@ -9,7 +9,7 @@ package org.hibernate.cache;
import org.hibernate.HibernateException;
/**
* Something went wrong in the cache
* Something went wrong in the cache.
*/
public class CacheException extends HibernateException {
/**

2
hibernate-core/src/main/java/org/hibernate/cache/cfg/package-info.java vendored
View File

@ -6,6 +6,6 @@
*/
/**
* Package used to model various aspects of caching configuration
* Package used to model various aspects of caching configuration.
*/
package org.hibernate.cache.cfg;

14
hibernate-core/src/main/java/org/hibernate/cache/package-info.java vendored Normal file
View File

@ -0,0 +1,14 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package defines the API of the second-level cache service.
* <p>
* The subpackage {@link org.hibernate.cache.spi} defines an SPI
* used to integrate any third-party cache implementation.
*/
package org.hibernate.cache;

15
hibernate-core/src/main/java/org/hibernate/cache/package.html vendored
View File

@ -1,15 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<body>
<p>
This package defines API of the Hibernate second level cache service. The
<a href="{@docRoot}/org/hibernate/cache/spi">org.hibernate.cache.spi</a> package defines the SPI used to
integrate with Hibernate internals.
</p>
</body>
</html>

42
hibernate-core/src/main/java/org/hibernate/cache/spi/access/package-info.java vendored Normal file
View File

@ -0,0 +1,42 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* Defines contracts for transactional and concurrent access to cached
* {@linkplain org.hibernate.cache.spi.access.EntityDataAccess entity} and
* {@linkplain org.hibernate.cache.spi.access.CollectionDataAccess collection} data. Transactions pass in a
* timestamp indicating transaction start time which is then used to protect against concurrent access (exactly how
* that occurs is based on the actual access-strategy impl used). Two different implementation patterns are provided
* for:
* <ul>
* <li>
* A transaction-aware cache implementation might be wrapped by a <i>synchronous</i> access strategy,
* where updates to the cache are written to the cache inside the transaction.
* </li>
* <li>
* A non-transaction-aware cache would be wrapped by an <i>asynchronous</i> access strategy, where items
* are merely "soft locked" during the transaction and then updated during the "after transaction completion"
* phase; the soft lock is not an actual lock on the database row - only upon the cached representation of the
* item.
* </li>
* </ul>
* The <i>asynchronous</i> access strategies are: {@link org.hibernate.cache.spi.access.AccessType#READ_ONLY read-only},
* {@link org.hibernate.cache.spi.access.AccessType#READ_WRITE read-write} and
* {@link org.hibernate.cache.spi.access.AccessType#NONSTRICT_READ_WRITE nonstrict-read-write}. The only
* <i>synchronous</i> access strategy is {@linkplain org.hibernate.cache.spi.access.AccessType#TRANSACTIONAL transactional}.
* <p>
* Note that, for an <i>asynchronous</i> cache, cache invalidation must be a two-step process (lock->unlock or
* lock->afterUpdate), since this is the only way to guarantee consistency with the database for a nontransactional
* cache implementation. For a <i>synchronous</i> cache, cache invalidation is a single step process (evict or update).
* Hence, these contracts ({@link org.hibernate.cache.spi.access.EntityDataAccess} and
* {@link org.hibernate.cache.spi.access.CollectionDataAccess}) define a three-step process to cater for both
* models (see the individual contracts for details).
* <p>
* Note that query result caching does not go through an access strategy; those caches are managed directly against
* the underlying {@link org.hibernate.cache.spi.QueryResultsRegion}.
*/
package org.hibernate.cache.spi.access;

47
hibernate-core/src/main/java/org/hibernate/cache/spi/access/package.html vendored
View File

@ -1,47 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<body>
<p>
Defines contracts for transactional and concurrent access to cached
{@linkplain org.hibernate.cache.spi.access.EntityDataAccess entity} and
{@linkplain org.hibernate.cache.spi.access.CollectionDataAccess collection} data. Transactions pass in a
timestamp indicating transaction start time which is then used to protect against concurrent access (exactly how
that occurs is based on the actual access-strategy impl used). Two different implementation patterns are provided
for:
<ul>
<li>
A transaction-aware cache implementation might be wrapped by a <i>synchronous</i> access strategy,
where updates to the cache are written to the cache inside the transaction.
</li>
<li>
A non-transaction-aware cache would be wrapped by an <i>asynchronous</i> access strategy, where items
are merely "soft locked" during the transaction and then updated during the "after transaction completion"
phase; the soft lock is not an actual lock on the database row - only upon the cached representation of the
item.
</li>
</ul>
The <i>asynchronous</i> access strategies are: {@link org.hibernate.cache.spi.access.AccessType#READ_ONLY read-only},
{@link org.hibernate.cache.spi.access.AccessType#READ_WRITE read-write} and
{@link org.hibernate.cache.spi.access.AccessType#NONSTRICT_READ_WRITE nonstrict-read-write}. The only
<i>synchronous</i> access strategy is {@linkplain org.hibernate.cache.spi.access.AccessType#TRANSACTIONAL transactional}.
</p>
<p>
Note that, for an <i>asynchronous</i> cache, cache invalidation must be a two step process (lock->unlock or
lock->afterUpdate), since this is the only way to guarantee consistency with the database for a nontransactional
cache implementation. For a <i>synchronous</i> cache, cache invalidation is a single step process (evict or update).
Hence, these contracts ({@link org.hibernate.cache.spi.access.EntityRegionAccessStrategy} and
{@link org.hibernate.cache.spi.access.CollectionRegionAccessStrategy}) define a three step process to cater for both
models (see the individual contracts for details).
</p>
<p>
Note that query result caching does not go through an access strategy; those caches are managed directly against
the underlying {@link org.hibernate.cache.spi.QueryResultsRegion}.
</p>
</body>
</html>

11
hibernate-core/src/main/java/org/hibernate/cache/spi/entry/package-info.java vendored Normal file
View File

@ -0,0 +1,11 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package defines formats for disassembled state kept in the second level cache.
*/
package org.hibernate.cache.spi.entry;

14
hibernate-core/src/main/java/org/hibernate/cache/spi/entry/package.html vendored
View File

@ -1,14 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<body>
<p>
This package defines formats for disassembled state kept in the second level cache.
</p>
</body>
</html>

54
hibernate-core/src/main/java/org/hibernate/cache/spi/package-info.java vendored
View File

@ -6,34 +6,32 @@
*/
/**
* Defines the integration aspect of Hibernate's second-level
* caching allowing "caching back ends" to be plugged in as
* a caching provider.
*
* {@link org.hibernate.cache.spi.RegionFactory} is the main
* integration contract that defines how Hibernate accesses
* the provider. It's main contract is the generation of
* {@link org.hibernate.cache.spi.Region} references with the
* Defines the integration aspect of Hibernate's second-level caching, allowing
* a "caching backend" to be plugged in as a cache provider.
* <p>
* {@link org.hibernate.cache.spi.RegionFactory} is the main integration contract
* that defines how Hibernate interacts with the provider. Its main contract is
* the generation of {@link org.hibernate.cache.spi.Region} references with some
* requested intent (what will be stored there).
*
* Generally a provider will integrate with Hibernate by:
*
* 1. implementing the contracts in {@link org.hibernate.cache.spi}
* 2. implementing the contracts in {@link org.hibernate.cache.spi.support}
* 3. a mix of (1) and (2)
*
* The first approach allows for more control of the set up, but also requires more
* to implement. The second approach tries to minimize the amount of work needed
* to integrate with caching providers to basically the
* {@link org.hibernate.cache.spi.support.StorageAccess} and
* {@link org.hibernate.cache.spi.support.DomainDataStorageAccess} contracts which
* are basic read/write type abstractions of the underlying "cache" object - it
* is a nearly complete implementation aside from providing the proper "storage
* access" objects.
*
* Note: providers may also integrate with Hibernate via
* Hibernate's JCache support as defined by the `hibernate-jcache`
* module - no code involved aside from being a JCache implementation
* properly registered via the JCache spec.
* <p>
* A provider will integrate with Hibernate by implementing either:
* <ol>
* <li>the contracts in {@link org.hibernate.cache.spi},
* <li>the contracts in {@link org.hibernate.cache.spi.support}, or
* <li>a mix of the above.
* </ol>
* The first approach allows for more control over the setup, but also requires
* more work. The second approach minimizes the work needed to integrate with a
* cache provider: the integrator is only required to implement the
* contracts {@link org.hibernate.cache.spi.support.StorageAccess} and
* {@link org.hibernate.cache.spi.support.DomainDataStorageAccess}, which are
* basic read/write abstractions of the underlying cache. That is to say,
* {@code org.hibernate.cache.spi.support} comes with a nearly complete
* implementation, except for these "storage access" objects.
* <p>
* Alternatively, providers may integrate with Hibernate via Hibernate's support
* for JCache, which is defined by the {@code hibernate-jcache} module. No custom
* code is necessary, just an implementation of JCache, properly registered via
* the JCache spec.
*/
package org.hibernate.cache.spi;

2
hibernate-core/src/main/java/org/hibernate/cache/spi/support/DomainDataStorageAccess.java vendored
View File

@ -9,7 +9,7 @@ package org.hibernate.cache.spi.support;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
/**
* Specialization of StorageAccess for domain data regions
* Specialization of {@link StorageAccess} for domain data regions
*
* @author Steve Ebersole
*/

45
hibernate-core/src/main/java/org/hibernate/cache/spi/support/package-info.java vendored
View File

@ -6,28 +6,29 @@
*/
/**
* Package intended for simplifying the worked needed to implement
* a caching provider. Centers around the concept of
* {@link org.hibernate.cache.spi.support.StorageAccess} and
* {@link org.hibernate.cache.spi.support.DomainDataStorageAccess}
* too implement most of the "grunt work" associated with the
* implementation.
*
* Most integrations would just:
*
* 1. implement a custom StorageAccess/DomainDataStorageAccess
* 2. implement a custom RegionFactoryTemplate, implementing specifically:
* a. `RegionFactoryTemplate#createDomainDataStorageAccess`
* b. `RegionFactoryTemplate#createQueryResultsRegionStorageAccess`
* c. `RegionFactoryTemplate#createTimestampsRegionStorageAccess`
*
* Voila.. functioning cache provider
*
* The preferred approach to "provide a integration" is through a custom
* {@link org.hibernate.boot.registry.selector.StrategyRegistrationProvider}
*
* Both `hibernate-testing` (`org.hibernate.testing.cache.CachingRegionFactory`)
* and `hibernate-jcache` (`org.hibernate.cache.jcache.internal.JCacheRegionFactory`)
* Package intended for simplifying the worked needed to implement a caching provider.
* Centers around the concept of {@link org.hibernate.cache.spi.support.StorageAccess}
* and {@link org.hibernate.cache.spi.support.DomainDataStorageAccess} to implement
* most of the "grunt work" associated with the implementation.
* <p>
* A typical integration would just implement:
* <ol>
* <li>a custom {@code StorageAccess}/{@code DomainDataStorageAccess}, along with
* <li>a custom {@link org.hibernate.cache.spi.support.RegionFactoryTemplate}, in
* particular:
* <ul>
* <li>{@link org.hibernate.cache.spi.support.RegionFactoryTemplate#createDomainDataStorageAccess}
* <li>{@link org.hibernate.cache.spi.support.RegionFactoryTemplate#createQueryResultsRegionStorageAccess}
* <li>{@link org.hibernate.cache.spi.support.RegionFactoryTemplate#createTimestampsRegionStorageAccess}
* </ul>
* </ol>
* Voila! Functioning cache provider.
* <p>
* The preferred approach to "provide an integration" is through a custom
* {@link org.hibernate.boot.registry.selector.StrategyRegistrationProvider}.
* <p>
* Both {@code hibernate-testing} ({@code org.hibernate.testing.cache.CachingRegionFactory})
* and {@code hibernate-jcache} ({@code org.hibernate.cache.jcache.internal.JCacheRegionFactory})
* provide examples of using this support package to implement a caching
* provider.
*/

5
hibernate-core/src/main/java/org/hibernate/cfg/Configuration.java
View File

@ -105,14 +105,15 @@ import jakarta.persistence.SharedCacheMode;
* Ultimately, this class simply delegates to {@link MetadataBuilder} and
* {@link StandardServiceRegistryBuilder} to actually do the hard work of
* {@linkplain #buildSessionFactory() building} the {@code SessionFactory}.
* Programs may use these APIs directly as an alternative to using an
* instance of this class.
* Programs may directly use the APIs defined under {@link org.hibernate.boot},
* as an alternative to using an instance of this class.
*
* @author Gavin King
* @author Steve Ebersole
*
* @see SessionFactory
* @see AvailableSettings
* @see org.hibernate.boot
*/
public class Configuration {
private static final CoreMessageLogger log = CoreLogging.messageLogger( Configuration.class );

18
hibernate-core/src/main/java/org/hibernate/cfg/package-info.java Normal file
View File

@ -0,0 +1,18 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package defines APIs for configuring Hibernate.
* <ul>
* <li>{@link org.hibernate.cfg.AvailableSettings} enumerates all the
* configuration properties recognized by Hibernate.
* <li>{@link org.hibernate.cfg.Configuration} provides a simplified
* API for bootstrapping Hibernate, as an alternative to the more
* APIs extensive facilities defined under {@link org.hibernate.boot}.
* </ul>
*/
package org.hibernate.cfg;

16
hibernate-core/src/main/java/org/hibernate/cfg/package.html
View File

@ -1,16 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package defines APIs for configuring Hibernate, and classes
for building the Hibernate configuration-time metamodel.
</p>
</body>
</html>

12
hibernate-core/src/main/java/org/hibernate/classic/package-info.java Normal file
View File

@ -0,0 +1,12 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package historically provided backward-compatibility
* with Hibernate 2.1 APIs which were deprecated in Hibernate 3.
*/
package org.hibernate.classic;

16
hibernate-core/src/main/java/org/hibernate/classic/package.html
View File

@ -1,16 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package implements backward-compatibility with Hibernate 2.1
APIs now deprecated in Hibernate3.
</p>
</body>
</html>

17
hibernate-core/src/main/java/org/hibernate/collection/package-info.java Normal file
View File

@ -0,0 +1,17 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package defines a framework for collection wrappers. The
* interface {@link org.hibernate.collection.spi.PersistentCollection}
* and all its implementations belong to an SPI. They are not part of
* the public API of Hibernate, and are not meant to be used directly
* by typical programs which use Hibernate for persistence.
*
* @see org.hibernate.proxy
*/
package org.hibernate.collection;

15
hibernate-core/src/main/java/org/hibernate/collection/package.html
View File

@ -1,15 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package defines a framework for collection wrappers.
</p>
</body>
</html>

2
hibernate-core/src/main/java/org/hibernate/collection/spi/package-info.java
View File

@ -6,6 +6,6 @@
*/
/**
* SPI definitions for persistent collections
* SPI definitions for persistent collections.
*/
package org.hibernate.collection.spi;

4
hibernate-core/src/main/java/org/hibernate/context/TenantIdentifierMismatchException.java
View File

@ -10,8 +10,8 @@ import org.hibernate.HibernateException;
/**
* Indicates that tenant identifiers did not match in cases where
* {@link org.hibernate.context.spi.CurrentTenantIdentifierResolver#validateExistingCurrentSessions()} returns
* {@code true} and there is a mismatch found.
* {@link org.hibernate.context.spi.CurrentTenantIdentifierResolver#validateExistingCurrentSessions()}
* returns {@code true} and there is a mismatch found.
*
* @author Steve Ebersole
*/

8
hibernate-core/src/main/java/org/hibernate/context/package-info.java
View File

@ -6,6 +6,12 @@
*/
/**
* Defines support for "current session" feature.
* Contains SPIs which define:
* <ul>
* <li>the {@linkplain org.hibernate.context.spi.CurrentSessionContext notion}
* of a context-bound or "current" session, and
* <li>the {@linkplain org.hibernate.context.spi.CurrentTenantIdentifierResolver
* notion} of a "current" tenant id.
* </ul>
*/
package org.hibernate.context;

2
hibernate-core/src/main/java/org/hibernate/context/spi/package-info.java
View File

@ -6,6 +6,6 @@
*/
/**
* SPI level contracts around "current session" support.
* SPI-level contracts around "current session" and "current tenant" support.
*/
package org.hibernate.context.spi;

12
hibernate-core/src/main/java/org/hibernate/dialect/function/package-info.java Normal file
View File

@ -0,0 +1,12 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* Contains implementations of {@link org.hibernate.query.sqm.function.SqmFunctionDescriptor}
* describing a range of relatively-sophisticated SQL functions available in various dialects.
*/
package org.hibernate.dialect.function;

16
hibernate-core/src/main/java/org/hibernate/dialect/function/package.html
View File

@ -1,16 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
A framework for defining database-specific SQL functions
that are available via the dialect.
</p>
</body>
</html>

25
hibernate-core/src/main/java/org/hibernate/dialect/package-info.java Normal file
View File

@ -0,0 +1,25 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* This package abstracts over the multifarious dialects of SQL
* understood by the databases supported by Hibernate. A concrete
* implementation of {@link org.hibernate.dialect.Dialect} defines
* the variant understood by a certain RDBMS.
* <ul>
* <li>An integrator may directly extend {@code Dialect} in order
* to provide support for a database unknown to Hibernate, or
* <li>a program may extend one of the concrete {@code Dialect}s
* in this package in order to customize certain aspects of
* the SQL generated by Hibernate.
* </ul>
* A concrete {@code Dialect} may be explicitly selected using
* {@value org.hibernate.cfg.AvailableSettings#DIALECT}, but
* this is not usually necessary unless a program uses a custom
* implementation.
*/
package org.hibernate.dialect;

18
hibernate-core/src/main/java/org/hibernate/dialect/package.html
View File

@ -1,18 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package abstracts the SQL dialect of the underlying database.
</p>
<p>
A concrete <tt>Dialect</tt> may be specifed using <tt>hibernate.dialect</tt>.
</p>
</body>
</html>

12
hibernate-core/src/main/java/org/hibernate/engine/package-info.java Normal file
View File

@ -0,0 +1,12 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* This package contains classes which are "shared" by other packages,
* and implementations of some key algorithms.
*/
package org.hibernate.engine;

16
hibernate-core/src/main/java/org/hibernate/engine/package.html
View File

@ -1,16 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package contains classes that are "shared" by other packages,
and implementations of some key algorithms.
</p>
</body>
</html>

12
hibernate-core/src/main/java/org/hibernate/event/internal/package-info.java Normal file
View File

@ -0,0 +1,12 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package defines a default set of event listeners that implement
* the default behaviors of Hibernate session operations.
*/
package org.hibernate.event.internal;

16
hibernate-core/src/main/java/org/hibernate/event/internal/package.html
View File

@ -1,16 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package defines a default set of event listeners that
implements the default behaviors of Hibernate.
</p>
</body>
</html>

19
hibernate-core/src/main/java/org/hibernate/event/package-info.java Normal file
View File

@ -0,0 +1,19 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* This package defines a framework which models events occurring
* within a stateful Hibernate {@link org.hibernate.Session}. An
* {@linkplain org.hibernate.event.spi.AbstractEvent event}
* represents a request by the session API for some work to be
* performed, and an event listener must respond to the event and
* do that work, usually by scheduling some sort of
* {@linkplain org.hibernate.action.spi.Executable action}.
*
* @see org.hibernate.action
*/
package org.hibernate.event;

15
hibernate-core/src/main/java/org/hibernate/event/package.html
View File

@ -1,15 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package defines an event framework for Hibernate.
</p>
</body>
</html>

4
hibernate-core/src/main/java/org/hibernate/exception/ConstraintViolationException.java
View File

@ -10,8 +10,8 @@ import java.sql.SQLException;
import org.hibernate.JDBCException;
/**
* Implementation of JDBCException indicating that the requested DML operation
* resulted in a violation of a defined integrity constraint.
* A {@link JDBCException} indicating that the requested DML operation
* resulted in violation of a defined integrity constraint.
*
* @author Steve Ebersole
*/

3
hibernate-core/src/main/java/org/hibernate/exception/DataException.java
View File

@ -5,12 +5,13 @@
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.exception;
import java.sql.SQLException;
import org.hibernate.JDBCException;
/**
* Implementation of JDBCException indicating that evaluation of the
* Extends {@link JDBCException} indicating that evaluation of the
* valid SQL statement against the given data resulted in some
* illegal operation, mismatched types or incorrect cardinality.
*

2
hibernate-core/src/main/java/org/hibernate/exception/GenericJDBCException.java
View File

@ -10,7 +10,7 @@ import java.sql.SQLException;
import org.hibernate.JDBCException;
/**
* Generic, non-specific JDBCException.
* Generic, non-specific flavor of {@link JDBCException}.
*
* @author Steve Ebersole
*/

2
hibernate-core/src/main/java/org/hibernate/exception/JDBCConnectionException.java
View File

@ -10,7 +10,7 @@ import java.sql.SQLException;
import org.hibernate.JDBCException;
/**
* Implementation of JDBCException indicating problems with communicating with the
* A {@link JDBCException} indicating a problem communicating with the
* database (can also include incorrect JDBC setup).
*
* @author Steve Ebersole

2
hibernate-core/src/main/java/org/hibernate/exception/LockAcquisitionException.java
View File

@ -11,7 +11,7 @@ import java.sql.SQLException;
import org.hibernate.JDBCException;
/**
* Implementation of JDBCException indicating a problem acquiring lock
* A {@link JDBCException} indicating a problem acquiring a lock
* on the database.
*
* @author Steve Ebersole

5
hibernate-core/src/main/java/org/hibernate/exception/LockTimeoutException.java
View File

@ -6,9 +6,14 @@
*/
package org.hibernate.exception;
import org.hibernate.JDBCException;
import java.sql.SQLException;
/**
* A {@link JDBCException} indicating that a lock request
* timed out on the database.
*
* @author Steve Ebersole
*/
public class LockTimeoutException extends LockAcquisitionException {

5
hibernate-core/src/main/java/org/hibernate/exception/SQLGrammarException.java
View File

@ -11,7 +11,10 @@ import org.hibernate.JDBCException;
/**
* Specialization of {@link JDBCException} indicating that the SQL sent to the
* database server was invalid (syntax error, invalid object references, etc).
* database server was invalid, either due to a syntax error, unrecognized name,
* or similar problem.
* <p>
* The name of this class is misleading: the SQL might be syntactically well-formed.
*
* @author Steve Ebersole
*/

13
hibernate-core/src/main/java/org/hibernate/exception/package-info.java Normal file
View File

@ -0,0 +1,13 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* Defines certain very important flavors of {@link org.hibernate.JDBCException},
* along with an SPI for interpreting product-specific {@link java.sql.SQLException}s
* arising from a JDBC driver into something more uniform and meaningful.
*/
package org.hibernate.exception;

15
hibernate-core/src/main/java/org/hibernate/exception/package.html
View File

@ -1,15 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package is a fork of Apache commons-lang nestable exceptions.
</p>
</body>
</html>

12
hibernate-core/src/main/java/org/hibernate/exception/spi/package-info.java Normal file
View File

@ -0,0 +1,12 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* An SPI for {@link org.hibernate.dialect.Dialect}-specific exception
* interpretation and conversion.
*/
package org.hibernate.exception.spi;

14
hibernate-core/src/main/java/org/hibernate/generator/package-info.java Normal file
View File

@ -0,0 +1,14 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* This package defines an abstraction over all kinds of automatic
* value generation, including id generation and version number
* generation. The root abstraction is the interface
* {@link org.hibernate.generator.Generator}.
*/
package org.hibernate.generator;

2
hibernate-core/src/main/java/org/hibernate/graph/Graph.java
View File

@ -13,7 +13,7 @@ import org.hibernate.metamodel.model.domain.PersistentAttribute;
/**
* A container for {@link AttributeNode} references.
*
* <p>
* Acts as a "bridge" between JPA's {@link jakarta.persistence.EntityGraph} and {@link jakarta.persistence.Subgraph}
*
* @author <a href="mailto:stliu@hibernate.org">Strong Liu</a>

2
hibernate-core/src/main/java/org/hibernate/graph/package-info.java
View File

@ -6,7 +6,7 @@
*/
/**
* Hibernate's (extended) support for JPA's entity graphs
* Implements and extends the JPA-defined {@link jakarta.persistence.EntityGraph entity graph} API.
*
* @apiNote This entire package (including sub-packages) is considered incubating
*/

15
hibernate-core/src/main/java/org/hibernate/id/package-info.java Normal file
View File

@ -0,0 +1,15 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package contains the built-in id generators, all of which
* implement {@link org.hibernate.id.IdentifierGenerator} or
* {@link org.hibernate.id.PostInsertIdentifierGenerator}.
*
* @see org.hibernate.generator
*/
package org.hibernate.id;

16
hibernate-core/src/main/java/org/hibernate/id/package.html
View File

@ -1,16 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package contains internal implementation classes for the
main API interfaces.
</p>
</body>
</html>

12
hibernate-core/src/main/java/org/hibernate/internal/package-info.java Normal file
View File

@ -0,0 +1,12 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* An internal package containing implementations of central Hibernate APIs,
* mostly defined in {@link org.hibernate}.
*/
package org.hibernate.internal;

15
hibernate-core/src/main/java/org/hibernate/internal/package.html
View File

@ -1,15 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
An internal package containing mostly implementations of central Hibernate APIs.
</p>
</body>
</html>

15
hibernate-core/src/main/java/org/hibernate/jdbc/package-info.java Normal file
View File

@ -0,0 +1,15 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* Abstracts certain very specific aspects of the low-level interaction between Hibernate
* and JDBC.
* <p>
* Defines {@link org.hibernate.jdbc.Work}, {@link org.hibernate.jdbc.ReturningWork} and
* {@link org.hibernate.jdbc.Expectation}, along with some exceptions
*/
package org.hibernate.jdbc;

15
hibernate-core/src/main/java/org/hibernate/jdbc/package.html
View File

@ -1,15 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<body>
<p>
Essentially defines {@link org.hibernate.jdbc.Work}, {@link org.hibernate.jdbc.ReturningWork} and
{@link org.hibernate.jdbc.Expectation} as well as some exceptions
</p>
</body>
</html>

29
hibernate-core/src/main/java/org/hibernate/jpa/package-info.java Normal file
View File

@ -0,0 +1,29 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* Responsible for dealing with certain details of compliance with the
* JPA specification, including:
* <ul>
* <li>{@linkplain org.hibernate.jpa.boot bootstrapping} JPA,
* <li>calling JPA {@linkplain org.hibernate.jpa.event event listeners},
* and
* <li>managing cases where Hibernate intentionally
* {@linkplain org.hibernate.jpa.spi violates} the specification by
* default (something Hibernate only does if it has a really good
* reason to do so).
* </ul>
* Enumerates the {@linkplain jakarta.persistence.Query#setHint hints}
* recognized by Hibernate:
* <ul>
* <li>{@link org.hibernate.jpa.SpecHints} enumerates the standard hints
* defined by the JPA specification.
* <li>{@link org.hibernate.jpa.HibernateHints} enumerates hints defined
* by Hibernate.
* </ul>
*/
package org.hibernate.jpa;

11
hibernate-core/src/main/java/org/hibernate/loader/package-info.java
View File

@ -1,13 +1,16 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html.
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* Support for {@linkplain org.hibernate.loader.ast.spi.Loader loading} entities and
* collections by primary-key, unique-key, natural-key, etc.
* This package defines functionality for processing JDBC result sets
* and returning complex graphs of persistent objects.
* <p>
* Support for {@linkplain org.hibernate.loader.ast.spi.Loader loading}
* entities and collections by primary key, unique key, natural key, etc.
*
* @author Steve Ebersole
*/

16
hibernate-core/src/main/java/org/hibernate/mapping/package-info.java Normal file
View File

@ -0,0 +1,16 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package defines the Hibernate configuration-time mapping model.
* The objects defined in this package are produced by the annotation
* binding process, and consumed by the code with builds persisters and
* loaders. They do not outlive the configuration process.
*
* @see org.hibernate.boot
*/
package org.hibernate.mapping;

18
hibernate-core/src/main/java/org/hibernate/mapping/package.html
View File

@ -1,18 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package defines the Hibernate configuration-time mapping model.
The objects defined in this package are produced by the annotation
binding process, and consumed by the code with builds persisters and
loaders. They do not outlive the configuration process.
</p>
</body>
</html>

6
hibernate-core/src/main/java/org/hibernate/metadata/package-info.java
View File

@ -6,8 +6,8 @@
*/
/**
* This package defines an API for accessing details about model mapping
*
* Deprecated since 6.x in favor of the {@linkplain org.hibernate.metamodel.MappingMetamodel mapping-metamodel}
* This package defines an API for accessing details about model mapping.
* <p>
* Deprecated since 6.x, use the new mapping metamodel defined under {@link org.hibernate.metamodel}
*/
package org.hibernate.metadata;

6
hibernate-core/src/main/java/org/hibernate/metamodel/mapping/package-info.java
View File

@ -6,9 +6,9 @@
*/
/**
* Hibernate's run-time mapping metamodel which defines the mapping
* of the application's domain model parts (entity, attribute, etc)
* to database objects (tables, columns, etc).
* Defines the runtime mapping metamodel, which describes the mapping
* of the application's domain model parts (entities, attributes) to
* relational database objects (tables, columns).
*
* @implNote Built on top of the {@link org.hibernate.persister} package.
*

8
hibernate-core/src/main/java/org/hibernate/metamodel/model/domain/package-info.java
View File

@ -6,8 +6,12 @@
*/
/**
* Extension to and implementation of the
* {@linkplain jakarta.persistence.metamodel Jakarta Persistence metamodel}.
* Defines the runtime domain metamodel, which describes the Java aspect of
* the application's domain model parts (entities, attributes).
* <p>
* The API defined here extends and implements the standard
* {@linkplain jakarta.persistence.metamodel JPA metamodel}.
* <p>
* This metamodel is used in {@linkplain org.hibernate.query query} handling.
*
* @see jakarta.persistence.metamodel

27
hibernate-core/src/main/java/org/hibernate/metamodel/package-info.java
View File

@ -1,22 +1,23 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html.
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* Package defining Hibernate's 2 forms of runtime metamodel:<ul>
* <li>
* The {@linkplain org.hibernate.metamodel.model.domain domain-metamodel} which
* is an extension of the {@linkplain jakarta.persistence.metamodel Jakarta Persistence metamodel}
* and is used in {@linkplain org.hibernate.query query} handling.
* </li>
* <li>
* The {@linkplain org.hibernate.metamodel.mapping mapping-metamodel} which describes the
* application domain model and its mapping to the database. It is distinct from the Jakarta
* Persistence metamodel, which does not contain this mapping information.
* </li>
* This package defines an API for accessing the runtime metamodel describing persistent
* entities in Java and their mappings to the relational database schema.
* <p>
* The runtime metamodel may be divided into two layers:
* <ul>
* <li>The {@linkplain org.hibernate.metamodel.model.domain domain metamodel}, which is
* an extension of the {@linkplain jakarta.persistence.metamodel JPA metamodel} and
* is used in {@linkplain org.hibernate.query query} handling. This layer contains
* information about Java classes, but not about their mappings to the database.
* <li>The {@linkplain org.hibernate.metamodel.mapping mapping metamodel}, which describes
* the application domain model and its mapping to the database. It is distinct from
* the JPA metamodel, which does not contain this O/R mapping information.
* </ul>
* @author Steve Ebersole
*/

12
hibernate-core/src/main/java/org/hibernate/package-info.java Normal file
View File

@ -0,0 +1,12 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package defines the central Hibernate APIs, beginning with
* {@link org.hibernate.Session} and {@link org.hibernate.SessionFactory}.
*/
package org.hibernate;

15
hibernate-core/src/main/java/org/hibernate/package.html
View File

@ -1,15 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package defines the central Hibernate APIs.
</p>
</body>
</html>

11
hibernate-core/src/main/java/org/hibernate/persister/collection/package-info.java Normal file
View File

@ -0,0 +1,11 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package abstracts persistence mechanisms for collections.
*/
package org.hibernate.persister.collection;

22
hibernate-core/src/main/java/org/hibernate/persister/collection/package.html
View File

@ -1,22 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package abstracts the persistence mechanism for collections.
</p>
<p>
Concrete implementations of <tt>CollectionPersister</tt>
define strategies for persistence of particular collection
roles. Collection persisters may optionally implement
<tt>QueryableCollection</tt> if they should be queryable
using HQL or loaded using <tt>OuterJoinLoader</tt>.
</p>
</body>
</html>

11
hibernate-core/src/main/java/org/hibernate/persister/entity/package-info.java Normal file
View File

@ -0,0 +1,11 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package abstracts persistence mechanisms for entities.
*/
package org.hibernate.persister.entity;

25
hibernate-core/src/main/java/org/hibernate/persister/entity/package.html
View File

@ -1,25 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package abstracts persistence mechanisms for
entities, and defines the Hibernate runtime
metamodel.
</p>
<p>
Strategies for persisting entities implement the
<tt>EntityPersister</tt> interface. Optionally,
they may implement certain additional interfaces
that define contracts with various loaders.
Concrete implementations in this package define
the built-in inheritance mapping strategies.
</p>
</body>
</html>

20
hibernate-core/src/main/java/org/hibernate/persister/package-info.java Normal file
View File

@ -0,0 +1,20 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* A persister defines a persistence mechanism and/or mapping strategy
* for a collection or entity:
* <ul>
* <li>An {@link org.hibernate.persister.entity.EntityPersister}
* defines a mechanism for persisting instances of a certain
* entity class.
* <li>A {@link org.hibernate.persister.collection.CollectionPersister}
* defines a mechanism for persisting instances of a given
* collection role.
* </ul>
*/
package org.hibernate.persister;

16
hibernate-core/src/main/java/org/hibernate/persister/package.html
View File

@ -1,16 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
A persister defines a mapping strategy for a collection
or entity.
</p>
</body>
</html>

1
hibernate-core/src/main/java/org/hibernate/persister/walking/spi/package-info.java
View File

@ -11,4 +11,3 @@
* part of the persister model.
*/
package org.hibernate.persister.walking.spi;

2
hibernate-core/src/main/java/org/hibernate/pretty/MessageHelper.java
View File

@ -6,6 +6,7 @@
*/
package org.hibernate.pretty;
import org.hibernate.Internal;
import org.hibernate.collection.spi.PersistentCollection;
import org.hibernate.engine.spi.EntityEntry;
import org.hibernate.engine.spi.SessionFactoryImplementor;
@ -21,6 +22,7 @@ import org.hibernate.type.Type;
*
* @author Max Andersen, Gavin King
*/
@Internal
public final class MessageHelper {
private MessageHelper() {

11
hibernate-core/src/main/java/org/hibernate/pretty/package-info.java Normal file
View File

@ -0,0 +1,11 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* Contains some functions for pretty-printing things for exception and log messages.
*/
package org.hibernate.pretty;

16
hibernate-core/src/main/java/org/hibernate/pretty/package.html
View File

@ -1,16 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
Classes for pretty printing things for exception
and log messages.
</p>
</body>
</html>

4
hibernate-core/src/main/java/org/hibernate/procedure/package-info.java
View File

@ -4,7 +4,6 @@
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.procedure;
/**
* Defines support for executing database stored procedures and functions and accessing its outputs.
@ -33,7 +32,7 @@ package org.hibernate.procedure;
* }
* </code>
* <p>
* Finally output parameters can be accessed using the overloaded {@link org.hibernate.procedure.ProcedureOutputs#getOutputParameterValue} methods.
* Finally, output parameters can be accessed using the overloaded {@link org.hibernate.procedure.ProcedureOutputs#getOutputParameterValue} methods.
* For portability amongst databases, it is advised to access the output parameters after all returns have been
* processed.
*
@ -41,3 +40,4 @@ package org.hibernate.procedure;
* @see org.hibernate.Session#createStoredProcedureCall(String, Class[])
* @see org.hibernate.Session#createStoredProcedureCall(String, String...)
*/
package org.hibernate.procedure;

16
hibernate-core/src/main/java/org/hibernate/proxy/package-info.java Normal file
View File

@ -0,0 +1,16 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* This package defines a framework for lazy-initializing entity proxies.
* The interfaces here and all their implementations belong to an SPI.
* They are not part of the public API of Hibernate, and are not meant to
* be used directly by typical programs which use Hibernate for persistence.
*
* @see org.hibernate.collection
*/
package org.hibernate.proxy;

16
hibernate-core/src/main/java/org/hibernate/proxy/package.html
View File

@ -1,16 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package defines a framework for lazy-initializing
entity proxies.
</p>
</body>
</html>

11
hibernate-core/src/main/java/org/hibernate/query/package-info.java Normal file
View File

@ -0,0 +1,11 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* Everything related to HQL/JPQL, native SQL, and criteria queries.
*/
package org.hibernate.query;

11
hibernate-core/src/main/java/org/hibernate/resource/jdbc/package-info.java Normal file
View File

@ -0,0 +1,11 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* A facility for managing JDBC connections and other heavyweight resources.
*/
package org.hibernate.resource.jdbc;

22
hibernate-core/src/main/java/org/hibernate/result/package-info.java
View File

@ -4,18 +4,19 @@
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.result;
/**
* Defines support for dealing with database results, accounting for mixed result sets and update counts hiding the
* complexity (IMO) of how this is exposed in the JDBC API.
* Defines support for dealing with database results, accounting for mixed
* result sets and update counts hiding the complexity of how this is exposed
* via the JDBC API.
* <ul>
* <li>{@link org.hibernate.result.Outputs} represents the overall group of results.
* <li>{@link org.hibernate.result.Output} represents the mixed individual outcomes,
* which might be either a {@link org.hibernate.result.ResultSetOutput} or
* a {@link org.hibernate.result.UpdateCountOutput}.
* </ul>
*
* {@link org.hibernate.result.Outputs} represents the overall group of results.
*
* {@link org.hibernate.result.Output} represents the mixed individual outcomes, which might be either a {@link org.hibernate.result.ResultSetOutput} or
* a {@link org.hibernate.result.UpdateCountOutput}.
*
* <code>
* <pre>{@code
* Outputs outputs = ...;
* while ( outputs.goToNext() ) {
* final Output output = outputs.getCurrent();
@ -26,5 +27,6 @@ package org.hibernate.result;
* handleUpdateCountOutput( (UpdateCountOutput) output );
* }
* }
* </code>
* }</pre>
*/
package org.hibernate.result;

13
hibernate-core/src/main/java/org/hibernate/service/package-info.java Normal file
View File

@ -0,0 +1,13 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* Defines a framework for pluggable {@linkplain org.hibernate.service.Service services},
* allowing for customization of key components of Hibernate, and abstraction of these
* components as SPI interfaces.
*/
package org.hibernate.service;

11
hibernate-core/src/main/java/org/hibernate/spi/package-info.java Normal file
View File

@ -0,0 +1,11 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
/**
* A tiny SPI for dealing with compound names.
*/
package org.hibernate.spi;

11
hibernate-core/src/main/java/org/hibernate/sql/package-info.java Normal file
View File

@ -0,0 +1,11 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package defines helper classes for rendering SQL fragments and SQL statements.
*/
package org.hibernate.sql;

16
hibernate-core/src/main/java/org/hibernate/sql/package.html
View File

@ -1,16 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package defines helper classes for rendering SQL
fragments and SQL statements.
</p>
</body>
</html>

13
hibernate-core/src/main/java/org/hibernate/stat/package-info.java Normal file
View File

@ -0,0 +1,13 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* This package exposes {@linkplain org.hibernate.stat.Statistics statistics}
* about a running instance of {@link org.hibernate.SessionFactory} and its
* interaction with the database and second-level cache.
*/
package org.hibernate.stat;

15
hibernate-core/src/main/java/org/hibernate/stat/package.html
View File

@ -1,15 +0,0 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later.
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<html>
<head></head>
<body>
<p>
This package exposes statistics about a running Hibernate instance to the application.
</p>
</body>
</html>

2
hibernate-core/src/main/java/org/hibernate/tool/schema/extract/package-info.java
View File

@ -4,8 +4,8 @@
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.tool.schema.extract;
/**
* Defines a model of schema information extracted from the database through JDBC.
*/
package org.hibernate.tool.schema.extract;

11
hibernate-core/src/main/java/org/hibernate/tool/schema/package-info.java Normal file
View File

@ -0,0 +1,11 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
/**
* Contains tooling related to DDL generation, export, migration, and validation.
*/
package org.hibernate.tool.schema;

3
hibernate-core/src/main/java/org/hibernate/transform/AliasToBeanConstructorResultTransformer.java
View File

@ -13,7 +13,10 @@ import org.hibernate.query.TypedTupleTransformer;
/**
* Wraps the tuples in a constructor call.
*
* @deprecated since {@link ResultTransformer} is deprecated
*/
@Deprecated
public class AliasToBeanConstructorResultTransformer<T> implements ResultTransformer<T>, TypedTupleTransformer<T> {
private final Constructor<T> constructor;

3
hibernate-core/src/main/java/org/hibernate/transform/AliasToBeanResultTransformer.java
View File

@ -22,7 +22,10 @@ import org.hibernate.query.TypedTupleTransformer;
* methods or fields matching the alias names.
*
* @author max
*
* @deprecated since {@link ResultTransformer} is deprecated
*/
@Deprecated
public class AliasToBeanResultTransformer<T> implements ResultTransformer<T>, TypedTupleTransformer<T> {
// IMPL NOTE : due to the delayed population of setters (setters cached

3
hibernate-core/src/main/java/org/hibernate/transform/AliasToEntityMapResultTransformer.java
View File

@ -16,7 +16,10 @@ import org.hibernate.query.TypedTupleTransformer;
*
* @author Gavin King
* @author Steve Ebersole
*
* @deprecated since {@link ResultTransformer} is deprecated
*/
@Deprecated
public class AliasToEntityMapResultTransformer implements ResultTransformer<Map<String,Object>>, TypedTupleTransformer<Map<String,Object>> {
public static final AliasToEntityMapResultTransformer INSTANCE = new AliasToEntityMapResultTransformer();

Some files were not shown because too many files have changed in this diff Show More