Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

use @value instead of @link for setting names in Javadoc

This commit is contained in:
Gavin King 2022-01-20 15:23:16 +01:00
parent 71f122d2e5
commit dded606259
24 changed files with 91 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hibernate-core/src/main/java/org/hibernate/SharedSessionContract.java
View File

@ -169,7 +169,7 @@ public interface SharedSessionContract extends QueryProducer, Closeable, Seriali
* Set the session-level JDBC batch size. Overrides the
* {@link org.hibernate.boot.spi.SessionFactoryOptions#getJdbcBatchSize() factory-level}
* JDBC batch size defined by the configuration property
* {@link org.hibernate.cfg.AvailableSettings#STATEMENT_BATCH_SIZE}.
* {@value org.hibernate.cfg.AvailableSettings#STATEMENT_BATCH_SIZE}.
*
* @param jdbcBatchSize the new session-level JDBC batch size
*

24
hibernate-core/src/main/java/org/hibernate/boot/MetadataBuilder.java
View File

@ -40,7 +40,7 @@ public interface MetadataBuilder {
/**
* Specify the implicit catalog name to apply to any unqualified database names.
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG}
* setting if using property-based configuration.
*
* @param implicitCatalogName The implicit catalog name
@ -54,7 +54,7 @@ public interface MetadataBuilder {
/**
* Specify the implicit schema name to apply to any unqualified database names.
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#DEFAULT_SCHEMA}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#DEFAULT_SCHEMA}
* setting if using property-based configuration.
*
* @param implicitSchemaName The implicit schema name
@ -68,7 +68,7 @@ public interface MetadataBuilder {
/**
* Specify the ImplicitNamingStrategy to use in building the Metadata.
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#IMPLICIT_NAMING_STRATEGY}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#IMPLICIT_NAMING_STRATEGY}
* setting if using property-based configuration.
*
* @param namingStrategy The ImplicitNamingStrategy to apply
@ -82,7 +82,7 @@ public interface MetadataBuilder {
/**
* Specify the PhysicalNamingStrategy to use in building the Metadata.
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#PHYSICAL_NAMING_STRATEGY}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#PHYSICAL_NAMING_STRATEGY}
* setting if using property-based configuration.
*
* @param namingStrategy The PhysicalNamingStrategy to apply
@ -112,7 +112,7 @@ public interface MetadataBuilder {
* Specify the second-level access-type to be used by default for entities and collections that define second-level
* caching, but do not specify a granular access-type.
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#DEFAULT_CACHE_CONCURRENCY_STRATEGY}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#DEFAULT_CACHE_CONCURRENCY_STRATEGY}
* setting if using property-based configuration.
*
* @param accessType The access-type to use as default.
@ -162,7 +162,7 @@ public interface MetadataBuilder {
/**
* Specify a particular Scanner instance to use.
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#SCANNER}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#SCANNER}
* setting if using property-based configuration.
*
* @param scanner The scanner to use.
@ -176,7 +176,7 @@ public interface MetadataBuilder {
/**
* Specify a particular ArchiveDescriptorFactory instance to use in scanning.
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#SCANNER_ARCHIVE_INTERPRETER}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#SCANNER_ARCHIVE_INTERPRETER}
* setting if using property-based configuration.
*
* @param factory The ArchiveDescriptorFactory to use.
@ -198,7 +198,7 @@ public interface MetadataBuilder {
* explicit discriminators along with joined inheritance. It is configurable
* though to support legacy apps.
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#IGNORE_EXPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS}
* setting if using property-based configuration.
*
* @param enabled Should processing (not ignoring) explicit discriminators be
@ -220,7 +220,7 @@ public interface MetadataBuilder {
* Again the premise here is JPA portability, bearing in mind that some
* JPA provider need these discriminators.
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#IMPLICIT_DISCRIMINATOR_COLUMNS_FOR_JOINED_SUBCLASS}
* setting if using property-based configuration.
*
* @param enabled Should we implicitly create discriminator for joined
@ -236,7 +236,7 @@ public interface MetadataBuilder {
* For entities which do not explicitly say, should we force discriminators into
* SQL selects? The (historical) default is {@code false}
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#FORCE_DISCRIMINATOR_IN_SELECTS_BY_DEFAULT}
* setting if using property-based configuration.
*
* @param supported {@code true} indicates we will force the discriminator into the select;
@ -252,7 +252,7 @@ public interface MetadataBuilder {
* Should nationalized variants of character data be used in the database types? For example, should
* {@code NVARCHAR} be used instead of {@code VARCHAR}? {@code NCLOB} instead of {@code CLOB}?
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#USE_NATIONALIZED_CHARACTER_DATA}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#USE_NATIONALIZED_CHARACTER_DATA}
* setting if using property-based configuration.
*
* @param enabled {@code true} says to use nationalized variants; {@code false}
@ -335,7 +335,7 @@ public interface MetadataBuilder {
* of the methods on this contract that deal with multiple values internally, this
* one *replaces* any already set (its more a setter) instead of adding to.
* <p/>
* Its default is defined by the {@link org.hibernate.cfg.AvailableSettings#ARTIFACT_PROCESSING_ORDER}
* Its default is defined by the {@value org.hibernate.cfg.AvailableSettings#ARTIFACT_PROCESSING_ORDER}
* setting if using property-based configuration.
*
* @param sourceTypes The types, in the order they should be processed

2
hibernate-core/src/main/java/org/hibernate/boot/model/relational/internal/SqlStringGenerationContextImpl.java
View File

@ -28,7 +28,7 @@ public class SqlStringGenerationContextImpl
/**
* @param jdbcEnvironment The JDBC environment, to extract the dialect, identifier helper, etc.
* @param database The database metadata, to retrieve the implicit namespace name configured through XML mapping.
* @param configurationMap The configuration map, holding settings such as {@link AvailableSettings#DEFAULT_SCHEMA}.
* @param configurationMap The configuration map, holding settings such as {@value AvailableSettings#DEFAULT_SCHEMA}.
* @return An {@link SqlStringGenerationContext}.
*/
public static SqlStringGenerationContext fromConfigurationMap(

2
hibernate-core/src/main/java/org/hibernate/cache/internal/CollectionCacheInvalidator.java vendored
View File

@ -40,7 +40,7 @@ import org.jboss.logging.Logger;
* Allows the collection cache to be automatically evicted if an element is inserted/removed/updated *without* properly
* managing both sides of the association (ie, the ManyToOne collection is changed w/o properly managing the OneToMany).
*
* For this functionality to be used, {@link org.hibernate.cfg.AvailableSettings#AUTO_EVICT_COLLECTION_CACHE} must be
* For this functionality to be used, {@value org.hibernate.cfg.AvailableSettings#AUTO_EVICT_COLLECTION_CACHE} must be
* enabled. For performance reasons, it's disabled by default.
*
* @author Andreas Berger

3
hibernate-core/src/main/java/org/hibernate/cache/spi/RegionFactory.java vendored
View File

@ -27,6 +27,9 @@ import org.hibernate.service.spi.Stoppable;
* </ul>
* Use the first when we need to read config properties prior to
* {@link #start} being called.
* <p>
* A {@code RegionFactory} may be selected using the property
* {@value org.hibernate.cfg.AvailableSettings#CACHE_REGION_FACTORY}.
*
* @author Steve Ebersole
*/

25
hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java
View File

@ -498,7 +498,7 @@ public interface AvailableSettings {
* Should we prefer using the {@link org.hibernate.engine.transaction.jta.platform.spi.JtaPlatform#retrieveUserTransaction}
* over using {@link org.hibernate.engine.transaction.jta.platform.spi.JtaPlatform#retrieveTransactionManager}?
*
* Default is <code>false</code>
* Default is {@code false}
*
* @since 5.0
*/
@ -796,7 +796,7 @@ public interface AvailableSettings {
/**
* Use JDBC scrollable {@code ResultSet}s. This property is only necessary when there is
* no {@code ConnectionProvider}, ie. the user is supplying JDBC connections.
* no {@code ConnectionProvider}, that is, when the client is supplying JDBC connections.
*/
String USE_SCROLLABLE_RESULTSET = "hibernate.jdbc.use_scrollable_resultset";
@ -999,9 +999,10 @@ public interface AvailableSettings {
/**
* Setting which indicates whether or not Java constant follow the Java Naming conventions.
* <p/>
* Default is {@code true}. Existing applications may want to disable this (set it {@code false}) if non-conventional Java constants are used.
* However, there is a significant performance overhead for using non-conventional Java constants since Hibernate cannot determine if aliases
* should be treated as Java constants or not.
* Default is {@code true}. Existing applications may want to disable this (set it {@code false})
* if unconventional Java constants are used. However, there is a significant performance overhead
* for using unconventional Java constants since Hibernate cannot determine if aliases should be
* treated as Java constants or not.
*
* @since 5.2
*/
@ -1172,8 +1173,8 @@ public interface AvailableSettings {
/**
* Proxool property with the Proxool pool alias to use
* (Required for {@code PROXOOL_EXISTING_POOL}, {@code PROXOOL_PROPERTIES}, or
* {@code PROXOOL_XML})
* (Required for {@link #PROXOOL_EXISTING_POOL}, {@link #PROXOOL_PROPERTIES}, or
* {@link #PROXOOL_XML})
*/
String PROXOOL_POOL_ALIAS = "hibernate.proxool.pool_alias";
@ -1716,7 +1717,7 @@ public interface AvailableSettings {
/**
* Identifies the delimiter to use to separate schema management statements in script outputs.
* The default value is <code>;</code>.
* The default value is {@code ;}.
*/
String HBM2DDL_DELIMITER = "hibernate.hbm2ddl.delimiter";
@ -1754,8 +1755,8 @@ public interface AvailableSettings {
String CUSTOM_ENTITY_DIRTINESS_STRATEGY = "hibernate.entity_dirtiness_strategy";
/**
* Controls whether an entity's "where" clause, mapped using <code>@Where(clause="....")</code>
* or <code>&lt;entity ... where="..."&gt;</code>, is taken into account when loading one-to-many
* Controls whether an entity's "where" clause, mapped using {@code @Where(clause="....")}
* or {@code &lt;entity ... where="..."&gt;}, is taken into account when loading one-to-many
* or many-to-many collections of that type of entity.
* <p/>
* This setting has no affect on collections of embeddable values containing an association to
@ -1860,7 +1861,7 @@ public interface AvailableSettings {
* access; this ensures that all access patterns which are not useful
* to the application are never instantiated, possibly saving a
* substantial amount of memory for applications having many entities.
* The only exception is the loader for <code>LockMode.NONE</code>,
* The only exception is the loader for {@link org.hibernate.LockMode#NONE},
* which will always be eagerly initialized; this is necessary to
* detect mapping errors.
*
@ -1879,7 +1880,7 @@ public interface AvailableSettings {
* to handle this situation requires checking the Thread ID every time
* Session is called. This can certainly have performance considerations.
*
* Default is <code>true</code> (enabled).
* Default is {@code true} (enabled).
*/
String JTA_TRACK_BY_THREAD = "hibernate.jta.track_by_thread";

16
hibernate-core/src/main/java/org/hibernate/context/internal/JTASessionContext.java
View File

@ -26,16 +26,16 @@ import org.jboss.logging.Logger;
/**
* An implementation of {@link org.hibernate.context.spi.CurrentSessionContext} which scopes the notion
* of a current session to a JTA transaction. Because JTA gives us a nice tie-in to clean up after
* ourselves, this implementation will generate Sessions as needed provided a JTA transaction is in
* ourselves, this implementation will generate Sessions as needed, provided a JTA transaction is in
* effect. If a session is not already associated with the current JTA transaction at the time
* {@link #currentSession()} is called, a new session will be opened and it will be associated with that
* JTA transaction.
*
* {@link #currentSession()} is called, a new session is opened and is associated with the JTA
* transaction.
* <p>
* Note that the sessions returned from this method are automatically configured with both the
* {@link org.hibernate.cfg.Environment#FLUSH_BEFORE_COMPLETION auto-flush} and
* {@link org.hibernate.cfg.Environment#AUTO_CLOSE_SESSION auto-close} attributes set to true, meaning
* that the Session will be automatically flushed and closed as part of the lifecycle for the JTA
* transaction to which it is associated. Additionally, it will also be configured to aggressively
* properties {@value org.hibernate.cfg.Environment#FLUSH_BEFORE_COMPLETION} and
* {@value org.hibernate.cfg.Environment#AUTO_CLOSE_SESSION} set to true,
* meaning that the session will be automatically flushed and closed as part of the lifecycle of the
* JTA transaction with which it is associated. Additionally, it will be configured to aggressively
* release JDBC connections after each statement is executed. These settings are governed by the
* {@link #isAutoFlushEnabled()}, {@link #isAutoCloseEnabled()}, and {@link #getConnectionReleaseMode()}
* methods; these are provided (along with the {@link #buildOrObtainSession()} method) for easier

14
hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java
View File

@ -207,6 +207,12 @@ import static org.hibernate.type.descriptor.DateTimeUtils.appendAsTimestampWithM
* Programs using Hibernate should migrate away from the use of versioned
* dialect classes like, for example, {@link PostgreSQL95Dialect}. These
* classes are now deprecated and will be removed in a future release.
* <p>
* A custom {@code Dialect} may be specified using the configuration
* property {@value org.hibernate.cfg.AvailableSettings#DIALECT}, but
* for supported databases this property is unnecessary, and Hibernate
* will select the correct {@code Dialect} based on the JDBC URL and
* {@link DialectResolutionInfo}.
*
* @author Gavin King, David Channon
*/
@ -1264,7 +1270,7 @@ public abstract class Dialect implements ConversionContext {
/**
* The default value to use for the configuration property
* {@link Environment#STATEMENT_BATCH_SIZE}.
* {@value Environment#STATEMENT_BATCH_SIZE}.
*/
public int getDefaultStatementBatchSize() {
return 1;
@ -1272,7 +1278,7 @@ public abstract class Dialect implements ConversionContext {
/**
* The default value to use for the configuration property
* {@link Environment#USE_STREAMS_FOR_BINARY}.
* {@value Environment#USE_STREAMS_FOR_BINARY}.
*/
public boolean getDefaultUseStreamsForBinary() {
return false;
@ -1280,7 +1286,7 @@ public abstract class Dialect implements ConversionContext {
/**
* The default value to use for the configuration property
* {@link Environment#NON_CONTEXTUAL_LOB_CREATION}.
* {@value Environment#NON_CONTEXTUAL_LOB_CREATION}.
*/
public boolean getDefaultNonContextualLobCreation() {
return false;
@ -1288,7 +1294,7 @@ public abstract class Dialect implements ConversionContext {
/**
* The default value to use for the configuration property
* {@link Environment#USE_GET_GENERATED_KEYS}.
* {@value Environment#USE_GET_GENERATED_KEYS}.
*/
public boolean getDefaultUseGetGeneratedKeys() {
return true;

6
hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/DatasourceConnectionProviderImpl.java
View File

@ -24,9 +24,9 @@ import org.hibernate.service.spi.Stoppable;
* A {@link ConnectionProvider} that manages connections from an underlying {@link DataSource}.
* <p/>
* The {@link DataSource} to use may be specified by either:<ul>
* <li>injection via {@link #setDataSource}</li>
* <li>declaring the {@link DataSource} instance using the {@link Environment#DATASOURCE} config property</li>
* <li>declaring the JNDI name under which the {@link DataSource} can be found via {@link Environment#DATASOURCE} config property</li>
* <li>injection using {@link #setDataSource}</li>
* <li>declaring the {@link DataSource} instance using the {@value Environment#DATASOURCE} config property</li>
* <li>declaring the JNDI name under which the {@link DataSource} can be found via the {@value Environment#DATASOURCE} config property</li>
* </ul>
*
* @author Gavin King

21
hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/spi/ConnectionProvider.java
View File

@ -12,11 +12,12 @@ import org.hibernate.service.Service;
import org.hibernate.service.spi.Wrapped;
/**
* A contract for obtaining JDBC connections.
* <p/>
* Implementors might also implement connection pooling.
* <p/>
* Implementors should provide a public default constructor.
* A contract for obtaining JDBC connections and, optionally, for pooling connections.
* <p>
* Implementors must provide a public default constructor.
* <p>
* A {@code ConnectionProvider} may be selected using the configuration property
* {@value org.hibernate.cfg.AvailableSettings#CONNECTION_PROVIDER}.
*
* @author Gavin King
* @author Steve Ebersole
@ -43,15 +44,15 @@ public interface ConnectionProvider extends Service, Wrapped {
public void closeConnection(Connection conn) throws SQLException;
/**
* Does this connection provider support aggressive release of JDBC
* connections and re-acquisition of those connections (if need be) later?
* Does this connection provider support aggressive release of JDBC connections and later
* re-acquisition of those connections if needed?
* <p/>
* This is used in conjunction with {@link org.hibernate.cfg.Environment#RELEASE_CONNECTIONS}
* This is used in conjunction with {@link org.hibernate.ConnectionReleaseMode#AFTER_STATEMENT}
* to aggressively release JDBC connections. However, the configured ConnectionProvider
* must support re-acquisition of the same underlying connection for that semantic to work.
* <p/>
* Typically, this is only true in managed environments where a container
* tracks connections by transaction or thread.
* Typically, this is only true in managed environments where a container tracks connections
* by transaction or thread.
*
* Note that JTA semantic depends on the fact that the underlying connection provider does
* support aggressive release.

2
hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/spi/DataSourceBasedMultiTenantConnectionProviderImpl.java
View File

@ -27,7 +27,7 @@ import org.hibernate.service.spi.Stoppable;
* to a single base JNDI context
* </li>
* <li>
* {@link AvailableSettings#DATASOURCE} is a string naming either the {@literal any}
* {@value AvailableSettings#DATASOURCE} is a string naming either the {@literal any}
* data source or the base JNDI context. If the latter, {@link #TENANT_IDENTIFIER_TO_USE_FOR_ANY_KEY} must
* also be set.
* </li>

10
hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/spi/MultiTenantConnectionProvider.java
View File

@ -62,15 +62,15 @@ public interface MultiTenantConnectionProvider extends Service, Wrapped {
public void releaseConnection(String tenantIdentifier, Connection connection) throws SQLException;
/**
* Does this connection provider support aggressive release of JDBC
* connections and re-acquisition of those connections (if need be) later?
* Does this connection provider support aggressive release of JDBC connections and later
* re-acquisition of those connections if needed?
* <p/>
* This is used in conjunction with {@link org.hibernate.cfg.Environment#RELEASE_CONNECTIONS}
* This is used in conjunction with {@link org.hibernate.ConnectionReleaseMode#AFTER_STATEMENT}
* to aggressively release JDBC connections. However, the configured ConnectionProvider
* must support re-acquisition of the same underlying connection for that semantic to work.
* <p/>
* Typically, this is only true in managed environments where a container
* tracks connections by transaction or thread.
* Typically, this is only true in managed environments where a container tracks connections
* by transaction or thread.
*
* Note that JTA semantic depends on the fact that the underlying connection provider does
* support aggressive release.

4
hibernate-core/src/main/java/org/hibernate/engine/jdbc/env/spi/JdbcEnvironment.java vendored
View File

@ -39,7 +39,7 @@ public interface JdbcEnvironment extends Service {
/**
* Get the current database catalog. Typically will come from either {@link java.sql.Connection#getCatalog()}
* or {@link org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG}.
* or {@value org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG}.
*
* @return The current catalog.
*/
@ -48,7 +48,7 @@ public interface JdbcEnvironment extends Service {
/**
* Get the current database catalog. Typically will come from either
* {@link SchemaNameResolver#resolveSchemaName(java.sql.Connection, Dialect)} or
* {@link org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG}.
* {@value org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG}.
*
* @return The current schema
*/

2
hibernate-core/src/main/java/org/hibernate/event/internal/EntityCopyObserverFactoryInitiator.java
View File

@ -19,7 +19,7 @@ import org.hibernate.internal.CoreMessageLogger;
import org.hibernate.service.spi.ServiceRegistryImplementor;
/**
* Looks for the configuration property {@link AvailableSettings#MERGE_ENTITY_COPY_OBSERVER} and registers
* Looks for the configuration property {@value AvailableSettings#MERGE_ENTITY_COPY_OBSERVER} and registers
* the matching {@link EntityCopyObserverFactory} based on the configuration value.
* <p>
* For known implementations some optimisations are possible, such as reusing a singleton for the stateless

2
hibernate-core/src/main/java/org/hibernate/loader/BatchFetchStyle.java
View File

@ -12,7 +12,7 @@ import org.jboss.logging.Logger;
/**
* Defines the style that should be used to perform batch loading. Which style to use is declared using
* the "{@value org.hibernate.cfg.AvailableSettings#BATCH_FETCH_STYLE}"
* ({@link org.hibernate.cfg.AvailableSettings#BATCH_FETCH_STYLE}) setting
* ({@value org.hibernate.cfg.AvailableSettings#BATCH_FETCH_STYLE}) setting
*
* @author Steve Ebersole
*

5
hibernate-core/src/main/java/org/hibernate/resource/transaction/spi/TransactionCoordinatorBuilder.java
View File

@ -13,7 +13,10 @@ import org.hibernate.service.Service;
import org.hibernate.tool.schema.internal.exec.JdbcContext;
/**
* Builder for TransactionCoordinator instances
* Builder for {@link TransactionCoordinator} instances.
* <p>
* A {@code TransactionCoordinator} may be selected using the configuration property
* {@value org.hibernate.cfg.AvailableSettings#TRANSACTION_COORDINATOR_STRATEGY}.
*
* @author Steve Ebersole
*/

6
hibernate-core/src/main/java/org/hibernate/stat/Statistics.java
View File

@ -13,7 +13,7 @@ import java.time.Instant;
* particular {@link org.hibernate.SessionFactory}.
* <p>
* Collection of statistics is enabled if the configuration property
* {@link org.hibernate.cfg.AvailableSettings#GENERATE_STATISTICS} is
* {@value org.hibernate.cfg.AvailableSettings#GENERATE_STATISTICS} is
* set to {@code true}. It may be dynamically enabled or disabled at
* runtime by calling {@link #setStatisticsEnabled(boolean)}.
*
@ -23,7 +23,7 @@ public interface Statistics {
/**
* The default value of the configuration property
* {@link org.hibernate.cfg.AvailableSettings#QUERY_STATISTICS_MAX_SIZE}.
* {@value org.hibernate.cfg.AvailableSettings#QUERY_STATISTICS_MAX_SIZE}.
*/
int DEFAULT_QUERY_STATISTICS_MAX_SIZE = 5000;
@ -323,7 +323,7 @@ public interface Statistics {
* <p>
* The maximum number of queries tracked by the Hibernate statistics
* is determined by the configuration property
* {@link org.hibernate.cfg.AvailableSettings#QUERY_STATISTICS_MAX_SIZE}.
* {@value org.hibernate.cfg.AvailableSettings#QUERY_STATISTICS_MAX_SIZE}.
*/
String[] getQueries();

6
hibernate-core/src/main/java/org/hibernate/tool/schema/Action.java
View File

@ -89,8 +89,8 @@ public enum Action {
/**
* Used when processing JPA configuration to interpret the user config values. Generally
* this will be a value specified by {@link org.hibernate.cfg.AvailableSettings#HBM2DDL_DATABASE_ACTION}
* or {@link org.hibernate.cfg.AvailableSettings#HBM2DDL_SCRIPTS_ACTION}
* this will be a value specified by {@value org.hibernate.cfg.AvailableSettings#HBM2DDL_DATABASE_ACTION}
* or {@value org.hibernate.cfg.AvailableSettings#HBM2DDL_SCRIPTS_ACTION}
*
* @param value The encountered config value
*
@ -146,7 +146,7 @@ public enum Action {
}
/**
* Used to interpret the value of {@link org.hibernate.cfg.AvailableSettings#HBM2DDL_AUTO}
* Used to interpret the value of {@value org.hibernate.cfg.AvailableSettings#HBM2DDL_AUTO}
*
* @param value The encountered config value
*

4
hibernate-core/src/main/java/org/hibernate/tool/schema/JdbcMetadaAccessStrategy.java
View File

@ -27,8 +27,8 @@ public enum JdbcMetadaAccessStrategy {
* execute a single {@link java.sql.DatabaseMetaData#getTables(String, String, String, String[])} call
* to retrieve all the database table in order to determine all the {@link jakarta.persistence.Entity} have a mapped database tables.
* <p>
* This strategy is the default one and it may require {@link AvailableSettings#DEFAULT_CATALOG} and/or
* {@link AvailableSettings#DEFAULT_SCHEMA} values to be provided.
* This strategy is the default one and it may require {@value AvailableSettings#DEFAULT_CATALOG} and/or
* {@value AvailableSettings#DEFAULT_SCHEMA} values to be provided.
*/
GROUPED( "grouped" );

4
hibernate-core/src/main/java/org/hibernate/type/StandardBasicTypes.java
View File

@ -384,7 +384,7 @@ public final class StandardBasicTypes {
/**
* The standard Hibernate type for mapping {@link OffsetDateTime} to JDBC {@link org.hibernate.type.SqlTypes#TIMESTAMP_WITH_TIMEZONE TIMESTAMP_WITH_TIMEZONE}
* or {@link org.hibernate.type.SqlTypes#TIMESTAMP TIMESTAMP} depending on the {@link org.hibernate.cfg.AvailableSettings#TIMEZONE_DEFAULT_STORAGE} setting.
* or {@link org.hibernate.type.SqlTypes#TIMESTAMP TIMESTAMP} depending on the {@value org.hibernate.cfg.AvailableSettings#TIMEZONE_DEFAULT_STORAGE} setting.
*/
public static final BasicTypeReference<OffsetDateTime> OFFSET_DATE_TIME = new BasicTypeReference<>(
"OffsetDateTime",
@ -423,7 +423,7 @@ public final class StandardBasicTypes {
/**
* The standard Hibernate type for mapping {@link ZonedDateTime} to JDBC {@link org.hibernate.type.SqlTypes#TIMESTAMP_WITH_TIMEZONE TIMESTAMP_WITH_TIMEZONE}
* or {@link org.hibernate.type.SqlTypes#TIMESTAMP TIMESTAMP} depending on the {@link org.hibernate.cfg.AvailableSettings#TIMEZONE_DEFAULT_STORAGE} setting.
* or {@link org.hibernate.type.SqlTypes#TIMESTAMP TIMESTAMP} depending on the {@value org.hibernate.cfg.AvailableSettings#TIMEZONE_DEFAULT_STORAGE} setting.
*/
public static final BasicTypeReference<ZonedDateTime> ZONED_DATE_TIME = new BasicTypeReference<>(
"ZonedDateTime",

2
hibernate-core/src/test/java/org/hibernate/orm/test/mapping/collections/ImplicitListAsBagSemanticsTests.java
View File

@ -31,7 +31,7 @@ import static org.assertj.core.api.Assertions.assertThat;
import static org.hibernate.cfg.AvailableSettings.DEFAULT_LIST_SEMANTICS;
/**
* Explicitly sets {@link AvailableSettings#DEFAULT_LIST_SEMANTICS} to BAG
* Explicitly sets {@value AvailableSettings#DEFAULT_LIST_SEMANTICS} to BAG
* and verifies the outcome.
*
* Basically verifies that the legacy behavior can be achieved via the setting

2
hibernate-core/src/test/java/org/hibernate/orm/test/mapping/collections/ImplicitListDefaultSemanticsTests.java
View File

@ -27,7 +27,7 @@ import jakarta.persistence.Table;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Uses the default {@link AvailableSettings#DEFAULT_LIST_SEMANTICS} value of LIST
* Uses the default {@value AvailableSettings#DEFAULT_LIST_SEMANTICS} value of LIST
* and verifies the outcome
*
* @author Steve Ebersole

2
hibernate-core/src/test/java/org/hibernate/orm/test/nationalized/UseNationalizedCharDataSettingTest.java
View File

@ -35,7 +35,7 @@ import org.junit.jupiter.api.Assertions;
import static org.junit.Assert.assertSame;
/**
* Test the use of {@link AvailableSettings#USE_NATIONALIZED_CHARACTER_DATA}
* Test the use of {@value AvailableSettings#USE_NATIONALIZED_CHARACTER_DATA}
* to indicate that nationalized character data should be used.
*
* @author Steve Ebersole

2
hibernate-core/src/test/java/org/hibernate/orm/test/type/AbstractJavaTimeTypeTest.java
View File

@ -381,7 +381,7 @@ public abstract class AbstractJavaTimeTypeTest<T, E> extends BaseCoreFunctionalT
private final ZoneId defaultJvmTimeZone;
/**
* The Hibernate setting, {@link AvailableSettings#JDBC_TIME_ZONE},
* The Hibernate setting, {@value AvailableSettings#JDBC_TIME_ZONE},
* may affect a lot of time-related types,
* which is why we take it into account even with timezone-independent types such as Instant.
*/