From 466e7e74693e4b3bd4325203d6bcaf96d471d282 Mon Sep 17 00:00:00 2001 From: Gavin King Date: Fri, 21 Jan 2022 18:35:43 +0100 Subject: [PATCH] first round of Javadoc update to AvailableSettings --- .../cache/spi/TimestampsCacheFactory.java | 9 +- .../org/hibernate/cfg/AvailableSettings.java | 1083 +++++++++-------- .../jta/platform/spi/JtaPlatform.java | 8 +- 3 files changed, 561 insertions(+), 539 deletions(-) diff --git a/hibernate-core/src/main/java/org/hibernate/cache/spi/TimestampsCacheFactory.java b/hibernate-core/src/main/java/org/hibernate/cache/spi/TimestampsCacheFactory.java index 5b9a65570b..6031aaf761 100644 --- a/hibernate-core/src/main/java/org/hibernate/cache/spi/TimestampsCacheFactory.java +++ b/hibernate-core/src/main/java/org/hibernate/cache/spi/TimestampsCacheFactory.java @@ -7,9 +7,12 @@ package org.hibernate.cache.spi; /** - * Responsible for building the TimestampsRegionAccessFactory to use for - * managing query results in regards to staleness of the underlying - * tables (sometimes called "query spaces" or "table spaces") + * Responsible for building the {@link TimestampsCache} to use for + * managing query results with respect to staleness of the underlying + * tables (sometimes called "query spaces" or "table spaces"). + *

+ * An implementation may be selected using the configuration property + * {@link org.hibernate.cfg.AvailableSettings#QUERY_CACHE_FACTORY}. * * @author Steve Ebersole */ diff --git a/hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java b/hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java index 46e0e22543..d8e94292e0 100644 --- a/hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java +++ b/hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java @@ -8,32 +8,6 @@ import java.util.function.Supplier; -import org.hibernate.HibernateException; -import org.hibernate.jpa.HibernateHints; -import org.hibernate.query.NativeQuery; -import org.hibernate.Transaction; -import org.hibernate.boot.MetadataBuilder; -import org.hibernate.boot.registry.classloading.internal.TcclLookupPrecedence; -import org.hibernate.boot.spi.SessionFactoryOptions; -import org.hibernate.cache.spi.TimestampsCacheFactory; -import org.hibernate.collection.spi.PersistentBag; -import org.hibernate.collection.spi.PersistentList; -import org.hibernate.engine.jdbc.dialect.spi.DialectResolver; -import org.hibernate.jpa.spi.JpaCompliance; -import org.hibernate.query.ImmutableEntityUpdateQueryHandlingMode; -import org.hibernate.query.hql.HqlTranslator; -import org.hibernate.query.internal.ParameterMetadataImpl; -import org.hibernate.query.spi.QueryInterpretationCache; -import org.hibernate.query.sqm.mutation.spi.SqmMultiTableMutationStrategy; -import org.hibernate.query.sqm.sql.SqmTranslatorFactory; -import org.hibernate.resource.beans.container.spi.ExtendedBeanManager; -import org.hibernate.resource.transaction.spi.TransactionCoordinator; -import org.hibernate.resource.transaction.spi.TransactionCoordinatorBuilder; -import org.hibernate.tool.schema.JdbcMetadaAccessStrategy; -import org.hibernate.tool.schema.SourceType; -import org.hibernate.tool.schema.UniqueConstraintSchemaUpdateStrategy; -import org.hibernate.tool.schema.internal.script.SingleLineSqlScriptExtractor; - /** * @author Steve Ebersole */ @@ -185,26 +159,27 @@ public interface AvailableSettings { String JAKARTA_LOCK_TIMEOUT = "jakarta.persistence.lock.timeout"; /** - * Used to pass along the CDI BeanManager, if any, to be used. - * - * According to JPA, strictly, the BeanManager should be passed in - * at boot-time and be ready for use at that time. However not all - * environments can do this (WildFly e.g.). To accommodate such - * environments, Hibernate provides 2 options: - * - * * a proprietary CDI extension SPI (that we have proposed to - * the CDI spec group as a standard option) that can be used - * to provide delayed BeanManager access. To use this solution, - * the reference passed as the BeanManager during bootstrap - * should be typed as {@link ExtendedBeanManager} - * * delayed access to the BeanManager reference. Here, Hibernate - * will not access the reference passed as the BeanManager during - * bootstrap until it is first needed. Note however that this has - * the effect of delaying any deployment problems until after - * bootstrapping. - * - * This setting is used to configure Hibernate ORM's access to - * the BeanManager (either directly or via {@link ExtendedBeanManager}). + * Used to pass along the CDI {@link jakarta.enterprise.inject.spi.BeanManager}, + * if any, to be used. + *

+ * According to JPA, strictly, the {@code BeanManager} should be passed in at + * boot-time and be ready for use at that time. However not all environments + * can do this (WildFly e.g.). To accommodate such environments, Hibernate + * provides two options: + *

    + *
  1. A proprietary CDI extension SPI (which has been proposed to the CDI + * spec group as a standard option) which can be used to provide delayed + * {@code BeanManager} access: to use this solution, the reference passed as + * the {@code BeanManager} during bootstrap should be typed as + * {@link org.hibernate.resource.beans.container.spi.ExtendedBeanManager}. + *
  2. Delayed access to the {@code BeanManager} reference: here, Hibernate + * will not access the reference passed as the {@code BeanManager} during + * bootstrap until it is first needed. Note however that this has the effect + * of delaying any deployment problems until after bootstrapping. + *
+ * This setting is used to configure access to the {@code BeanManager} + * (either directly or via + * {@link org.hibernate.resource.beans.container.spi.ExtendedBeanManager}). */ String JAKARTA_CDI_BEAN_MANAGER = "jakarta.persistence.bean.manager"; @@ -225,13 +200,12 @@ public interface AvailableSettings { * Used to define how the current thread context {@link ClassLoader} must be used * for class lookup. * - * @see TcclLookupPrecedence + * @see org.hibernate.boot.registry.classloading.internal.TcclLookupPrecedence */ String TC_CLASSLOADER = "hibernate.classLoader.tccl_lookup_precedence"; /** - * Setting that indicates whether to build the JPA types. Accepts - * 3 values: