add an API note to HibernatePersistenceConfiguration

gavinking · gavinking · commit dbe3c4d1d3f5 · 2024-11-24T10:08:24.000+01:00
diff --git a/hibernate-core/src/main/java/org/hibernate/jpa/HibernatePersistenceConfiguration.java b/hibernate-core/src/main/java/org/hibernate/jpa/HibernatePersistenceConfiguration.java
@@ -32,6 +32,12 @@
  * Hibernate extension to the Jakarta Persistence {@link PersistenceConfiguration}
  * contract.
  *
+ * @apiNote The specification explicitly encourages implementors to extend
+ *          {@link PersistenceConfiguration} to accommodate vendor-specific
+ *          extensions in a more typesafe way. Of course, programs which
+ *          desire configuration logic to be portable between JPA providers
+ *          should use {@code PersistenceConfiguration} directly.
+ *
  * @author Steve Ebersole
  *
  * @since 7.0

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,12 @@`
`32`	`32`	`* Hibernate extension to the Jakarta Persistence {@link PersistenceConfiguration}`
`33`	`33`	`* contract.`
`34`	`34`	`*`
	`35`	`+ * @apiNote The specification explicitly encourages implementors to extend`
	`36`	`+ * {@link PersistenceConfiguration} to accommodate vendor-specific`
	`37`	`+ * extensions in a more typesafe way. Of course, programs which`
	`38`	`+ * desire configuration logic to be portable between JPA providers`
	`39`	`+ * should use {@code PersistenceConfiguration} directly.`
	`40`	`+ *`
`35`	`41`	`* @author Steve Ebersole`
`36`	`42`	`*`
`37`	`43`	`* @since 7.0`