minor javadoc improvements to Builder stuff

Signed-off-by: Gavin King <gavin@hibernate.org>
This commit is contained in:
Gavin King 2024-05-22 15:51:15 +02:00
parent 2e9acf1ded
commit 2b801702f1
4 changed files with 24 additions and 3 deletions

View File

@ -16,6 +16,8 @@ import org.hibernate.resource.jdbc.spi.StatementInspector;
* Allows creation of a new {@link Session} with specific options.
*
* @author Steve Ebersole
*
* @see SessionFactory#withOptions()
*/
public interface SessionBuilder {
/**

View File

@ -16,6 +16,8 @@ import java.util.TimeZone;
* Specialized {@link SessionBuilder} with access to stuff from another session.
*
* @author Steve Ebersole
*
* @see Session#sessionWithOptions()
*/
public interface SharedSessionBuilder extends SessionBuilder {

View File

@ -14,6 +14,8 @@ import org.hibernate.resource.jdbc.spi.StatementInspector;
* Allows creation of a new {@link StatelessSession} with specific options.
*
* @author Steve Ebersole
*
* @see SessionFactory#withStatelessOptions()
*/
public interface StatelessSessionBuilder {
/**

View File

@ -27,12 +27,14 @@ import org.hibernate.resource.jdbc.spi.StatementInspector;
import org.hibernate.type.format.FormatMapper;
/**
* The contract for building a {@link SessionFactory} given a number of options.
* The contract for building a {@link SessionFactory} given a specified set of options.
*
* @author Steve Ebersole
* @author Gail Badner
*
* @since 5.0
*
* @see Metadata#getSessionFactoryBuilder()
*/
public interface SessionFactoryBuilder {
/**
@ -256,6 +258,12 @@ public interface SessionFactoryBuilder {
*/
SessionFactoryBuilder applyLazyInitializationOutsideTransaction(boolean enabled);
/**
* Specifies how temporary tables should be created or dropped with respect
* to transaction handling.
*
* @see TempTableDdlTransactionHandling
*/
SessionFactoryBuilder applyTempTableDdlTransactionHandling(TempTableDdlTransactionHandling handling);
/**
@ -360,11 +368,18 @@ public interface SessionFactoryBuilder {
SessionFactoryBuilder applyOrderingOfUpdates(boolean enabled);
/**
* Specifies whether multi-tenancy is enabled
* Specifies whether multitenancy is enabled via use of a
* {@link org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider}.
* <p>
* Note that this setting does not affect
* {@linkplain org.hibernate.annotations.TenantId discriminator-based}
* multitenancy.
*
* @param enabled True if multi-tenancy in use through a {@link org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider}.
* @param enabled True if multi-tenancy in use via a {@code MultiTenantConnectionProvider}.
*
* @return {@code this}, for method chaining
*
* @see org.hibernate.cfg.AvailableSettings#MULTI_TENANT_CONNECTION_PROVIDER
*/
SessionFactoryBuilder applyMultiTenancy(boolean enabled);