Skip to content

Commit 12118ee

Browse files
committed
mention HibernatePersistenceConfiguration in package-level jdoc
1 parent d3bc67b commit 12118ee

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

hibernate-core/src/main/java/org/hibernate/jpa/package-info.java

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,25 @@
2626
* <p>
2727
* Thus, Hibernate's many powerful extensions to the JPA specification are
2828
* always readily accessible.
29+
* <p>
30+
* The class {@link org.hibernate.jpa.HibernatePersistenceConfiguration}
31+
* extends {@link jakarta.persistence.PersistenceConfiguration} with options
32+
* specific to Hibernate, as explicitly encouraged by the specification, and
33+
* is now the preferred way to start Hibernate when operating outside any
34+
* container environment.
35+
* <p>
36+
* Subpackages define a range of SPIs.
2937
* <ul>
3038
* <li>The subpackage {@link org.hibernate.jpa.boot.spi} contains the SPI of
3139
* this persistence provider, including an SPI used to
3240
* {@linkplain org.hibernate.jpa.boot.spi.Bootstrap bootstrap} the JPA
3341
* provider, and interfaces which may be implemented to contribute extensions
3442
* during of the bootstrap process.
3543
* <li>The package {@link org.hibernate.jpa.event.spi org.hibernate.jpa.event}
36-
* implements support for JPA {@linkplain jakarta.persistence.EntityListeners
37-
* event listeners}.
38-
* <li>The package {@link org.hibernate.jpa.spi} provides SPIs for managing cases
44+
* implements support for JPA entity lifecycle callback methods and
45+
* {@linkplain jakarta.persistence.EntityListeners entity listeners}.
46+
* <li>The package {@link org.hibernate.jpa.spi} provides
47+
* {@linkplain org.hibernate.jpa.spi.JpaCompliance an SPI} for managing cases
3948
* where Hibernate intentionally violates the JPA specification by default
4049
* (something Hibernate only does when it has a really good reason to do so).
4150
* </ul>

0 commit comments

Comments
 (0)