Skip to content

mention HibernatePersistenceConfiguration in package-level jdoc #10287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 5, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions hibernate-core/src/main/java/org/hibernate/jpa/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,25 @@
* <p>
* Thus, Hibernate's many powerful extensions to the JPA specification are
* always readily accessible.
* <p>
* The class {@link org.hibernate.jpa.HibernatePersistenceConfiguration}
* extends {@link jakarta.persistence.PersistenceConfiguration} with options
* specific to Hibernate, as explicitly encouraged by the specification, and
* is now the preferred way to start Hibernate when operating outside any
* container environment.
* <p>
* Subpackages define a range of SPIs.
* <ul>
* <li>The subpackage {@link org.hibernate.jpa.boot.spi} contains the SPI of
* this persistence provider, including an SPI used to
* {@linkplain org.hibernate.jpa.boot.spi.Bootstrap bootstrap} the JPA
* provider, and interfaces which may be implemented to contribute extensions
* during of the bootstrap process.
* <li>The package {@link org.hibernate.jpa.event.spi org.hibernate.jpa.event}
* implements support for JPA {@linkplain jakarta.persistence.EntityListeners
* event listeners}.
* <li>The package {@link org.hibernate.jpa.spi} provides SPIs for managing cases
* implements support for JPA entity lifecycle callback methods and
* {@linkplain jakarta.persistence.EntityListeners entity listeners}.
* <li>The package {@link org.hibernate.jpa.spi} provides
* {@linkplain org.hibernate.jpa.spi.JpaCompliance an SPI} for managing cases
* where Hibernate intentionally violates the JPA specification by default
* (something Hibernate only does when it has a really good reason to do so).
* </ul>
Expand Down