use @linkplain instead of @link where there is plain text
This commit is contained in:
Gavin King
parent
846af92b54
commit
ff79e0f12a
|
|
@ -153,9 +153,9 @@ public class LockOptions implements Serializable {
|
|||
|
||||
/**
|
||||
* Determine the {@link LockMode} to apply to the given alias. If no
|
||||
* mode was explicitly {@link #setAliasSpecificLockMode set}, the
|
||||
* {@link #getLockMode overall mode} is returned. If the overall lock mode is
|
||||
* {@code null} as well, {@link LockMode#NONE} is returned.
|
||||
* mode was explicitly {@linkplain #setAliasSpecificLockMode set}, the
|
||||
* {@linkplain #getLockMode overall mode} is returned. If the overall
|
||||
* lock mode is {@code null} as well, {@link LockMode#NONE} is returned.
|
||||
* <p/>
|
||||
* Differs from {@link #getAliasSpecificLockMode} in that here we fallback to we only return
|
||||
* the overall lock mode.
|
||||
|
|
|
|||
|
|
@ -45,17 +45,17 @@ import org.hibernate.stat.SessionStatistics;
|
|||
* flushed to the database. This process of automatic change detection is called
|
||||
* <em>dirty checking</em> and can be expensive in some circumstances. Dirty checking
|
||||
* may be disabled by marking an entity as read-only using
|
||||
* {@link #setReadOnly(Object, boolean)} or simply by {@link #detach(Object) evicting}
|
||||
* {@link #setReadOnly(Object, boolean)} or simply by {@linkplain #detach(Object) evicting}
|
||||
* it from the persistence context. A session may be set to load entities as read-only
|
||||
* {@link #setDefaultReadOnly(boolean) by default}, or this may be controlled at the
|
||||
* {@link Query#setReadOnly(boolean) query level}.
|
||||
* {@linkplain #setDefaultReadOnly(boolean) by default}, or this may be controlled at the
|
||||
* {@linkplain Query#setReadOnly(boolean) query level}.
|
||||
* <p>
|
||||
* The state of a transient or detached instance may be made persistent by copying it to
|
||||
* a persistent instance using {@link #merge(Object)}. All older operations which moved a
|
||||
* detached instance to the persistent state are now deprecated, and clients should now
|
||||
* migrate to the use of {@code merge()}.
|
||||
* <p>
|
||||
* From {@link FlushMode time to time}, the session performs a {@link #flush() flushing}
|
||||
* From {@link FlushMode time to time}, the session performs a {@linkplain #flush() flushing}
|
||||
* operation, and synchronizes state held in memory with persistent state held in the
|
||||
* database by executing SQL {@code insert}, {@code update}, and {@code delete} statements.
|
||||
* Note that SQL statements are often not executed synchronously by the methods of the
|
||||
|
|
@ -603,7 +603,7 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
* For entities with a {@link jakarta.persistence.GeneratedValue generated id},
|
||||
* {@code persist()} ultimately results in generation of an identifier for the
|
||||
* given instance. But this may happen asynchronously, when the session is
|
||||
* {@link #flush() flushed}, depending on the identifier generation strategy.
|
||||
* {@linkplain #flush() flushed}, depending on the identifier generation strategy.
|
||||
*
|
||||
* @param object a transient instance to be made persistent
|
||||
*/
|
||||
|
|
@ -617,7 +617,7 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
* For entities with a {@link jakarta.persistence.GeneratedValue generated id},
|
||||
* {@code persist()} ultimately results in generation of an identifier for the
|
||||
* given instance. But this may happen asynchronously, when the session is
|
||||
* {@link #flush() flushed}, depending on the identifier generation strategy.
|
||||
* {@linkplain #flush() flushed}, depending on the identifier generation strategy.
|
||||
*
|
||||
* @param entityName the entity name
|
||||
* @param object a transient instance to be made persistent
|
||||
|
|
@ -701,10 +701,10 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
* <ul>
|
||||
* <li>the {@link LockMode} to use,
|
||||
* <li>the pessimistic lock timeout, and
|
||||
* <li>the {@link LockRequest#setScope(boolean) scope} of the lock.
|
||||
* <li>the {@linkplain LockRequest#setScope(boolean) scope} of the lock.
|
||||
* </ul>
|
||||
* Timeout and scope are ignored if the specified {@code LockMode} represents a
|
||||
* form of {@link LockMode#OPTIMISTIC optimistic} locking.
|
||||
* form of {@linkplain LockMode#OPTIMISTIC optimistic} locking.
|
||||
* <p>
|
||||
* Call {@link LockRequest#lock(Object)} to actually obtain the requested lock
|
||||
* on a managed entity instance.
|
||||
|
|
@ -723,8 +723,8 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
* from the underlying database. This may be useful:
|
||||
* <ul>
|
||||
* <li>when a database trigger alters the object state upon insert or update
|
||||
* <li>after {@link #createStatement(String) executing} any HQL update or delete statement
|
||||
* <li>after {@link #createNativeStatement(String) executing} a native SQL statement
|
||||
* <li>after {@linkplain #createStatement(String) executing} any HQL update or delete statement
|
||||
* <li>after {@linkplain #createNativeStatement(String) executing} a native SQL statement
|
||||
* <li>after inserting a {@link java.sql.Blob} or {@link java.sql.Clob}
|
||||
* </ul>
|
||||
* This operation cascades to associated instances if the association is mapped
|
||||
|
|
@ -739,8 +739,8 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
* from the underlying database. This may be useful:
|
||||
* <ul>
|
||||
* <li>when a database trigger alters the object state upon insert or update
|
||||
* <li>after {@link #createStatement(String) executing} any HQL update or delete statement
|
||||
* <li>after {@link #createNativeStatement(String) executing} a native SQL statement
|
||||
* <li>after {@linkplain #createStatement(String) executing} any HQL update or delete statement
|
||||
* <li>after {@linkplain #createNativeStatement(String) executing} a native SQL statement
|
||||
* <li>after inserting a {@link java.sql.Blob} or {@link java.sql.Clob}
|
||||
* </ul>
|
||||
* This operation cascades to associated instances if the association is mapped
|
||||
|
|
@ -1070,7 +1070,7 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
<T> NaturalIdMultiLoadAccess<T> byMultipleNaturalId(String entityName);
|
||||
|
||||
/**
|
||||
* Enable the named {@link Filter filter} for this current session.
|
||||
* Enable the named {@linkplain Filter filter} for this current session.
|
||||
*
|
||||
* @param filterName the name of the filter to be enabled.
|
||||
*
|
||||
|
|
@ -1079,7 +1079,7 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
Filter enableFilter(String filterName);
|
||||
|
||||
/**
|
||||
* Retrieve a currently enabled {@link Filter filter} by name.
|
||||
* Retrieve a currently enabled {@linkplain Filter filter} by name.
|
||||
*
|
||||
* @param filterName the name of the filter to be retrieved.
|
||||
*
|
||||
|
|
@ -1088,14 +1088,14 @@ public interface Session extends SharedSessionContract, EntityManager {
|
|||
Filter getEnabledFilter(String filterName);
|
||||
|
||||
/**
|
||||
* Disable the named {@link Filter filter} for the current session.
|
||||
* Disable the named {@linkplain Filter filter} for the current session.
|
||||
*
|
||||
* @param filterName the name of the filter to be disabled.
|
||||
*/
|
||||
void disableFilter(String filterName);
|
||||
|
||||
/**
|
||||
* Get the {@link SessionStatistics statistics} for this session.
|
||||
* Get the {@linkplain SessionStatistics statistics} for this session.
|
||||
*
|
||||
* @return the session statistics being collected for this session
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -216,10 +216,10 @@ public interface SessionFactory extends EntityManagerFactory, HibernateEntityMan
|
|||
* connection pools, etc).
|
||||
* <p/>
|
||||
* It is the responsibility of the application to ensure that there are no
|
||||
* open {@link Session sessions} before calling this method as the impact
|
||||
* on those {@link Session sessions} is indeterminate.
|
||||
* open {@linkplain Session sessions} before calling this method as the impact
|
||||
* on those {@linkplain Session sessions} is indeterminate.
|
||||
* <p/>
|
||||
* No-ops if already {@link #isClosed closed}.
|
||||
* No-ops if already {@linkplain #isClosed() closed}.
|
||||
*
|
||||
* @throws HibernateException Indicates an issue closing the factory.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ import org.hibernate.resource.transaction.spi.TransactionStatus;
|
|||
*/
|
||||
public interface Transaction extends EntityTransaction {
|
||||
/**
|
||||
* Get the current {@link TransactionStatus status} of this transaction.
|
||||
* Get the current {@linkplain TransactionStatus status} of this transaction.
|
||||
*/
|
||||
TransactionStatus getStatus();
|
||||
|
||||
|
|
|
|||
|
|
@ -389,7 +389,7 @@ public class MetadataSources implements Serializable {
|
|||
}
|
||||
|
||||
/**
|
||||
* Add XML mapping bindings created from an arbitrary source by the {@link #getXmlMappingBinderAccess() binder}.
|
||||
* Add XML mapping bindings created from an arbitrary source by the {@linkplain #getXmlMappingBinderAccess() binder}.
|
||||
*
|
||||
* @param binding The binding.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ public interface EntitySource extends IdentifiableTypeSource, ToolingHintContext
|
|||
boolean isLazy();
|
||||
|
||||
/**
|
||||
* For {@link #isLazy() lazy} entities, obtain the interface to use in constructing its proxies.
|
||||
* For {@linkplain #isLazy() lazy} entities, obtain the interface to use in constructing its proxies.
|
||||
*
|
||||
* @return The proxy interface name
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ import java.util.List;
|
|||
|
||||
/**
|
||||
* Additional contract describing the source of an identifier mapping whose
|
||||
* {@link #getNature() nature} is
|
||||
* {@linkplain #getNature() nature} is
|
||||
* {@link org.hibernate.id.EntityIdentifierNature#AGGREGATED_COMPOSITE}.
|
||||
* <p/>
|
||||
* This equates to an identifier which is made up of multiple values which are
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ package org.hibernate.boot.model.source.spi;
|
|||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Additional contract describing the source of an identifier mapping whose {@link #getNature() nature} is
|
||||
* Additional contract describing the source of an identifier mapping whose {@linkplain #getNature() nature} is
|
||||
* {@link org.hibernate.id.EntityIdentifierNature#NON_AGGREGATED_COMPOSITE}.
|
||||
* <p/>
|
||||
* Think {@link jakarta.persistence.IdClass}
|
||||
|
|
|
|||
|
|
@ -7,8 +7,8 @@
|
|||
package org.hibernate.boot.model.source.spi;
|
||||
|
||||
/**
|
||||
* Additional contract describing the source of an identifier mapping whose {@link #getNature() nature} is
|
||||
* {@link org.hibernate.id.EntityIdentifierNature#SIMPLE simple}.
|
||||
* Additional contract describing the source of an identifier mapping whose {@linkplain #getNature() nature} is
|
||||
* {@linkplain org.hibernate.id.EntityIdentifierNature#SIMPLE simple}.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
package org.hibernate.boot.model.source.spi;
|
||||
|
||||
/**
|
||||
* Models a JDBC {@link java.sql.Types DATATYPE}. Mainly breaks down into 3 pieces of information:<ul>
|
||||
* Models a JDBC {@linkplain java.sql.Types data type}. Mainly breaks down into 3 pieces of information:<ul>
|
||||
* <li>
|
||||
* {@link #getTypeCode() type code} - The JDBC type code; generally matches a code from {@link java.sql.Types}
|
||||
* though not necessarily.
|
||||
|
|
|
|||
|
|
@ -16,15 +16,15 @@ public interface JpaCallbackSource {
|
|||
/**
|
||||
* @param callbackType {@link jakarta.persistence.PrePersist}, {@link jakarta.persistence.PreRemove}, {@link jakarta.persistence.PreUpdate}, {@link jakarta.persistence.PostLoad},
|
||||
* {@link jakarta.persistence.PostPersist}, {@link jakarta.persistence.PostRemove}, or {@link jakarta.persistence.PostUpdate}
|
||||
* @return the name of the JPA callback method defined for the associated {@link jakarta.persistence.Entity entity} or {@link jakarta.persistence.MappedSuperclass
|
||||
* @return the name of the JPA callback method defined for the associated {@linkplain jakarta.persistence.Entity entity} or {@linkplain jakarta.persistence.MappedSuperclass
|
||||
* mapped superclass} and for the supplied callback annotation class.
|
||||
*/
|
||||
String getCallbackMethod(Class<? extends Annotation> callbackType);
|
||||
|
||||
/**
|
||||
* @return the name of the instantiated container where the JPA callbacks for the associated {@link jakarta.persistence.Entity entity} or
|
||||
* {@link jakarta.persistence.MappedSuperclass mapped superclass} are defined. This can be either the entity/mapped superclass itself or an
|
||||
* {@link jakarta.persistence.EntityListeners entity listener}.
|
||||
* @return the name of the instantiated container where the JPA callbacks for the associated {@linkplain jakarta.persistence.Entity entity} or
|
||||
* {@linkplain jakarta.persistence.MappedSuperclass mapped superclass} are defined. This can be either the entity/mapped superclass itself or an
|
||||
* {@linkplain jakarta.persistence.EntityListeners entity listener}.
|
||||
*/
|
||||
String getName();
|
||||
|
||||
|
|
|
|||
|
|
@ -9,8 +9,8 @@
|
|||
<body>
|
||||
<p>
|
||||
Defines contracts for transactional and concurrent access to cached
|
||||
{@link org.hibernate.cache.spi.access.EntityDataAccess entity} and
|
||||
{@link org.hibernate.cache.spi.access.CollectionDataAccess collection} data. Transactions pass in a
|
||||
{@linkplain org.hibernate.cache.spi.access.EntityDataAccess entity} and
|
||||
{@linkplain org.hibernate.cache.spi.access.CollectionDataAccess collection} data. Transactions pass in a
|
||||
timestamp indicating transaction start time which is then used to protect against concurrent access (exactly how
|
||||
that occurs is based on the actual access-strategy impl used). Two different implementation patterns are provided
|
||||
for:
|
||||
|
|
@ -29,7 +29,7 @@
|
|||
The <i>asynchronous</i> access strategies are: {@link org.hibernate.cache.spi.access.AccessType#READ_ONLY read-only},
|
||||
{@link org.hibernate.cache.spi.access.AccessType#READ_WRITE read-write} and
|
||||
{@link org.hibernate.cache.spi.access.AccessType#NONSTRICT_READ_WRITE nonstrict-read-write}. The only
|
||||
<i>synchronous</i> access strategy is {@link org.hibernate.cache.spi.access.AccessType#TRANSACTIONAL transactional}.
|
||||
<i>synchronous</i> access strategy is {@linkplain org.hibernate.cache.spi.access.AccessType#TRANSACTIONAL transactional}.
|
||||
</p>
|
||||
<p>
|
||||
Note that, for an <i>asynchronous</i> cache, cache invalidation must be a two step process (lock->unlock or
|
||||
|
|
|
|||
|
|
@ -614,7 +614,7 @@ public class Configuration {
|
|||
/**
|
||||
* Set the current {@link Interceptor}
|
||||
*
|
||||
* @param interceptor The {@link Interceptor} to use for the {@link #buildSessionFactory built}
|
||||
* @param interceptor The {@link Interceptor} to use for the {@linkplain #buildSessionFactory built}
|
||||
* {@link SessionFactory}.
|
||||
*
|
||||
* @return this for method chaining
|
||||
|
|
|
|||
|
|
@ -4058,7 +4058,7 @@ public abstract class Dialect implements ConversionContext {
|
|||
/**
|
||||
* Return the name used to identify the given field
|
||||
* as an argument to the {@code extract()} function,
|
||||
* or of this dialect's {@link #extractPattern equivalent}
|
||||
* or of this dialect's {@linkplain #extractPattern equivalent}
|
||||
* function.
|
||||
* <p>
|
||||
* This method does not need to handle
|
||||
|
|
@ -4098,8 +4098,8 @@ public abstract class Dialect implements ConversionContext {
|
|||
* Return the name used to identify the given unit of
|
||||
* duration as an argument to {@code #timestampadd()}
|
||||
* or {@code #timestampdiff()}, or of this dialect's
|
||||
* {@link #timestampaddPattern equivalent}
|
||||
* {@link #timestampdiffPattern functions}.
|
||||
* {@linkplain #timestampaddPattern equivalent}
|
||||
* {@linkplain #timestampdiffPattern functions}.
|
||||
* <p>
|
||||
* This method does not need to handle
|
||||
* {@link TemporalUnit#NANOSECOND},
|
||||
|
|
|
|||
|
|
@ -13,17 +13,18 @@ import java.util.Map;
|
|||
import java.util.TreeMap;
|
||||
|
||||
/**
|
||||
* This class maps {@link java.sql.Types JDBC type codes} to SQL type names for
|
||||
* a {@link Dialect dialect} of SQL. An association between a type code and a
|
||||
* SQL type name may be {@link #put(int, long, String) registered} with a capacity,
|
||||
* that is, with the maximum size that the given SQL type can accommodate.
|
||||
*
|
||||
* When a type association is {@link #get(int, Long, Integer, Integer)} retrieved}
|
||||
* This class maintains a mapping of {@linkplain java.sql.Types JDBC type codes} to
|
||||
* SQL type names for a {@linkplain Dialect dialect} of SQL. An association between a
|
||||
* type code and a SQL type name may be {@linkplain #put(int, long, String) registered}
|
||||
* with a <em>capacity</em>, that is, with the maximum size that the given SQL type can
|
||||
* accommodate.
|
||||
* <p>
|
||||
* When a type association is {@linkplain #get(int, Long, Integer, Integer) retrieved}
|
||||
* for a given type code and actual size n, {@code get()} will return the associated
|
||||
* type name with smallest capacity greater than or equal to n, if available, or an
|
||||
* type name with the smallest capacity greater than or equal to n, if available, or an
|
||||
* unmarked default type otherwise.
|
||||
*
|
||||
* For example, setting
|
||||
* <p>
|
||||
* For example, setting:
|
||||
*
|
||||
* <pre>
|
||||
* names.put( type, "TEXT" );
|
||||
|
|
@ -40,13 +41,13 @@ import java.util.TreeMap;
|
|||
* names.get( type, 100000 ) // --> "TEXT" (default)
|
||||
* </pre>
|
||||
*
|
||||
* On the other hand, simply putting
|
||||
* On the other hand, simply putting:
|
||||
*
|
||||
* <pre>
|
||||
* names.put( type, "VARCHAR($l)" );
|
||||
* </pre>
|
||||
*
|
||||
* would result in
|
||||
* would result in:
|
||||
*
|
||||
* <pre>
|
||||
* names.get( type ) // --> "VARCHAR($l)" (will cause trouble)
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ import org.hibernate.type.Type;
|
|||
|
||||
/**
|
||||
* Delegate responsible for, in conjunction with the various
|
||||
* {@link CascadingAction actions}, implementing cascade processing.
|
||||
* {@linkplain CascadingAction actions}, implementing cascade processing.
|
||||
*
|
||||
* @author Gavin King
|
||||
* @see CascadingAction
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ import org.hibernate.engine.jdbc.internal.CharacterStreamImpl;
|
|||
import org.hibernate.type.descriptor.java.DataHelper;
|
||||
|
||||
/**
|
||||
* Manages aspects of proxying {@link Clob Clobs} for non-contextual creation, including proxy creation and
|
||||
* Manages aspects of proxying {@link Clob}s for non-contextual creation, including proxy creation and
|
||||
* handling proxy invocations. We use proxies here solely to avoid JDBC version incompatibilities.
|
||||
*
|
||||
* @author Gavin King
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ import java.sql.Blob;
|
|||
import org.hibernate.HibernateException;
|
||||
|
||||
/**
|
||||
* Manages aspects of proxying {@link Blob Blobs} to add serializability.
|
||||
* Manages aspects of proxying {@link Blob}s to add serializability.
|
||||
*
|
||||
* @author Gavin King
|
||||
* @author Steve Ebersole
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ import java.sql.Clob;
|
|||
import org.hibernate.HibernateException;
|
||||
|
||||
/**
|
||||
* Manages aspects of proxying {@link Clob Clobs} to add serializability.
|
||||
* Manages aspects of proxying {@link Clob}s to add serializability.
|
||||
*
|
||||
* @author Gavin King
|
||||
* @author Steve Ebersole
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ public abstract class AbstractBatchImpl implements Batch {
|
|||
/**
|
||||
* Perform batch execution..
|
||||
* <p/>
|
||||
* This is called from the explicit {@link #execute() execution}, but may also be called from elsewhere
|
||||
* This is called from the explicit {@linkplain #execute() execution}, but may also be called from elsewhere
|
||||
* depending on the exact implementation.
|
||||
*/
|
||||
protected abstract void doExecuteBatch();
|
||||
|
|
|
|||
|
|
@ -144,7 +144,7 @@ public class SqlExceptionHelper {
|
|||
// SQLWarning ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
/**
|
||||
* Contract for handling {@link SQLWarning warnings}
|
||||
* Contract for handling {@linkplain SQLWarning warnings}
|
||||
*/
|
||||
public interface WarningHandler {
|
||||
/**
|
||||
|
|
@ -155,7 +155,7 @@ public class SqlExceptionHelper {
|
|||
boolean doProcess();
|
||||
|
||||
/**
|
||||
* Prepare for processing of a {@link SQLWarning warning} stack.
|
||||
* Prepare for processing of a {@linkplain SQLWarning warning} stack.
|
||||
* <p/>
|
||||
* Note that the warning here is also the first passed to {@link #handleWarning}
|
||||
*
|
||||
|
|
@ -172,7 +172,7 @@ public class SqlExceptionHelper {
|
|||
}
|
||||
|
||||
/**
|
||||
* Basic support for {@link WarningHandler} implementations which handle {@link SQLWarning warnings}
|
||||
* Basic support for {@link WarningHandler} implementations which handle {@linkplain SQLWarning warnings}
|
||||
*/
|
||||
public abstract static class WarningHandlerLoggingSupport implements WarningHandler {
|
||||
@Override
|
||||
|
|
@ -184,7 +184,7 @@ public class SqlExceptionHelper {
|
|||
}
|
||||
|
||||
/**
|
||||
* Delegate to log common details of a {@link SQLWarning warning}
|
||||
* Delegate to log common details of a {@linkplain SQLWarning warning}
|
||||
*
|
||||
* @param description A description of the warning
|
||||
* @param message The warning message
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ import org.hibernate.internal.CoreMessageLogger;
|
|||
import org.jboss.logging.Logger;
|
||||
|
||||
/**
|
||||
* Manages a registry of {@link Synchronization Synchronizations}.
|
||||
* Manages a registry of {@link Synchronization}s.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ import java.io.Serializable;
|
|||
import jakarta.transaction.Synchronization;
|
||||
|
||||
/**
|
||||
* Manages a registry of {@link Synchronization Synchronizations}.
|
||||
* Manages a registry of {@link Synchronization}s.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
@ -25,14 +25,14 @@ public interface SynchronizationRegistry extends Serializable {
|
|||
public void registerSynchronization(Synchronization synchronization);
|
||||
|
||||
/**
|
||||
* Delegate {@link Synchronization#beforeCompletion} calls to the {@link #registerSynchronization registered}
|
||||
* {@link Synchronization Synchronizations}
|
||||
* Delegate {@link Synchronization#beforeCompletion} calls to the {@linkplain #registerSynchronization registered}
|
||||
* {@link Synchronization}s
|
||||
*/
|
||||
void notifySynchronizationsBeforeTransactionCompletion();
|
||||
|
||||
/**
|
||||
* Delegate {@link Synchronization#afterCompletion} calls to {@link #registerSynchronization registered}
|
||||
* {@link Synchronization Synchronizations}
|
||||
* Delegate {@link Synchronization#afterCompletion} calls to {@linkplain #registerSynchronization registered}
|
||||
* {@link Synchronization}s
|
||||
*
|
||||
* @param status The transaction status (if known) per {@link jakarta.transaction.Status}
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ public class CompositeNestedGeneratedValueGenerator
|
|||
|
||||
/**
|
||||
* Contract for performing the actual sub-value generation, usually injecting it into the
|
||||
* determined {@link GenerationContextLocator#locateGenerationContext context}
|
||||
* determined {@linkplain GenerationContextLocator#locateGenerationContext context}
|
||||
*/
|
||||
public interface GenerationPlan extends ExportableProducer {
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ package org.hibernate.id;
|
|||
import org.hibernate.boot.model.relational.ExportableProducer;
|
||||
|
||||
/**
|
||||
* Identifies {@link IdentifierGenerator generators} which potentially aggregate other
|
||||
* Identifies {@linkplain IdentifierGenerator generators} which potentially aggregate other
|
||||
* {@link PersistentIdentifierGenerator} generators.
|
||||
* <p/>
|
||||
* Initially this is limited to {@link CompositeNestedGeneratedValueGenerator}
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ public final class IdentifierGeneratorHelper {
|
|||
/**
|
||||
* Marker object returned from {@link IdentifierGenerator#generate} to indicate that we should short-circuit any
|
||||
* continued generated id checking. Currently this is only used in the case of the
|
||||
* {@link ForeignGenerator foreign} generator as a way to signal that we should use the associated
|
||||
* {@linkplain ForeignGenerator foreign} generator as a way to signal that we should use the associated
|
||||
* entity's id value.
|
||||
*/
|
||||
public static final Serializable SHORT_CIRCUIT_INDICATOR = new Serializable() {
|
||||
|
|
@ -189,7 +189,7 @@ public final class IdentifierGeneratorHelper {
|
|||
* @return The wrapped type.
|
||||
*
|
||||
* @throws IdentifierGenerationException Indicates an unhandled 'clazz'.
|
||||
* @deprecated Use the {@link #getIntegralDataTypeHolder holders} instead.
|
||||
* @deprecated Use the {@linkplain #getIntegralDataTypeHolder holders} instead.
|
||||
*/
|
||||
@Deprecated
|
||||
public static Number createNumber(long value, Class clazz) throws IdentifierGenerationException {
|
||||
|
|
|
|||
|
|
@ -269,7 +269,7 @@ public class SequenceStyleGenerator
|
|||
* Determine the name of the sequence (or table if this resolves to a physical table)
|
||||
* to use.
|
||||
* <p/>
|
||||
* Called during {@link #configure configuration}.
|
||||
* Called during {@linkplain #configure configuration}.
|
||||
*
|
||||
* @param params The params supplied in the generator config (plus some standard useful extras).
|
||||
* @param dialect The dialect in effect
|
||||
|
|
@ -352,7 +352,7 @@ public class SequenceStyleGenerator
|
|||
* Determine the name of the column used to store the generator value in
|
||||
* the db.
|
||||
* <p/>
|
||||
* Called during {@link #configure configuration} <b>when resolving to a
|
||||
* Called during {@linkplain #configure configuration} <b>when resolving to a
|
||||
* physical table</b>.
|
||||
*
|
||||
* @param params The params supplied in the generator config (plus some standard useful extras).
|
||||
|
|
@ -370,7 +370,7 @@ public class SequenceStyleGenerator
|
|||
* initializing the {@link #getDatabaseStructure() database structure}
|
||||
* (i.e. sequence/table).
|
||||
* <p/>
|
||||
* Called during {@link #configure configuration}.
|
||||
* Called during {@linkplain #configure configuration}.
|
||||
*
|
||||
* @param params The params supplied in the generator config (plus some standard useful extras).
|
||||
* @return The initial value
|
||||
|
|
@ -382,9 +382,9 @@ public class SequenceStyleGenerator
|
|||
|
||||
/**
|
||||
* Determine the increment size to be applied. The exact implications of
|
||||
* this value depends on the {@link #getOptimizer() optimizer} being used.
|
||||
* this value depends on the {@linkplain #getOptimizer() optimizer} being used.
|
||||
* <p/>
|
||||
* Called during {@link #configure configuration}.
|
||||
* Called during {@linkplain #configure configuration}.
|
||||
*
|
||||
* @param params The params supplied in the generator config (plus some standard useful extras).
|
||||
* @return The increment size
|
||||
|
|
@ -397,7 +397,7 @@ public class SequenceStyleGenerator
|
|||
/**
|
||||
* Determine the optimizer to use.
|
||||
* <p/>
|
||||
* Called during {@link #configure configuration}.
|
||||
* Called during {@linkplain #configure configuration}.
|
||||
*
|
||||
* @param params The params supplied in the generator config (plus some standard useful extras).
|
||||
* @param incrementSize The {@link #determineIncrementSize determined increment size}
|
||||
|
|
|
|||
|
|
@ -290,7 +290,7 @@ public class TableGenerator implements PersistentIdentifierGenerator {
|
|||
|
||||
/**
|
||||
* The amount of increment to use. The exact implications of this
|
||||
* depends on the {@link #getOptimizer() optimizer} being used.
|
||||
* depends on the {@linkplain #getOptimizer() optimizer} being used.
|
||||
*
|
||||
* @return The increment amount.
|
||||
*/
|
||||
|
|
@ -366,7 +366,7 @@ public class TableGenerator implements PersistentIdentifierGenerator {
|
|||
/**
|
||||
* Determine the table name to use for the generator values.
|
||||
* <p/>
|
||||
* Called during {@link #configure configuration}.
|
||||
* Called during {@linkplain #configure configuration}.
|
||||
*
|
||||
* @see #getTableName()
|
||||
* @param params The params supplied in the generator config (plus some standard useful extras).
|
||||
|
|
@ -408,7 +408,7 @@ public class TableGenerator implements PersistentIdentifierGenerator {
|
|||
* Determine the name of the column used to indicate the segment for each
|
||||
* row. This column acts as the primary key.
|
||||
* <p/>
|
||||
* Called during {@link #configure configuration}.
|
||||
* Called during {@linkplain #configure configuration}.
|
||||
*
|
||||
* @see #getSegmentColumnName()
|
||||
* @param params The params supplied in the generator config (plus some standard useful extras).
|
||||
|
|
@ -424,7 +424,7 @@ public class TableGenerator implements PersistentIdentifierGenerator {
|
|||
/**
|
||||
* Determine the name of the column in which we will store the generator persistent value.
|
||||
* <p/>
|
||||
* Called during {@link #configure configuration}.
|
||||
* Called during {@linkplain #configure configuration}.
|
||||
*
|
||||
* @see #getValueColumnName()
|
||||
* @param params The params supplied in the generator config (plus some standard useful extras).
|
||||
|
|
@ -440,7 +440,7 @@ public class TableGenerator implements PersistentIdentifierGenerator {
|
|||
/**
|
||||
* Determine the segment value corresponding to this generator instance.
|
||||
* <p/>
|
||||
* Called during {@link #configure configuration}.
|
||||
* Called during {@linkplain #configure configuration}.
|
||||
*
|
||||
* @see #getSegmentValue()
|
||||
* @param params The params supplied in the generator config (plus some standard useful extras).
|
||||
|
|
@ -473,7 +473,7 @@ public class TableGenerator implements PersistentIdentifierGenerator {
|
|||
/**
|
||||
* Determine the size of the {@link #getSegmentColumnName segment column}
|
||||
* <p/>
|
||||
* Called during {@link #configure configuration}.
|
||||
* Called during {@linkplain #configure configuration}.
|
||||
*
|
||||
* @see #getSegmentValueLength()
|
||||
* @param params The params supplied in the generator config (plus some standard useful extras).
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ public abstract class AbstractSelectingDelegate implements InsertGeneratedIdenti
|
|||
* Bind any required parameter values into the SQL command {@link #getSelectSQL}.
|
||||
*
|
||||
* @param session The session
|
||||
* @param ps The prepared {@link #getSelectSQL SQL} command
|
||||
* @param ps The prepared {@linkplain #getSelectSQL SQL} command
|
||||
* @param entity The entity being saved.
|
||||
*
|
||||
* @throws SQLException
|
||||
|
|
|
|||
|
|
@ -9,8 +9,9 @@ package org.hibernate.integrator.spi;
|
|||
import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
|
||||
|
||||
/**
|
||||
* Additional, optional contract for Integrators that wish to contribute {@link org.hibernate.service.Service services}
|
||||
* to the Hibernate {@link org.hibernate.service.ServiceRegistry}.
|
||||
* Additional, optional contract for Integrators that wish to contribute
|
||||
* {@linkplain org.hibernate.service.Service services} to the Hibernate
|
||||
* {@link org.hibernate.service.ServiceRegistry}.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*
|
||||
|
|
|
|||
|
|
@ -322,8 +322,8 @@ public final class ReflectHelper {
|
|||
}
|
||||
|
||||
/**
|
||||
* Retrieve a constructor for the given class, with arguments matching the specified Hibernate mapping
|
||||
* {@link Type types}.
|
||||
* Retrieve a constructor for the given class, with arguments matching
|
||||
* the specified Hibernate mapping {@linkplain Type types}.
|
||||
*
|
||||
* @param clazz The class needing instantiation
|
||||
* @param types The types representing the required ctor param signature
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ package org.hibernate.internal.util;
|
|||
|
||||
/**
|
||||
* Represents a "final" value that is initialized either {@link #ValueHolder(Object) up front} or once at some point
|
||||
* {@link #ValueHolder(DeferredInitializer) after} declaration.
|
||||
* {@linkplain #ValueHolder(DeferredInitializer) after} declaration.
|
||||
*
|
||||
* Note: If a Serializable class has a {@link ValueHolder} property, that property should be declared transient!
|
||||
*
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ import org.hibernate.HibernateException;
|
|||
|
||||
/**
|
||||
* Exception used to indicate that a query is attempting to simultaneously fetch multiple
|
||||
* {@link org.hibernate.type.BagType bags}
|
||||
* {@linkplain org.hibernate.type.BagType bags}
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ public interface ProxyFactory {
|
|||
* @param setIdentifierMethod Reference to the identifier setter method;
|
||||
* invocation on this method should not force initialization
|
||||
* @param componentIdType For composite identifier types, a reference to
|
||||
* the {@link CompositeType type} of the identifier
|
||||
* the {@linkplain CompositeType type} of the identifier
|
||||
* property; again accessing the id should generally not cause
|
||||
* initialization - but need to bear in mind <key-many-to-one/>
|
||||
* mappings.
|
||||
|
|
|
|||
|
|
@ -295,7 +295,7 @@ public interface Query<R> extends TypedQuery<R>, CommonQueryContract {
|
|||
* Set the LockMode to use for specific alias (as defined in the query's {@code FROM} clause).
|
||||
* <p>
|
||||
* The alias-specific lock modes specified here are added to the query's internal
|
||||
* {@link #getLockOptions() LockOptions}.
|
||||
* {@link #getLockOptions() LockOption}s.
|
||||
* <p>
|
||||
* The effect of these alias-specific LockModes is somewhat dependent on the driver/database in use. Generally
|
||||
* speaking, for maximum portability, this method should only be used to mark that the rows corresponding to
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ import org.hibernate.query.sqm.tree.SqmNode;
|
|||
import org.hibernate.query.sqm.tree.SqmQuery;
|
||||
|
||||
/**
|
||||
* Common contract between a {@link SqmSelectStatement root} and a
|
||||
* Common contract between a {@linkplain SqmSelectStatement root} and a
|
||||
* {@link SqmSubQuery sub-query}
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
package org.hibernate.service;
|
||||
|
||||
/**
|
||||
* A registry of {@link Service services}.
|
||||
* A registry of {@linkplain Service services}.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ package org.hibernate.tool.schema.spi;
|
|||
*/
|
||||
public interface ScriptTargetOutput {
|
||||
/**
|
||||
* Prepare the script target to {@link #accept(String) accept} commands
|
||||
* Prepare the script target to {@linkplain #accept(String) accept} commands
|
||||
*/
|
||||
void prepare();
|
||||
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ public interface EntityTuplizer extends Tuplizer {
|
|||
Object[] getPropertyValuesToInsert(Object entity, Map mergeMap, SharedSessionContractImplementor session);
|
||||
|
||||
/**
|
||||
* Get any {@link EntityNameResolver EntityNameResolvers} associated with this {@link Tuplizer}.
|
||||
* Get any {@link EntityNameResolver}s associated with this {@link Tuplizer}.
|
||||
*
|
||||
* @return The associated resolvers. May be null or empty.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ import org.hibernate.type.descriptor.jdbc.JdbcType;
|
|||
/**
|
||||
* Descriptor for {@link Blob} handling.
|
||||
* <p/>
|
||||
* Note, {@link Blob blobs} really are mutable (their internal state can in fact be mutated). We simply
|
||||
* Note, {@link Blob}s really are mutable (their internal state can in fact be mutated). We simply
|
||||
* treat them as immutable because we cannot properly check them for changes nor deep copy them.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ import org.hibernate.type.descriptor.jdbc.spi.JdbcTypeRegistry;
|
|||
/**
|
||||
* Descriptor for {@link Clob} handling.
|
||||
* <p/>
|
||||
* Note, {@link Clob clobs} really are mutable (their internal state can in fact be mutated). We simply
|
||||
* Note, {@link Clob}s really are mutable (their internal state can in fact be mutated). We simply
|
||||
* treat them as immutable because we cannot properly check them for changes nor deep copy them.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ import org.hibernate.type.descriptor.WrapperOptions;
|
|||
/**
|
||||
* Descriptor for {@link NClob} handling.
|
||||
* <p/>
|
||||
* Note, {@link NClob nclobs} really are mutable (their internal state can in fact be mutated). We simply
|
||||
* Note, {@link NClob}s really are mutable (their internal state can in fact be mutated). We simply
|
||||
* treat them as immutable because we cannot properly check them for changes nor deep copy them.
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ import jakarta.persistence.IdClass;
|
|||
import org.hibernate.annotations.GenericGenerator;
|
||||
|
||||
/**
|
||||
* The {@link Simple} entity redone with a generated value {@link #id1} }as part of its
|
||||
* The {@link Simple} entity redone with a generated value {@link #id1} as part of its
|
||||
* composite pk
|
||||
*
|
||||
* @author <a href="mailto:stale.pedersen@jboss.org">Stale W. Pedersen</a>
|
||||
|
|
|
|||
Loading…
Reference in New Issue