javadoc improvements

This commit is contained in:
Gavin King 2024-11-23 22:16:14 +01:00
parent ddeaffc917
commit 10935e1c33
3 changed files with 14 additions and 3 deletions

View File

@ -453,6 +453,10 @@ public interface SessionFactoryOptions extends QueryEngineOptions {
} }
/** /**
* Should HQL integer division HQL should produce an integer on
* Oracle, MySQL, and MariaDB, where the {@code /} operator produces
* a non-integer.
*
* @see org.hibernate.cfg.AvailableSettings#PORTABLE_INTEGER_DIVISION * @see org.hibernate.cfg.AvailableSettings#PORTABLE_INTEGER_DIVISION
*/ */
@Override @Override
@ -461,11 +465,18 @@ public interface SessionFactoryOptions extends QueryEngineOptions {
} }
/** /**
* The number of {@link org.hibernate.stat.QueryStatistics} entries
* that should be stored by {@link org.hibernate.stat.Statistics}.
*
* @see org.hibernate.cfg.StatisticsSettings#QUERY_STATISTICS_MAX_SIZE * @see org.hibernate.cfg.StatisticsSettings#QUERY_STATISTICS_MAX_SIZE
*/ */
int getQueryStatisticsMaxSize(); int getQueryStatisticsMaxSize();
/** /**
* Should JPA entity lifecycle callbacks be processed by
* the {@link org.hibernate.event.spi.EventEngine} and
* {@link org.hibernate.jpa.event.spi.CallbackRegistry}?
*
* @see org.hibernate.cfg.PersistenceSettings#JPA_CALLBACKS_ENABLED * @see org.hibernate.cfg.PersistenceSettings#JPA_CALLBACKS_ENABLED
*/ */
boolean areJPACallbacksEnabled(); boolean areJPACallbacksEnabled();

View File

@ -23,8 +23,8 @@ import org.jboss.logging.Logger;
/** /**
* The intent of this class is to use a lighter implementation * The intent of this class is to use a lighter implementation
* when JPA callbacks are disabled via * when standard JPA entity lifecycle callbacks are disabled via
* {@link SessionFactoryOptions#areJPACallbacksEnabled()} * {@link SessionFactoryOptions#areJPACallbacksEnabled()}.
*/ */
public final class CallbacksFactory { public final class CallbacksFactory {
private static final Logger log = Logger.getLogger( CallbacksFactory.class ); private static final Logger log = Logger.getLogger( CallbacksFactory.class );

View File

@ -5,7 +5,7 @@
package org.hibernate.jpa.event.spi; package org.hibernate.jpa.event.spi;
/** /**
* Registry of Callbacks by entity and type * Registry of JPA entity lifecycle callbacks by entity and type.
* *
* @author Steve Ebersole * @author Steve Ebersole
*/ */