add an @apiNote to SessionFactoryOptions

This commit is contained in:
Gavin King 2024-11-16 16:28:16 +01:00
parent bbc343945f
commit a5536a0afe
1 changed files with 5 additions and 0 deletions

View File

@ -39,7 +39,12 @@ import static org.hibernate.internal.log.DeprecationLogger.DEPRECATION_LOGGER;
/**
* Aggregator of special options used to build the {@link org.hibernate.SessionFactory}.
*
* @apiNote This type belongs to an SPI package. Due to a historical mistake, it is exposed
* via the deprecated method {@link org.hibernate.SessionFactory#getSessionFactoryOptions}.
*
* @since 5.0
*
* @see SessionFactoryImplementor#getSessionFactoryOptions
*/
public interface SessionFactoryOptions extends QueryEngineOptions {
/**