add some cross-links to Configuration to javadoc

This commit is contained in:
Gavin 2023-01-09 13:42:49 +01:00
parent a48422ee9b
commit bf60dd9d2a
7 changed files with 26 additions and 7 deletions

View File

@ -19,6 +19,7 @@ import org.hibernate.type.Type;
* work. This contract allows the application to take over the task of determining if an entity is dirty.
*
* @see org.hibernate.cfg.AvailableSettings#CUSTOM_ENTITY_DIRTINESS_STRATEGY
* @see org.hibernate.cfg.Configuration#setCustomEntityDirtinessStrategy(CustomEntityDirtinessStrategy)
* @see org.hibernate.boot.SessionFactoryBuilder#applyCustomEntityDirtinessStrategy(CustomEntityDirtinessStrategy)
*
* @author Steve Ebersole

View File

@ -42,6 +42,9 @@ import org.hibernate.Incubating;
* for example, "secondary table" rather than "join".
*
* @see PhysicalNamingStrategy
* @see org.hibernate.cfg.Configuration#setImplicitNamingStrategy(ImplicitNamingStrategy)
* @see org.hibernate.boot.MetadataBuilder#applyImplicitNamingStrategy(ImplicitNamingStrategy)
* @see org.hibernate.cfg.AvailableSettings#IMPLICIT_NAMING_STRATEGY
*
* @author Steve Ebersole
*/

View File

@ -34,6 +34,9 @@ import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
* {@value org.hibernate.cfg.AvailableSettings#PHYSICAL_NAMING_STRATEGY}.
*
* @see ImplicitNamingStrategy
* @see org.hibernate.cfg.Configuration#setPhysicalNamingStrategy(PhysicalNamingStrategy)
* @see org.hibernate.boot.MetadataBuilder#applyPhysicalNamingStrategy(PhysicalNamingStrategy)
* @see org.hibernate.cfg.AvailableSettings#PHYSICAL_NAMING_STRATEGY
*
* @author Steve Ebersole
*/

View File

@ -22,6 +22,10 @@ import org.hibernate.mapping.UserDefinedType;
* <p>
* An {@linkplain ColumnOrderingStrategy} may be selected using the configuration property
* {@value org.hibernate.cfg.AvailableSettings#COLUMN_ORDERING_STRATEGY}.
*
* @see org.hibernate.cfg.Configuration#setColumnOrderingStrategy(ColumnOrderingStrategy)
* @see org.hibernate.boot.MetadataBuilder#applyColumnOrderingStrategy(ColumnOrderingStrategy)
* @see org.hibernate.cfg.AvailableSettings#COLUMN_ORDERING_STRATEGY
*/
@Incubating
public interface ColumnOrderingStrategy {

View File

@ -7,13 +7,16 @@
package org.hibernate.context.spi;
/**
* A callback registered with the {@link org.hibernate.SessionFactory} that is responsible
* for resolving the current tenant identifier.
* A callback registered with the {@link org.hibernate.SessionFactory} that is
* responsible for resolving the current tenant identifier.
* <p>
* An implementation may be selected by setting the configuration property
* {@value org.hibernate.cfg.AvailableSettings#MULTI_TENANT_IDENTIFIER_RESOLVER}.
*
* @see org.hibernate.cfg.Configuration#setCurrentTenantIdentifierResolver
* @see org.hibernate.boot.SessionFactoryBuilder#applyCurrentTenantIdentifierResolver
* @see org.hibernate.annotations.TenantId
* @see org.hibernate.cfg.AvailableSettings#MULTI_TENANT_IDENTIFIER_RESOLVER
*
* @author Steve Ebersole
*/
@ -26,19 +29,22 @@ public interface CurrentTenantIdentifierResolver {
String resolveCurrentTenantIdentifier();
/**
* Should we validate that the tenant identifier on "current sessions" that already exist when
* {@link CurrentSessionContext#currentSession()} is called matches the value returned here from
* {@link #resolveCurrentTenantIdentifier()}?
* Should we validate that the tenant identifier of a "current sessions" that
* already exists when {@link CurrentSessionContext#currentSession()} is called
* matches the value returned here from {@link #resolveCurrentTenantIdentifier()}?
*
* @return {@code true} indicates that the extra validation will be performed; {@code false} indicates it will not.
* @return {@code true} indicates that the extra validation will be performed;
* {@code false} indicates it will not.
*
* @see org.hibernate.context.TenantIdentifierMismatchException
*/
boolean validateExistingCurrentSessions();
/**
* Does the given tenant id represent a "root" tenant with access to all partitions.
* Does the given tenant id represent a "root" tenant with access to all partitions?
*
* @param tenantId a tenant id produced by {@link #resolveCurrentTenantIdentifier()}
*
* @return true is this is root tenant
*/
default boolean isRoot(String tenantId) {

View File

@ -9,6 +9,7 @@ package org.hibernate.proxy;
/**
* Delegate to handle the scenario of an entity not found by a specified id.
*
* @see org.hibernate.cfg.Configuration#setEntityNotFoundDelegate(EntityNotFoundDelegate)
* @see org.hibernate.boot.SessionFactoryBuilder#applyEntityNotFoundDelegate(EntityNotFoundDelegate)
*
* @author Steve Ebersole

View File

@ -25,6 +25,7 @@ import java.io.Serializable;
* An implementation registered this way is shared between sessions.
*
* @see org.hibernate.cfg.AvailableSettings#STATEMENT_INSPECTOR
* @see org.hibernate.cfg.Configuration#setStatementInspector(StatementInspector)
* @see org.hibernate.boot.SessionFactoryBuilder#applyStatementInspector(StatementInspector)
* @see org.hibernate.SessionBuilder#statementInspector(StatementInspector)
*