diff --git a/hibernate-c3p0/src/main/java/org/hibernate/c3p0/internal/C3P0ConnectionProvider.java b/hibernate-c3p0/src/main/java/org/hibernate/c3p0/internal/C3P0ConnectionProvider.java index d93b987227..c354d3c9e5 100644 --- a/hibernate-c3p0/src/main/java/org/hibernate/c3p0/internal/C3P0ConnectionProvider.java +++ b/hibernate-c3p0/src/main/java/org/hibernate/c3p0/internal/C3P0ConnectionProvider.java @@ -32,7 +32,7 @@ import org.jboss.logging.Logger; /** * A connection provider that uses a C3P0 connection pool. Hibernate will use this by - * default if the hibernate.c3p0.* properties are set. + * default if the {@code hibernate.c3p0.*} properties are set. * * @author various people * @see ConnectionProvider diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/TeradataDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/TeradataDialect.java index b6863b6626..eab0310841 100644 --- a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/TeradataDialect.java +++ b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/TeradataDialect.java @@ -288,9 +288,9 @@ public class TeradataDialect extends Dialect { } /** - * Does this dialect support the FOR UPDATE syntax? + * Does this dialect support the {@code FOR UPDATE} syntax? * - * @return empty string ... Teradata does not support FOR UPDATE syntax + * @return empty string ... Teradata does not support {@code FOR UPDATE} syntax */ @Override public String getForUpdateString() { diff --git a/hibernate-core/src/main/java/org/hibernate/CacheMode.java b/hibernate-core/src/main/java/org/hibernate/CacheMode.java index 9a56e53f22..78d2947607 100644 --- a/hibernate-core/src/main/java/org/hibernate/CacheMode.java +++ b/hibernate-core/src/main/java/org/hibernate/CacheMode.java @@ -40,7 +40,7 @@ public enum CacheMode { /** * The session will never read items from the cache, but will add items * to the cache as it reads them from the database. In this mode, the - * effect of hibernate.cache.use_minimal_puts is bypassed, in + * effect of {@code hibernate.cache.use_minimal_puts} is bypassed, in * order to force a cache refresh. */ REFRESH( CacheStoreMode.REFRESH, CacheRetrieveMode.BYPASS ); diff --git a/hibernate-core/src/main/java/org/hibernate/FetchMode.java b/hibernate-core/src/main/java/org/hibernate/FetchMode.java index f99a5bd54d..67bc5a1b30 100644 --- a/hibernate-core/src/main/java/org/hibernate/FetchMode.java +++ b/hibernate-core/src/main/java/org/hibernate/FetchMode.java @@ -8,10 +8,10 @@ package org.hibernate; /** * Represents an association fetching strategy. This is used - * together with the Criteria API to specify runtime + * together with the {@code Criteria} API to specify runtime * fetching strategies. *

- * For HQL queries, use the FETCH keyword instead. + * For HQL queries, use the {@code FETCH} keyword instead. * * @see Criteria#setFetchMode(String, FetchMode) * @@ -24,26 +24,26 @@ public enum FetchMode { DEFAULT, /** - * Fetch using an outer join. Equivalent to fetch="join". + * Fetch using an outer join. Equivalent to {@code fetch="join"}. */ JOIN, /** * Fetch eagerly, using a separate select. Equivalent to - * fetch="select". + * {@code fetch="select"}. */ SELECT; /** - * Fetch lazily. Equivalent to outer-join="false". + * Fetch lazily. Equivalent to {@code outer-join="false"}. * - * @deprecated use FetchMode.SELECT + * @deprecated use {@code FetchMode.SELECT} */ @Deprecated public static final FetchMode LAZY = SELECT; /** - * Fetch eagerly, using an outer join. Equivalent to outer-join="true". + * Fetch eagerly, using an outer join. Equivalent to {@code outer-join="true"}. * - * @deprecated use FetchMode.JOIN + * @deprecated use {@code FetchMode.JOIN} */ @Deprecated public static final FetchMode EAGER = JOIN; diff --git a/hibernate-core/src/main/java/org/hibernate/Hibernate.java b/hibernate-core/src/main/java/org/hibernate/Hibernate.java index 8078c71c24..134c794c4e 100644 --- a/hibernate-core/src/main/java/org/hibernate/Hibernate.java +++ b/hibernate-core/src/main/java/org/hibernate/Hibernate.java @@ -43,9 +43,9 @@ import org.hibernate.proxy.LazyInitializer; /** *

* @@ -70,8 +70,8 @@ public final class Hibernate { * Note: This only ensures initialization of a proxy object or collection; * it is not guaranteed that the elements INSIDE the collection will be initialized/materialized. * - * @param proxy a persistable object, proxy, persistent collection or null - * @throws HibernateException if we can't initialize the proxy at this time, eg. the Session was closed + * @param proxy a persistable object, proxy, persistent collection or {@code null} + * @throws HibernateException if we can't initialize the proxy at this time, eg. the {@code Session} was closed */ public static void initialize(Object proxy) throws HibernateException { if ( proxy == null ) { @@ -96,7 +96,7 @@ public final class Hibernate { /** * Check if the proxy or persistent collection is initialized. * - * @param proxy a persistable object, proxy, persistent collection or null + * @param proxy a persistable object, proxy, persistent collection or {@code null} * @return true if the argument is already initialized, or is not a proxy or collection */ @SuppressWarnings("SimplifiableIfStatement") @@ -199,7 +199,7 @@ public final class Hibernate { /** * Check if the property is initialized. If the named property does not exist - * or is not persistent, this method always returns true. + * or is not persistent, this method always returns {@code true}. * * @param proxy The potential proxy * @param propertyName the name of a persistent attribute of the object @@ -286,7 +286,7 @@ public final class Hibernate { /** * Operations for obtaining references to persistent collections of a certain type. * - * @param the type of collection, for example, List<User> + * @param the type of collection, for example, {@code List<User>} */ public static final class CollectionInterface { private final Supplier detached; diff --git a/hibernate-core/src/main/java/org/hibernate/Interceptor.java b/hibernate-core/src/main/java/org/hibernate/Interceptor.java index 24c02bbab6..4a21a07bd9 100644 --- a/hibernate-core/src/main/java/org/hibernate/Interceptor.java +++ b/hibernate-core/src/main/java/org/hibernate/Interceptor.java @@ -19,15 +19,15 @@ import org.hibernate.type.Type; * Inspection occurs before property values are written and after they are read * from the database. * - * There might be a single instance of Interceptor for a SessionFactory, or a new instance - * might be specified for each Session. Whichever approach is used, the interceptor must be - * serializable if the Session is to be serializable. This means that SessionFactory-scoped - * interceptors should implement readResolve(). + * There might be a single instance of {@code Interceptor} for a {@code SessionFactory}, or a new instance + * might be specified for each {@code Session}. Whichever approach is used, the interceptor must be + * serializable if the {@code Session} is to be serializable. This means that {@code SessionFactory}-scoped + * interceptors should implement {@code readResolve()}. * - * The Session may not be invoked from a callback (nor may a callback cause a collection or proxy to + * The {@code Session} may not be invoked from a callback (nor may a callback cause a collection or proxy to * be lazily initialized). * - * Instead of implementing this interface directly, it is usually better to extend EmptyInterceptor + * Instead of implementing this interface directly, it is usually better to extend {@code EmptyInterceptor} * and override only the callback methods of interest. * * @see SessionBuilder#interceptor(Interceptor) @@ -38,19 +38,19 @@ import org.hibernate.type.Type; */ public interface Interceptor { /** - * Called just before an object is initialized. The interceptor may change the state, which will - * be propagated to the persistent object. Note that when this method is called, entity will be + * Called just before an object is initialized. The interceptor may change the {@code state}, which will + * be propagated to the persistent object. Note that when this method is called, {@code entity} will be * an empty uninitialized instance of the class. *

- * NOTE: The indexes across the state, propertyNames and types arrays match. + * NOTE: The indexes across the {@code state}, {@code propertyNames} and {@code types} arrays match. * * @param entity The entity instance being loaded * @param id The identifier value being loaded * @param state The entity state (which will be pushed into the entity instance) - * @param propertyNames The names of the entity properties, corresponding to the state. - * @param types The types of the entity properties, corresponding to the state. + * @param propertyNames The names of the entity properties, corresponding to the {@code state}. + * @param types The types of the entity properties, corresponding to the {@code state}. * - * @return {@code true} if the user modified the state in any way. + * @return {@code true} if the user modified the {@code state} in any way. * * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback. * @@ -63,19 +63,19 @@ public interface Interceptor { } /** - * Called just before an object is initialized. The interceptor may change the state, which will - * be propagated to the persistent object. Note that when this method is called, entity will be + * Called just before an object is initialized. The interceptor may change the {@code state}, which will + * be propagated to the persistent object. Note that when this method is called, {@code entity} will be * an empty uninitialized instance of the class. *

- * NOTE: The indexes across the state, propertyNames and types arrays match. + * NOTE: The indexes across the {@code state}, {@code propertyNames} and {@code types} arrays match. * * @param entity The entity instance being loaded * @param id The identifier value being loaded * @param state The entity state (which will be pushed into the entity instance) - * @param propertyNames The names of the entity properties, corresponding to the state. - * @param types The types of the entity properties, corresponding to the state. + * @param propertyNames The names of the entity properties, corresponding to the {@code state}. + * @param types The types of the entity properties, corresponding to the {@code state}. * - * @return {@code true} if the user modified the state in any way. + * @return {@code true} if the user modified the {@code state} in any way. * * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback. */ @@ -89,13 +89,13 @@ public interface Interceptor { /** * Called when an object is detected to be dirty, during a flush. The interceptor may modify the detected - * currentState, which will be propagated to both the database and the persistent object. + * {@code currentState}, which will be propagated to both the database and the persistent object. * Note that not all flushes end in actual synchronization with the database, in which case the - * new currentState will be propagated to the object, but not necessarily (immediately) to - * the database. It is strongly recommended that the interceptor not modify the previousState. + * new {@code currentState} will be propagated to the object, but not necessarily (immediately) to + * the database. It is strongly recommended that the interceptor not modify the {@code previousState}. *

- * NOTE: The indexes across the currentState, previousState, propertyNames and - * types arrays match. + * NOTE: The indexes across the {@code currentState}, {@code previousState}, {@code propertyNames} and + * {@code types} arrays match. * * @param entity The entity instance detected as being dirty and being flushed * @param id The identifier of the entity @@ -104,7 +104,7 @@ public interface Interceptor { * @param propertyNames The names of the entity properties * @param types The types of the entity properties * - * @return {@code true} if the user modified the currentState in any way. + * @return {@code true} if the user modified the {@code currentState} in any way. * * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback. * @@ -123,13 +123,13 @@ public interface Interceptor { /** * Called when an object is detected to be dirty, during a flush. The interceptor may modify the detected - * currentState, which will be propagated to both the database and the persistent object. + * {@code currentState}, which will be propagated to both the database and the persistent object. * Note that not all flushes end in actual synchronization with the database, in which case the - * new currentState will be propagated to the object, but not necessarily (immediately) to - * the database. It is strongly recommended that the interceptor not modify the previousState. + * new {@code currentState} will be propagated to the object, but not necessarily (immediately) to + * the database. It is strongly recommended that the interceptor not modify the {@code previousState}. *

- * NOTE: The indexes across the currentState, previousState, propertyNames and - * types arrays match. + * NOTE: The indexes across the {@code currentState}, {@code previousState}, {@code propertyNames} and + * {@code types} arrays match. * * @param entity The entity instance detected as being dirty and being flushed * @param id The identifier of the entity @@ -138,7 +138,7 @@ public interface Interceptor { * @param propertyNames The names of the entity properties * @param types The types of the entity properties * - * @return {@code true} if the user modified the currentState in any way. + * @return {@code true} if the user modified the {@code currentState} in any way. * * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback. */ @@ -156,8 +156,8 @@ public interface Interceptor { } /** - * Called before an object is saved. The interceptor may modify the state, which will be used for - * the SQL INSERT and propagated to the persistent object. + * Called before an object is saved. The interceptor may modify the {@code state}, which will be used for + * the SQL {@code INSERT} and propagated to the persistent object. * * @param entity The entity instance whose state is being inserted * @param id The identifier of the entity @@ -165,7 +165,7 @@ public interface Interceptor { * @param propertyNames The names of the entity properties. * @param types The types of the entity properties * - * @return true if the user modified the state in any way. + * @return {@code true} if the user modified the {@code state} in any way. * * @throws CallbackException Thrown if the interceptor encounters any problems handling the callback. */ @@ -173,7 +173,7 @@ public interface Interceptor { throws CallbackException; /** - * Called before an object is deleted. It is not recommended that the interceptor modify the state. + * Called before an object is deleted. It is not recommended that the interceptor modify the {@code state}. * * @param entity The entity instance being deleted * @param id The identifier of the entity @@ -190,7 +190,7 @@ public interface Interceptor { throws CallbackException {} /** - * Called before an object is deleted. It is not recommended that the interceptor modify the state. + * Called before an object is deleted. It is not recommended that the interceptor modify the {@code state}. * * @param entity The entity instance being deleted * @param id The identifier of the entity @@ -310,24 +310,24 @@ public interface Interceptor { * Called to distinguish between transient and detached entities. The return value determines the * state of the entity with respect to the current session. *

    - *
  • Boolean.TRUE - the entity is transient - *
  • Boolean.FALSE - the entity is detached - *
  • null - Hibernate uses the unsaved-value mapping and other heuristics to + *
  • {@code Boolean.TRUE} - the entity is transient + *
  • {@code Boolean.FALSE} - the entity is detached + *
  • {@code null} - Hibernate uses the {@code unsaved-value} mapping and other heuristics to * determine if the object is unsaved *
* @param entity a transient or detached entity - * @return Boolean or null to choose default behaviour + * @return Boolean or {@code null} to choose default behaviour */ default Boolean isTransient(Object entity) { return null; } /** - * Called from flush(). The return value determines whether the entity is updated + * Called from {@code flush()}. The return value determines whether the entity is updated *
    *
  • an array of property indices - the entity is dirty *
  • an empty array - the entity is not dirty - *
  • null - use Hibernate's default dirty-checking algorithm + *
  • {@code null} - use Hibernate's default dirty-checking algorithm *
* * @param entity The entity for which to find dirty properties. @@ -355,11 +355,11 @@ public interface Interceptor { } /** - * Called from flush(). The return value determines whether the entity is updated + * Called from {@code flush()}. The return value determines whether the entity is updated *
    *
  • an array of property indices - the entity is dirty *
  • an empty array - the entity is not dirty - *
  • null - use Hibernate's default dirty-checking algorithm + *
  • {@code null} - use Hibernate's default dirty-checking algorithm *
* * @param entity The entity for which to find dirty properties. @@ -387,7 +387,7 @@ public interface Interceptor { } /** - * Instantiate the entity. Return null to indicate that Hibernate should use + * Instantiate the entity. Return {@code null} to indicate that Hibernate should use * the default constructor of the class. The identifier property of the returned instance * should be initialized with the given identifier. */ @@ -451,7 +451,7 @@ public interface Interceptor { } /** - * Called when a Hibernate transaction is begun via the Hibernate Transaction + * Called when a Hibernate transaction is begun via the Hibernate {@code Transaction} * API. Will not be called if transactions are being controlled via some other * mechanism (CMT, for example). * diff --git a/hibernate-core/src/main/java/org/hibernate/LockMode.java b/hibernate-core/src/main/java/org/hibernate/LockMode.java index 1cd13da1ad..44d296ebce 100644 --- a/hibernate-core/src/main/java/org/hibernate/LockMode.java +++ b/hibernate-core/src/main/java/org/hibernate/LockMode.java @@ -21,7 +21,7 @@ package org.hibernate; public enum LockMode { /** * No lock required. If an object is requested with this lock - * mode, a READ lock will be obtained if it is + * mode, a {@code READ} lock will be obtained if it is * necessary to actually read the state from the database, * rather than pull it from a cache. *

@@ -36,7 +36,7 @@ public enum LockMode { READ( 5, "read" ), /** * An upgrade lock. Objects loaded in this lock mode are - * materialized using an SQL select ... for update. + * materialized using an SQL {@code select ... for update}. * * @deprecated instead use PESSIMISTIC_WRITE */ @@ -44,24 +44,24 @@ public enum LockMode { UPGRADE( 10, "upgrade" ), /** * Attempt to obtain an upgrade lock, using an Oracle-style - * select for update nowait. The semantics of + * {@code select for update nowait}. The semantics of * this lock mode, once obtained, are the same as - * UPGRADE. + * {@code UPGRADE}. */ UPGRADE_NOWAIT( 10, "upgrade-nowait" ), /** * Attempt to obtain an upgrade lock, using an Oracle-style - * select for update skip locked. The semantics of + * {@code select for update skip locked}. The semantics of * this lock mode, once obtained, are the same as - * UPGRADE. + * {@code UPGRADE}. */ UPGRADE_SKIPLOCKED( 10, "upgrade-skiplocked" ), /** - * A WRITE lock is obtained when an object is updated + * A {@code WRITE} lock is obtained when an object is updated * or inserted. This lock mode is for internal use only and is - * not a valid mode for load() or lock() (both + * not a valid mode for {@code load()} or {@code lock()} (both * of which throw exceptions if WRITE is specified). */ WRITE( 10, "write" ), diff --git a/hibernate-core/src/main/java/org/hibernate/LockOptions.java b/hibernate-core/src/main/java/org/hibernate/LockOptions.java index 0448f0e3e2..ff3df809cf 100644 --- a/hibernate-core/src/main/java/org/hibernate/LockOptions.java +++ b/hibernate-core/src/main/java/org/hibernate/LockOptions.java @@ -155,7 +155,7 @@ 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 - * null as well, {@link LockMode#NONE} is returned. + * {@code null} as well, {@link LockMode#NONE} is returned. *

* Differs from {@link #getAliasSpecificLockMode} in that here we fallback to we only return * the overall lock mode. diff --git a/hibernate-core/src/main/java/org/hibernate/NonUniqueResultException.java b/hibernate-core/src/main/java/org/hibernate/NonUniqueResultException.java index 2b2288e7eb..b2ae0ae193 100644 --- a/hibernate-core/src/main/java/org/hibernate/NonUniqueResultException.java +++ b/hibernate-core/src/main/java/org/hibernate/NonUniqueResultException.java @@ -7,7 +7,7 @@ package org.hibernate; /** - * Thrown when the application calls Query.uniqueResult() and + * Thrown when the application calls {@code Query.uniqueResult()} and * the query returned more than one result. Unlike all other Hibernate * exceptions, this one is recoverable! * diff --git a/hibernate-core/src/main/java/org/hibernate/ObjectNotFoundException.java b/hibernate-core/src/main/java/org/hibernate/ObjectNotFoundException.java index 3911ddc0c6..22f2aa9501 100644 --- a/hibernate-core/src/main/java/org/hibernate/ObjectNotFoundException.java +++ b/hibernate-core/src/main/java/org/hibernate/ObjectNotFoundException.java @@ -7,11 +7,11 @@ package org.hibernate; /** - * Thrown when Session.load() fails to select a row with + * Thrown when {@code Session.load()} fails to select a row with * the given primary key (identifier value). This exception might not - * be thrown when load() is called, even if there was no - * row on the database, because load() returns a proxy if - * possible. Applications should use Session.get() to test if + * be thrown when {@code load()} is called, even if there was no + * row on the database, because {@code load()} returns a proxy if + * possible. Applications should use {@code Session.get()} to test if * a row exists in the database. *

* Like all Hibernate exceptions, this exception is considered diff --git a/hibernate-core/src/main/java/org/hibernate/PersistentObjectException.java b/hibernate-core/src/main/java/org/hibernate/PersistentObjectException.java index 0e390bf85f..1d9a0640cc 100644 --- a/hibernate-core/src/main/java/org/hibernate/PersistentObjectException.java +++ b/hibernate-core/src/main/java/org/hibernate/PersistentObjectException.java @@ -7,7 +7,7 @@ package org.hibernate; /** - * Thrown when the user passes a persistent instance to a Session + * Thrown when the user passes a persistent instance to a {@code Session} * method that expects a transient instance. * * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/PropertyValueException.java b/hibernate-core/src/main/java/org/hibernate/PropertyValueException.java index c96bf09e68..7cab7a91ed 100644 --- a/hibernate-core/src/main/java/org/hibernate/PropertyValueException.java +++ b/hibernate-core/src/main/java/org/hibernate/PropertyValueException.java @@ -12,7 +12,7 @@ import org.hibernate.internal.util.StringHelper; * Thrown when the (illegal) value of a property can not be persisted. * There are two main causes: *

    - *
  • a property declared not-null="true" is null + *
  • a property declared {@code not-null="true"} is null *
  • an association references an unsaved transient instance *
* @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/ScrollableResults.java b/hibernate-core/src/main/java/org/hibernate/ScrollableResults.java index fce15f2400..f0243b8509 100644 --- a/hibernate-core/src/main/java/org/hibernate/ScrollableResults.java +++ b/hibernate-core/src/main/java/org/hibernate/ScrollableResults.java @@ -12,10 +12,10 @@ import org.hibernate.query.Query; /** * A result iterator that allows moving around within the results - * by arbitrary increments. The Query / ScrollableResults - * pattern is very similar to the JDBC PreparedStatement/ - * ResultSet pattern and the semantics of methods of this interface - * are similar to the similarly named methods on ResultSet. + * by arbitrary increments. The {@code Query} / {@code ScrollableResults} + * pattern is very similar to the JDBC {@code PreparedStatement}/ + * {@code ResultSet} pattern and the semantics of methods of this interface + * are similar to the similarly named methods on {@code ResultSet}. *

* Contrary to JDBC, columns of results are numbered from zero. * diff --git a/hibernate-core/src/main/java/org/hibernate/Session.java b/hibernate-core/src/main/java/org/hibernate/Session.java index 143199b38e..2d95106766 100644 --- a/hibernate-core/src/main/java/org/hibernate/Session.java +++ b/hibernate-core/src/main/java/org/hibernate/Session.java @@ -17,34 +17,34 @@ import org.hibernate.stat.SessionStatistics; * The main runtime interface between a Java application and Hibernate. This is the * central API class abstracting the notion of a persistence service. *

- * The lifecycle of a Session is bounded by the beginning and end of a logical + * The lifecycle of a {@code Session} is bounded by the beginning and end of a logical * transaction. (Long transactions might span several database transactions.) *

- * The main function of the Session is to offer create, read and delete operations + * The main function of the {@code Session} is to offer create, read and delete operations * for instances of mapped entity classes. Instances may exist in one of three states: *

    - *
  • transient: never persistent, not associated with any Session - *
  • persistent: associated with a unique Session - *
  • detached: previously persistent, not associated with any Session + *
  • transient: never persistent, not associated with any {@code Session} + *
  • persistent: associated with a unique {@code Session} + *
  • detached: previously persistent, not associated with any {@code Session} *
- * Transient instances may be made persistent by calling save(), - * persist() or saveOrUpdate(). Persistent instances may be made transient - * by calling delete(). Any instance returned by a get() or - * load() method is persistent. Detached instances may be made persistent - * by calling update(), saveOrUpdate(), lock() or replicate(). + * Transient instances may be made persistent by calling {@code save()}, + * {@code persist()} or {@code saveOrUpdate()}. Persistent instances may be made transient + * by calling{@code delete()}. Any instance returned by a {@code get()} or + * {@code load()} method is persistent. Detached instances may be made persistent + * by calling {@code update()}, {@code saveOrUpdate()}, {@code lock()} or {@code replicate()}. * The state of a transient or detached instance may also be made persistent as a new - * persistent instance by calling merge(). + * persistent instance by calling {@code merge()}. *

- * save() and persist() result in an SQL INSERT, delete() - * in an SQL DELETE and update() or merge() in an SQL UPDATE. + * {@code save()} and {@code persist()} result in an SQL {@code INSERT}, {@code delete()} + * in an SQL {@code DELETE} and {@code update()} or {@code merge()} in an SQL {@code UPDATE}. * Changes to persistent instances are detected at flush time and also result in an SQL - * UPDATE. saveOrUpdate() and replicate() result in either an - * INSERT or an UPDATE. + * {@code UPDATE}. {@code saveOrUpdate()} and {@code replicate()} result in either an + * {@code INSERT} or an {@code UPDATE}. *

* It is not intended that implementors be threadsafe. Instead each thread/transaction - * should obtain its own instance from a SessionFactory. + * should obtain its own instance from a {@code SessionFactory}. *

- * A Session instance is serializable if its persistent classes are serializable. + * A {@code Session} instance is serializable if its persistent classes are serializable. *

* A typical transaction should use the following idiom: * 

@@ -65,8 +65,8 @@ import org.hibernate.stat.SessionStatistics;
  * }
  *
*

- * If the Session throws an exception, the transaction must be rolled back - * and the session discarded. The internal state of the Session might not + * If the {@code Session} throws an exception, the transaction must be rolled back + * and the session discarded. The internal state of the {@code Session} might not * be consistent with the database after the exception occurs. * * @see SessionFactory @@ -251,14 +251,14 @@ public interface Session extends SharedSessionContract, EntityManager { * @param entityName The entity name * @param object an instance of a persistent class * - * @return true if the given instance is associated with this Session + * @return true if the given instance is associated with this {@code Session} */ boolean contains(String entityName, Object object); /** * Remove this instance from the session cache. Changes to the instance will * not be synchronized with the database. This operation cascades to associated - * instances if the association is mapped with cascade="evict". + * instances if the association is mapped with {@code cascade="evict"}. * * @param object The entity to evict * @@ -327,7 +327,7 @@ public interface Session extends SharedSessionContract, EntityManager { * assuming that the instance exists. This method might return a proxied instance that * is initialized on-demand, when a non-identifier method is accessed. *

- * You should not use this method to determine if an instance exists (use get() + * You should not use this method to determine if an instance exists (use {@code get()} * instead). Use this only to retrieve an instance that you assume exists, where non-existence * would be an actual error. * @@ -343,7 +343,7 @@ public interface Session extends SharedSessionContract, EntityManager { * assuming that the instance exists. This method might return a proxied instance that * is initialized on-demand, when a non-identifier method is accessed. *

- * You should not use this method to determine if an instance exists (use get() + * You should not use this method to determine if an instance exists (use {@code get()} * instead). Use this only to retrieve an instance that you assume exists, where non-existence * would be an actual error. * @@ -383,7 +383,7 @@ public interface Session extends SharedSessionContract, EntityManager { /** * Persist the given transient instance, first assigning a generated identifier. (Or - * using the current value of the identifier property if the assigned + * using the current value of the identifier property if the {@code assigned} * generator is used.) This operation cascades to associated instances if the * association is mapped with {@code cascade="save-update"} * @@ -395,7 +395,7 @@ public interface Session extends SharedSessionContract, EntityManager { /** * Persist the given transient instance, first assigning a generated identifier. (Or - * using the current value of the identifier property if the assigned + * using the current value of the identifier property if the {@code assigned} * generator is used.) This operation cascades to associated instances if the * association is mapped with {@code cascade="save-update"} * @@ -515,7 +515,7 @@ public interface Session extends SharedSessionContract, EntityManager { /** * Remove a persistent instance from the datastore. The argument may be - * an instance associated with the receiving Session or a transient + * an instance associated with the receiving {@code Session} or a transient * instance with an identifier associated with existing persistent state. * This operation cascades to associated instances if the association is mapped * with {@code cascade="delete"} @@ -526,7 +526,7 @@ public interface Session extends SharedSessionContract, EntityManager { /** * Remove a persistent instance from the datastore. The object argument may be - * an instance associated with the receiving Session or a transient + * an instance associated with the receiving {@code Session} or a transient * instance with an identifier associated with existing persistent state. * This operation cascades to associated instances if the association is mapped * with {@code cascade="delete"} @@ -538,10 +538,10 @@ public interface Session extends SharedSessionContract, EntityManager { /** * Obtain the specified lock level upon the given object. This may be used to - * perform a version check (LockMode.READ), to upgrade to a pessimistic - * lock (LockMode.PESSIMISTIC_WRITE), or to simply reassociate a transient instance - * with a session (LockMode.NONE). This operation cascades to associated - * instances if the association is mapped with cascade="lock". + * perform a version check ({@code LockMode.READ}), to upgrade to a pessimistic + * lock ({@code LockMode.PESSIMISTIC_WRITE}), or to simply reassociate a transient instance + * with a session ({@code LockMode.NONE}). This operation cascades to associated + * instances if the association is mapped with {@code cascade="lock"}. *

* Convenient form of {@link LockRequest#lock(Object)} via {@link #buildLockRequest(LockOptions)} * @@ -555,10 +555,10 @@ public interface Session extends SharedSessionContract, EntityManager { /** * Obtain the specified lock level upon the given object. This may be used to - * perform a version check (LockMode.OPTIMISTIC), to upgrade to a pessimistic - * lock (LockMode.PESSIMISTIC_WRITE), or to simply reassociate a transient instance - * with a session (LockMode.NONE). This operation cascades to associated - * instances if the association is mapped with cascade="lock". + * perform a version check ({@code LockMode.OPTIMISTIC}), to upgrade to a pessimistic + * lock ({@code LockMode.PESSIMISTIC_WRITE}), or to simply reassociate a transient instance + * with a session ({@code LockMode.NONE}). This operation cascades to associated + * instances if the association is mapped with {@code cascade="lock"}. *

* Convenient form of {@link LockRequest#lock(String, Object)} via {@link #buildLockRequest(LockOptions)} * @@ -593,7 +593,7 @@ public interface Session extends SharedSessionContract, EntityManager { *

    *
  • where a database trigger alters the object state upon insert or update *
  • after executing direct SQL (eg. a mass update) in the same session - *
  • after inserting a Blob or Clob + *
  • after inserting a {@code Blob} or {@code Clob} *
* * @param object a persistent or detached instance @@ -608,7 +608,7 @@ public interface Session extends SharedSessionContract, EntityManager { *
    *
  • where a database trigger alters the object state upon insert or update *
  • after executing direct SQL (eg. a mass update) in the same session - *
  • after inserting a Blob or Clob + *
  • after inserting a {@code Blob} or {@code Clob} *
* * @param entityName a persistent class @@ -618,7 +618,7 @@ public interface Session extends SharedSessionContract, EntityManager { /** * Re-read the state of the given instance from the underlying database, with - * the given LockMode. It is inadvisable to use this to implement + * the given {@code LockMode}. It is inadvisable to use this to implement * long-running sessions that span many business tasks. This method is, however, * useful in certain special circumstances. *

@@ -633,7 +633,7 @@ public interface Session extends SharedSessionContract, EntityManager { /** * Re-read the state of the given instance from the underlying database, with - * the given LockMode. It is inadvisable to use this to implement + * the given {@code LockMode}. It is inadvisable to use this to implement * long-running sessions that span many business tasks. This method is, however, * useful in certain special circumstances. * @@ -644,7 +644,7 @@ public interface Session extends SharedSessionContract, EntityManager { /** * Re-read the state of the given instance from the underlying database, with - * the given LockMode. It is inadvisable to use this to implement + * the given {@code LockMode}. It is inadvisable to use this to implement * long-running sessions that span many business tasks. This method is, however, * useful in certain special circumstances. * @@ -666,7 +666,7 @@ public interface Session extends SharedSessionContract, EntityManager { /** * Completely clear the session. Evict all loaded instances and cancel all pending * saves, updates and deletions. Do not close open iterators or instances of - * ScrollableResults. + * {@code ScrollableResults}. */ void clear(); diff --git a/hibernate-core/src/main/java/org/hibernate/SessionFactory.java b/hibernate-core/src/main/java/org/hibernate/SessionFactory.java index b242bc905e..91c54ff736 100644 --- a/hibernate-core/src/main/java/org/hibernate/SessionFactory.java +++ b/hibernate-core/src/main/java/org/hibernate/SessionFactory.java @@ -215,7 +215,7 @@ public interface SessionFactory extends EntityManagerFactory, HibernateEntityMan Statistics getStatistics(); /** - * Destroy this SessionFactory and release all resources (caches, + * Destroy this {@code SessionFactory} and release all resources (caches, * connection pools, etc). *

* It is the responsibility of the application to ensure that there are no @@ -336,7 +336,7 @@ public interface SessionFactory extends EntityManagerFactory, HibernateEntityMan /** * Get the {@link CollectionMetadata} for all mapped collections. * - * @return a map from String to CollectionMetadata + * @return a map from {@code String} to {@code CollectionMetadata} * * @throws HibernateException Generally empty map is returned instead of throwing. * diff --git a/hibernate-core/src/main/java/org/hibernate/action/internal/BulkOperationCleanupAction.java b/hibernate-core/src/main/java/org/hibernate/action/internal/BulkOperationCleanupAction.java index 60fb43be1a..18fb1b3cdb 100644 --- a/hibernate-core/src/main/java/org/hibernate/action/internal/BulkOperationCleanupAction.java +++ b/hibernate-core/src/main/java/org/hibernate/action/internal/BulkOperationCleanupAction.java @@ -37,8 +37,8 @@ import org.hibernate.sql.ast.tree.insert.InsertStatement; * An {@link org.hibernate.engine.spi.ActionQueue} {@link Executable} for ensuring * shared cache cleanup in relation to performed bulk HQL queries. *

- * NOTE: currently this executes for INSERT queries as well as - * UPDATE and DELETE queries. For INSERT it is + * NOTE: currently this executes for {@code INSERT} queries as well as + * {@code UPDATE} and {@code DELETE} queries. For {@code INSERT} it is * really not needed as we'd have no invalid entity/collection data to * cleanup (we'd still nee to invalidate the appropriate update-timestamps * regions) as a result of this query. diff --git a/hibernate-core/src/main/java/org/hibernate/boot/MetadataSources.java b/hibernate-core/src/main/java/org/hibernate/boot/MetadataSources.java index b42a84e29b..a2cdfe80f1 100644 --- a/hibernate-core/src/main/java/org/hibernate/boot/MetadataSources.java +++ b/hibernate-core/src/main/java/org/hibernate/boot/MetadataSources.java @@ -567,7 +567,7 @@ public class MetadataSources implements Serializable { /** * Read all mappings from a jar file. *

- * Assumes that any file named *.hbm.xml is a mapping document. + * Assumes that any file named {@code *.hbm.xml} is a mapping document. * * @param jar a jar file * @@ -592,7 +592,7 @@ public class MetadataSources implements Serializable { /** * Read all mapping documents from a directory tree. *

- * Assumes that any file named *.hbm.xml is a mapping document. + * Assumes that any file named {@code *.hbm.xml} is a mapping document. * * @param dir The directory * diff --git a/hibernate-core/src/main/java/org/hibernate/boot/internal/InFlightMetadataCollectorImpl.java b/hibernate-core/src/main/java/org/hibernate/boot/internal/InFlightMetadataCollectorImpl.java index da1043b1c5..e6b9c7a54e 100644 --- a/hibernate-core/src/main/java/org/hibernate/boot/internal/InFlightMetadataCollectorImpl.java +++ b/hibernate-core/src/main/java/org/hibernate/boot/internal/InFlightMetadataCollectorImpl.java @@ -1748,7 +1748,7 @@ public class InFlightMetadataCollectorImpl implements InFlightMetadataCollector * Checking all dependencies recursively seems quite expensive, but the original code just relied * on some sort of table name sorting which failed in certain circumstances. *

- * See ANN-722 and ANN-730 + * See {@code ANN-722} and {@code ANN-730} * * @param orderedFkSecondPasses The list containing the FkSecondPass instances ready * for processing. diff --git a/hibernate-core/src/main/java/org/hibernate/boot/model/naming/ObjectNameNormalizer.java b/hibernate-core/src/main/java/org/hibernate/boot/model/naming/ObjectNameNormalizer.java index cfb17768aa..90bd1fcf73 100644 --- a/hibernate-core/src/main/java/org/hibernate/boot/model/naming/ObjectNameNormalizer.java +++ b/hibernate-core/src/main/java/org/hibernate/boot/model/naming/ObjectNameNormalizer.java @@ -22,8 +22,8 @@ public abstract class ObjectNameNormalizer { * Normalizes the quoting of identifiers. *

* This implements the rules set forth in JPA 2 (section "2.13 Naming of Database Objects") which - * states that the double-quote (") is the character which should be used to denote a quoted - * identifier. Here, we handle recognizing that and converting it to the more elegant + * states that the double-quote (") is the character which should be used to denote a {@code quoted + * identifier}. Here, we handle recognizing that and converting it to the more elegant * backtick (`) approach used in Hibernate.. Additionally we account for applying what JPA2 terms * "globally quoted identifiers". * diff --git a/hibernate-core/src/main/java/org/hibernate/cache/spi/CacheImplementor.java b/hibernate-core/src/main/java/org/hibernate/cache/spi/CacheImplementor.java index 18304d1e94..c60d3d0f4d 100644 --- a/hibernate-core/src/main/java/org/hibernate/cache/spi/CacheImplementor.java +++ b/hibernate-core/src/main/java/org/hibernate/cache/spi/CacheImplementor.java @@ -86,7 +86,7 @@ public interface CacheImplementor extends Service, Cache, Serializable { QueryResultsCache getDefaultQueryResultsCache(); /** - * Get query cache by region name or create a new one if none exist. + * Get query cache by {@code region name} or create a new one if none exist. * * If the region name is null, then default query cache region will be returned. * 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 bf40ba2fb9..89d6e50ee2 100644 --- a/hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java +++ b/hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java @@ -771,13 +771,13 @@ public interface AvailableSettings { String DEFAULT_BATCH_FETCH_SIZE = "hibernate.default_batch_fetch_size"; /** - * Use java.io streams to read / write binary data from / to JDBC + * Use {@code java.io} streams to read / write binary data from / to JDBC */ String USE_STREAMS_FOR_BINARY = "hibernate.jdbc.use_streams_for_binary"; /** - * Use JDBC scrollable ResultSets. This property is only necessary when there is - * no ConnectionProvider, ie. the user is supplying JDBC connections. + * Use JDBC scrollable {@code ResultSet}s. This property is only necessary when there is + * no {@code ConnectionProvider}, ie. the user is supplying JDBC connections. */ String USE_SCROLLABLE_RESULTSET = "hibernate.jdbc.use_scrollable_resultset"; @@ -790,7 +790,7 @@ public interface AvailableSettings { /** * Gives the JDBC driver a hint as to the number of rows that should be fetched from the database - * when more rows are needed. If 0, JDBC driver default settings will be used. + * when more rows are needed. If {@code 0}, JDBC driver default settings will be used. */ String STATEMENT_FETCH_SIZE = "hibernate.jdbc.fetch_size"; @@ -821,7 +821,7 @@ public interface AvailableSettings { String AUTO_CLOSE_SESSION = "hibernate.transaction.auto_close_session"; /** - * Enable automatic flush during the JTA beforeCompletion() callback + * Enable automatic flush during the JTA {@code beforeCompletion()} callback */ String FLUSH_BEFORE_COMPLETION = "hibernate.transaction.flush_before_completion"; @@ -1137,24 +1137,24 @@ public interface AvailableSettings { String PROXOOL_CONFIG_PREFIX = "hibernate.proxool"; /** - * Proxool property to configure the Proxool Provider using an XML (/path/to/file.xml) + * Proxool property to configure the Proxool Provider using an XML ({@code /path/to/file.xml}) */ String PROXOOL_XML = "hibernate.proxool.xml"; /** - * Proxool property to configure the Proxool Provider using a properties file (/path/to/proxool.properties) + * Proxool property to configure the Proxool Provider using a properties file ({@code /path/to/proxool.properties}) */ String PROXOOL_PROPERTIES = "hibernate.proxool.properties"; /** - * Proxool property to configure the Proxool Provider from an already existing pool (true / false) + * Proxool property to configure the Proxool Provider from an already existing pool ({@code true} / {@code false}) */ String PROXOOL_EXISTING_POOL = "hibernate.proxool.existing_pool"; /** * Proxool property with the Proxool pool alias to use - * (Required for PROXOOL_EXISTING_POOL, PROXOOL_PROPERTIES, or - * PROXOOL_XML) + * (Required for {@code PROXOOL_EXISTING_POOL}, {@code PROXOOL_PROPERTIES}, or + * {@code PROXOOL_XML}) */ String PROXOOL_POOL_ALIAS = "hibernate.proxool.pool_alias"; @@ -1187,7 +1187,7 @@ public interface AvailableSettings { String CACHE_KEYS_FACTORY = "hibernate.cache.keys_factory"; /** - * The CacheProvider implementation class + * The {@code CacheProvider} implementation class */ String CACHE_PROVIDER_CONFIG = "hibernate.cache.provider_configuration_file_resource_path"; @@ -1210,7 +1210,7 @@ public interface AvailableSettings { String QUERY_CACHE_FACTORY = "hibernate.cache.query_cache_factory"; /** - * The CacheProvider region name prefix + * The {@code CacheProvider} region name prefix */ String CACHE_REGION_PREFIX = "hibernate.cache.region_prefix"; @@ -1434,10 +1434,10 @@ public interface AvailableSettings { * File order matters, the statements of a give file are executed before the statements of the * following files. *

- * These statements are only executed if the schema is created ie if hibernate.hbm2ddl.auto - * is set to create or create-drop. + * These statements are only executed if the schema is created ie if {@code hibernate.hbm2ddl.auto} + * is set to {@code create} or {@code create-drop}. *

- * The default value is /import.sql + * The default value is {@code /import.sql} *

* {@link #HBM2DDL_CREATE_SCRIPT_SOURCE} / {@link #HBM2DDL_DROP_SCRIPT_SOURCE} should be preferred * moving forward diff --git a/hibernate-core/src/main/java/org/hibernate/cfg/Configuration.java b/hibernate-core/src/main/java/org/hibernate/cfg/Configuration.java index ba6adbb4d8..f8ac46ae5a 100644 --- a/hibernate-core/src/main/java/org/hibernate/cfg/Configuration.java +++ b/hibernate-core/src/main/java/org/hibernate/cfg/Configuration.java @@ -239,11 +239,11 @@ public class Configuration { } /** - * Use the mappings and properties specified in an application resource named hibernate.cfg.xml. + * Use the mappings and properties specified in an application resource named {@code hibernate.cfg.xml}. * * @return this for method chaining * - * @throws HibernateException Generally indicates we cannot find hibernate.cfg.xml + * @throws HibernateException Generally indicates we cannot find {@code hibernate.cfg.xml} * * @see #configure(String) */ @@ -253,7 +253,7 @@ public class Configuration { /** * Use the mappings and properties specified in the given application resource. The format of the resource is - * defined in hibernate-configuration-3.0.dtd. + * defined in {@code hibernate-configuration-3.0.dtd}. * * @param resource The resource to use * @@ -278,7 +278,7 @@ public class Configuration { /** * Use the mappings and properties specified in the given document. The format of the document is defined in - * hibernate-configuration-3.0.dtd. + * {@code hibernate-configuration-3.0.dtd}. * * @param url URL from which you wish to load the configuration * @@ -294,7 +294,7 @@ public class Configuration { /** * Use the mappings and properties specified in the given application file. The format of the file is defined in - * hibernate-configuration-3.0.dtd. + * {@code hibernate-configuration-3.0.dtd}. * * @param configFile File from which you wish to load the configuration * @@ -402,12 +402,12 @@ public class Configuration { /** * Add a cached mapping file. A cached file is a serialized representation * of the DOM structure of a particular mapping. It is saved from a previous - * call as a file with the name xmlFile + ".bin" where xmlFile is + * call as a file with the name {@code xmlFile + ".bin"} where xmlFile is * the name of the original mapping file. *

- * If a cached xmlFile + ".bin" exists and is newer than - * xmlFile the ".bin" file will be read directly. Otherwise - * xmlFile is read and then serialized to xmlFile + ".bin" for use + * If a cached {@code xmlFile + ".bin"} exists and is newer than + * {@code xmlFile} the {@code ".bin"} file will be read directly. Otherwise + * xmlFile is read and then serialized to {@code xmlFile + ".bin"} for use * the next time. * * @param xmlFile The cacheable mapping file to be added. @@ -463,7 +463,7 @@ public class Configuration { } /** - * Read mappings from a URL + * Read mappings from a {@code URL} * * @param url The url for the mapping document to be read. * @return this (for method chaining purposes) @@ -476,7 +476,7 @@ public class Configuration { } /** - * Read mappings from a DOM Document + * Read mappings from a DOM {@code Document} * * @param doc The DOM document * @return this (for method chaining purposes) @@ -529,7 +529,7 @@ public class Configuration { /** * Read a mapping as an application resource using the convention that a class - * named foo.bar.Foo is mapped by a file foo/bar/Foo.hbm.xml + * named {@code foo.bar.Foo} is mapped by a file {@code foo/bar/Foo.hbm.xml} * which can be resolved as a classpath resource. * * @param persistentClass The mapped class @@ -572,7 +572,7 @@ public class Configuration { /** * Read all mappings from a jar file *

- * Assumes that any file named *.hbm.xml is a mapping document. + * Assumes that any file named {@code *.hbm.xml} is a mapping document. * * @param jar a jar file * @return this (for method chaining purposes) @@ -587,7 +587,7 @@ public class Configuration { /** * Read all mapping documents from a directory tree. *

- * Assumes that any file named *.hbm.xml is a mapping document. + * Assumes that any file named {@code *.hbm.xml} is a mapping document. * * @param dir The directory * @return this (for method chaining purposes) diff --git a/hibernate-core/src/main/java/org/hibernate/cfg/DefaultNamingStrategy.java b/hibernate-core/src/main/java/org/hibernate/cfg/DefaultNamingStrategy.java index c184a279b3..f58d7432d7 100644 --- a/hibernate-core/src/main/java/org/hibernate/cfg/DefaultNamingStrategy.java +++ b/hibernate-core/src/main/java/org/hibernate/cfg/DefaultNamingStrategy.java @@ -12,7 +12,7 @@ import org.hibernate.AssertionFailure; import org.hibernate.internal.util.StringHelper; /** - * The default NamingStrategy + * The default {@code NamingStrategy} * @see ImprovedNamingStrategy a better alternative * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/cfg/Environment.java b/hibernate-core/src/main/java/org/hibernate/cfg/Environment.java index 7cb206d0f5..5ef26cab89 100644 --- a/hibernate-core/src/main/java/org/hibernate/cfg/Environment.java +++ b/hibernate-core/src/main/java/org/hibernate/cfg/Environment.java @@ -24,125 +24,125 @@ import org.jboss.logging.Logger; /** - * Provides access to configuration info passed in Properties objects. + * Provides access to configuration info passed in {@code Properties} objects. *

* Hibernate has two property scopes: *

    - *
  • Factory-level properties may be passed to the SessionFactory when it + *
  • Factory-level properties may be passed to the {@code SessionFactory} when it * is instantiated. Each instance might have different property values. If no - * properties are specified, the factory calls Environment.getProperties(). + * properties are specified, the factory calls {@code Environment.getProperties()}. *
  • System-level properties are shared by all factory instances and are always - * determined by the Environment properties. + * determined by the {@code Environment} properties. *
* The only system-level properties are *
    - *
  • hibernate.jdbc.use_streams_for_binary - *
  • hibernate.cglib.use_reflection_optimizer + *
  • {@code hibernate.jdbc.use_streams_for_binary} + *
  • {@code hibernate.cglib.use_reflection_optimizer} *
- * Environment properties are populated by calling System.getProperties() - * and then from a resource named /hibernate.properties if it exists. System - * properties override properties specified in hibernate.properties. + * {@code Environment} properties are populated by calling {@code System.getProperties()} + * and then from a resource named {@code /hibernate.properties} if it exists. System + * properties override properties specified in {@code hibernate.properties}. *

- * The SessionFactory is controlled by the following properties. - * Properties may be either be System properties, properties - * defined in a resource named /hibernate.properties or an instance of - * java.util.Properties passed to - * Configuration.build() + * The {@code SessionFactory} is controlled by the following properties. + * Properties may be either be {@code System} properties, properties + * defined in a resource named {@code /hibernate.properties} or an instance of + * {@code java.util.Properties} passed to + * {@code Configuration.build()} *

* * * - * - * + * + * * * - * - * + * * - * - * + * + * * - * - * + * + * * * - * + * * * * - * + * * * - * + * * * * - * - * + * + * * * - * + * * * - * + * * * - * + * * * * - * + * * * * - * + * * * * - * + * * * * - * + * * * * - * + * * * * - * + * * * * - * + * * * * - * + * * + * JNDI context. This name is also used to support cross JVM {@code + * Session} (de)serialization. * * - * - * + * * * - * - * + * + * * * - * + * * *
propertymeaning
hibernate.dialectclassname of org.hibernate.dialect.Dialect subclass{@code hibernate.dialect}classname of {@code org.hibernate.dialect.Dialect} subclass
hibernate.connection.provider_classclassname of ConnectionProvider + * {@code hibernate.connection.provider_class}classname of {@code ConnectionProvider} * subclass (if not specified heuristics are used)
hibernate.connection.usernamedatabase username
hibernate.connection.passworddatabase password
{@code hibernate.connection.username}database username
{@code hibernate.connection.password}database password
hibernate.connection.urlJDBC URL (when using java.sql.DriverManager){@code hibernate.connection.url}JDBC URL (when using {@code java.sql.DriverManager})
hibernate.connection.driver_class{@code hibernate.connection.driver_class}classname of JDBC driver
hibernate.connection.isolation{@code hibernate.connection.isolation}JDBC transaction isolation level (only when using - * java.sql.DriverManager) + * {@code java.sql.DriverManager}) *
hibernate.connection.pool_size{@code hibernate.connection.pool_size}the maximum size of the connection pool (only when using - * java.sql.DriverManager) + * {@code java.sql.DriverManager}) *
hibernate.connection.datasourcedatasource JNDI name (when using javax.sql.Datasource){@code hibernate.connection.datasource}datasource JNDI name (when using {@code javax.sql.Datasource})
hibernate.jndi.urlJNDI InitialContext URL{@code hibernate.jndi.url}JNDI {@code InitialContext} URL
hibernate.jndi.classJNDI InitialContext classname{@code hibernate.jndi.class}JNDI {@code InitialContext} classname
hibernate.max_fetch_depth{@code hibernate.max_fetch_depth}maximum depth of outer join fetching
hibernate.jdbc.batch_size{@code hibernate.jdbc.batch_size}enable use of JDBC2 batch API for drivers which support it
hibernate.jdbc.fetch_size{@code hibernate.jdbc.fetch_size}set the JDBC fetch size
hibernate.jdbc.use_scrollable_resultset{@code hibernate.jdbc.use_scrollable_resultset}enable use of JDBC2 scrollable resultsets (you only need to specify * this property when using user supplied connections)
hibernate.jdbc.use_getGeneratedKeys{@code hibernate.jdbc.use_getGeneratedKeys}enable use of JDBC3 PreparedStatement.getGeneratedKeys() to retrieve * natively generated keys after insert. Requires JDBC3+ driver and JRE1.4+
hibernate.hbm2ddl.auto{@code hibernate.hbm2ddl.auto}enable auto DDL export
hibernate.default_schema{@code hibernate.default_schema}use given schema name for unqualified tables (always optional)
hibernate.default_catalog{@code hibernate.default_catalog}use given catalog name for unqualified tables (always optional)
hibernate.session_factory_name{@code hibernate.session_factory_name}If set, the factory attempts to bind this name to itself in the - * JNDI context. This name is also used to support cross JVM - * Session (de)serialization.
hibernate.transaction.jta.platformclassname of org.hibernate.engine.transaction.jta.platform.spi.JtaPlatform + * {@code hibernate.transaction.jta.platform}classname of {@code org.hibernate.engine.transaction.jta.platform.spi.JtaPlatform} * implementor
hibernate.transaction.factory_classthe factory to use for instantiating Transactions. - * (Defaults to JdbcTransactionFactory.){@code hibernate.transaction.factory_class}the factory to use for instantiating {@code Transaction}s. + * (Defaults to {@code JdbcTransactionFactory}.)
hibernate.query.substitutionsquery language token substitutions{@code hibernate.query.substitutions}query language token substitutions
* @@ -308,8 +308,8 @@ public final class Environment implements AvailableSettings { } /** - * Return System properties, extended by any properties specified - * in hibernate.properties. + * Return {@code System} properties, extended by any properties specified + * in {@code hibernate.properties}. * @return Properties */ public static Properties getProperties() { diff --git a/hibernate-core/src/main/java/org/hibernate/cfg/MetadataSourceType.java b/hibernate-core/src/main/java/org/hibernate/cfg/MetadataSourceType.java index 1917f33730..4b03bbd7c8 100644 --- a/hibernate-core/src/main/java/org/hibernate/cfg/MetadataSourceType.java +++ b/hibernate-core/src/main/java/org/hibernate/cfg/MetadataSourceType.java @@ -15,11 +15,11 @@ import org.hibernate.HibernateException; */ public enum MetadataSourceType { /** - * Indicates metadata coming from hbm.xml files + * Indicates metadata coming from {@code hbm.xml} files */ HBM( "hbm" ), /** - * Indicates metadata coming from either annotations, orx.xml or a combination of the two. + * Indicates metadata coming from either annotations, {@code orx.xml} or a combination of the two. */ CLASS( "class" ); diff --git a/hibernate-core/src/main/java/org/hibernate/classic/Lifecycle.java b/hibernate-core/src/main/java/org/hibernate/classic/Lifecycle.java index 6b4c67eed3..991ce73d49 100644 --- a/hibernate-core/src/main/java/org/hibernate/classic/Lifecycle.java +++ b/hibernate-core/src/main/java/org/hibernate/classic/Lifecycle.java @@ -12,32 +12,32 @@ import org.hibernate.Session; import java.io.Serializable; /** - * Provides callbacks from the Session to the persistent object. + * Provides callbacks from the {@code Session} to the persistent object. * Persistent classes may implement this interface but they are not * required to. *

    *
  • onSave: called just before the object is saved *
  • onUpdate: called just before an object is updated, - * ie. when Session.update() is called + * ie. when {@code Session.update()} is called *
  • onDelete: called just before an object is deleted * onLoad: called just after an object is loaded *
*

- * onLoad() may be used to initialize transient properties of the + * {@code onLoad()} may be used to initialize transient properties of the * object from its persistent state. It may not be used to load - * dependent objects since the Session interface may not be + * dependent objects since the {@code Session} interface may not be * invoked from inside this method. *

- * A further intended usage of onLoad(), onSave() and - * onUpdate() is to store a reference to the Session + * A further intended usage of {@code onLoad()}, {@code onSave()} and + * {@code onUpdate()} is to store a reference to the {@code Session} * for later use. *

- * If onSave(), onUpdate() or onDelete() return - * VETO, the operation is silently vetoed. If a - * CallbackException is thrown, the operation is vetoed and the + * If {@code onSave()}, {@code onUpdate()} or {@code onDelete()} return + * {@code VETO}, the operation is silently vetoed. If a + * {@code CallbackException} is thrown, the operation is vetoed and the * exception is passed back to the application. *

- * Note that onSave() is called after an identifier is assigned + * Note that {@code onSave()} is called after an identifier is assigned * to the object, except when identity column key generation is used. * * @see CallbackException @@ -66,7 +66,7 @@ public interface Lifecycle { } /** - * Called when an entity is passed to Session.update(). + * Called when an entity is passed to {@code Session.update()}. * This method is not called every time the object's * state is persisted during a flush. * @param s the session @@ -89,7 +89,7 @@ public interface Lifecycle { /** * Called after an entity is loaded. It is illegal to - * access the Session from inside this method. + * access the {@code Session} from inside this method. * However, the object may keep a reference to the session * for later use. * @@ -104,7 +104,7 @@ public interface Lifecycle { /** * Called after an entity is loaded. It is illegal to - * access the Session from inside this method. + * access the {@code Session} from inside this method. * However, the object may keep a reference to the session * for later use. * diff --git a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentBag.java b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentBag.java index d9b4c511ed..08bea12d4f 100644 --- a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentBag.java +++ b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentBag.java @@ -26,8 +26,8 @@ import org.hibernate.type.Type; /** * An unordered, unkeyed collection that can contain the same element - * multiple times. The Java collections API, curiously, has no Bag. - * Most developers seem to use Lists to represent bag semantics, + * multiple times. The Java collections API, curiously, has no {@code Bag}. + * Most developers seem to use {@code List}s to represent bag semantics, * so Hibernate follows this practice. * * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentIdentifierBag.java b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentIdentifierBag.java index 898c526204..6d13c6e5db 100644 --- a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentIdentifierBag.java +++ b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentIdentifierBag.java @@ -24,14 +24,14 @@ import org.hibernate.persister.collection.CollectionPersister; import org.hibernate.type.Type; /** - * An IdentifierBag implements "bag" semantics more efficiently than - * a regular Bag by adding a synthetic identifier column to the + * An {@code IdentifierBag} implements "bag" semantics more efficiently than + * a regular {@code Bag} by adding a synthetic identifier column to the * table. This identifier is unique for all rows in the table, allowing very * efficient updates and deletes. The value of the identifier is never exposed * to the application. *

- * IdentifierBags may not be used for a many-to-one association. - * Furthermore, there is no reason to use inverse="true". + * {@code IdentifierBag}s may not be used for a many-to-one association. + * Furthermore, there is no reason to use {@code inverse="true"}. * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentList.java b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentList.java index dc2e586517..466faf23ad 100644 --- a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentList.java +++ b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentList.java @@ -21,8 +21,8 @@ import org.hibernate.persister.collection.CollectionPersister; import org.hibernate.type.Type; /** - * A persistent wrapper for a java.util.List. Underlying - * collection is an ArrayList. + * A persistent wrapper for a {@code java.util.List}. Underlying + * collection is an {@code ArrayList}. * * @see ArrayList * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentMap.java b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentMap.java index 21137b137d..fa9b626225 100644 --- a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentMap.java +++ b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentMap.java @@ -25,8 +25,8 @@ import org.hibernate.type.Type; /** - * A persistent wrapper for a java.util.Map. Underlying collection - * is a HashMap. + * A persistent wrapper for a {@code java.util.Map}. Underlying collection + * is a {@code HashMap}. * * @see HashMap * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSet.java b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSet.java index 9d57cc5085..41ca982750 100644 --- a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSet.java +++ b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSet.java @@ -24,8 +24,8 @@ import org.hibernate.type.Type; /** - * A persistent wrapper for a java.util.Set. The underlying - * collection is a HashSet. + * A persistent wrapper for a {@code java.util.Set}. The underlying + * collection is a {@code HashSet}. * * @see java.util.HashSet * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSortedMap.java b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSortedMap.java index 0e88b425b6..8697475aa2 100644 --- a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSortedMap.java +++ b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSortedMap.java @@ -20,8 +20,8 @@ import org.hibernate.engine.spi.SharedSessionContractImplementor; import org.hibernate.persister.collection.BasicCollectionPersister; /** - * A persistent wrapper for a java.util.SortedMap. Underlying - * collection is a TreeMap. + * A persistent wrapper for a {@code java.util.SortedMap}. Underlying + * collection is a {@code TreeMap}. * * @see TreeMap * @author e diff --git a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSortedSet.java b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSortedSet.java index aa9ccb8968..d193e612fe 100644 --- a/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSortedSet.java +++ b/hibernate-core/src/main/java/org/hibernate/collection/internal/PersistentSortedSet.java @@ -17,8 +17,8 @@ import org.hibernate.engine.spi.SharedSessionContractImplementor; import org.hibernate.persister.collection.BasicCollectionPersister; /** - * A persistent wrapper for a java.util.SortedSet. Underlying - * collection is a TreeSet. + * A persistent wrapper for a {@code java.util.SortedSet}. Underlying + * collection is a {@code TreeSet}. * * @see java.util.TreeSet * @author e diff --git a/hibernate-core/src/main/java/org/hibernate/context/internal/ThreadLocalSessionContext.java b/hibernate-core/src/main/java/org/hibernate/context/internal/ThreadLocalSessionContext.java index 4feebd4a94..05e181266a 100644 --- a/hibernate-core/src/main/java/org/hibernate/context/internal/ThreadLocalSessionContext.java +++ b/hibernate-core/src/main/java/org/hibernate/context/internal/ThreadLocalSessionContext.java @@ -42,7 +42,7 @@ import org.jboss.logging.Logger; * a session upon first request and then clean it up after the {@link Transaction} * associated with that session is committed/rolled-back. In order for ensuring that happens, the * sessions generated here are unusable until after {@link Session#beginTransaction()} has been - * called. If close() is called on a session managed by this class, it will be automatically + * called. If {@code close()} is called on a session managed by this class, it will be automatically * unbound. * * Additionally, the static {@link #bind} and {@link #unbind} methods are provided to allow application diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java index 522f549233..25992b8cb3 100644 --- a/hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java +++ b/hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java @@ -1439,9 +1439,9 @@ public abstract class Dialect implements ConversionContext { /** * Get the name of the database type associated with the given - * java.sql.Types typecode. + * {@code java.sql.Types} typecode. * - * @param code java.sql.Types typecode + * @param code {@code java.sql.Types} typecode * @param size the length, precision, scale of the column * * @return the database type name @@ -1475,7 +1475,7 @@ public abstract class Dialect implements ConversionContext { /** * Get the name of the database type associated with the given - * SqlTypeDescriptor. + * {@code SqlTypeDescriptor}. * * @param jdbcType the SQL type * @param size the length, precision, scale of the column @@ -1526,7 +1526,7 @@ public abstract class Dialect implements ConversionContext { /** * Subclasses register a type name for the given type code and maximum - * column length. $l in the type name with be replaced by the + * column length. {@code $l} in the type name with be replaced by the * column length (if appropriate). * * @param code The {@link Types} typecode @@ -1538,7 +1538,7 @@ public abstract class Dialect implements ConversionContext { } /** - * Subclasses register a type name for the given type code. $l in + * Subclasses register a type name for the given type code. {@code $l} in * the type name with be replaced by the column length (if appropriate). * * @param code The {@link Types} typecode @@ -1876,15 +1876,15 @@ public abstract class Dialect implements ConversionContext { /** * If this dialect supports specifying lock timeouts, are those timeouts - * rendered into the SQL string as parameters. The implication + * rendered into the {@code SQL} string as parameters. The implication * is that Hibernate will need to bind the timeout value as a parameter * in the {@link PreparedStatement}. If true, the param position * is always handled as the last parameter; if the dialect specifies the - * lock timeout elsewhere in the SQL statement then the timeout + * lock timeout elsewhere in the {@code SQL} statement then the timeout * value should be directly rendered into the statement and this method * should return false. * - * @return True if the lock timeout is rendered into the SQL + * @return True if the lock timeout is rendered into the {@code SQL} * string as a parameter; false otherwise. */ public boolean isLockTimeoutParameterized() { @@ -1961,7 +1961,7 @@ public abstract class Dialect implements ConversionContext { * Get the string to append to SELECT statements to acquire locks * for this dialect. * - * @return The appropriate FOR UPDATE clause string. + * @return The appropriate {@code FOR UPDATE} clause string. */ public String getForUpdateString() { return " for update"; @@ -1973,7 +1973,7 @@ public abstract class Dialect implements ConversionContext { * the same as getForUpdateString. * * @param timeout in milliseconds, -1 for indefinite wait and 0 for no wait. - * @return The appropriate LOCK clause string. + * @return The appropriate {@code LOCK} clause string. */ public String getWriteLockString(int timeout) { return getForUpdateString(); @@ -1987,7 +1987,7 @@ public abstract class Dialect implements ConversionContext { * * @param aliases The columns to be read locked. * @param timeout in milliseconds, -1 for indefinite wait and 0 for no wait. - * @return The appropriate LOCK clause string. + * @return The appropriate {@code LOCK} clause string. */ public String getWriteLockString(String aliases, int timeout) { // by default we simply return the getWriteLockString(timeout) result since @@ -2001,7 +2001,7 @@ public abstract class Dialect implements ConversionContext { * the same as getForUpdateString. * * @param timeout in milliseconds, -1 for indefinite wait and 0 for no wait. - * @return The appropriate LOCK clause string. + * @return The appropriate {@code LOCK} clause string. */ public String getReadLockString(int timeout) { return getForUpdateString(); @@ -2015,7 +2015,7 @@ public abstract class Dialect implements ConversionContext { * * @param aliases The columns to be read locked. * @param timeout in milliseconds, -1 for indefinite wait and 0 for no wait. - * @return The appropriate LOCK clause string. + * @return The appropriate {@code LOCK} clause string. */ public String getReadLockString(String aliases, int timeout) { // by default we simply return the getReadLockString(timeout) result since @@ -2039,21 +2039,21 @@ public abstract class Dialect implements ConversionContext { } /** - * Does this dialect support FOR UPDATE in conjunction with + * Does this dialect support {@code FOR UPDATE} in conjunction with * outer joined rows? * - * @return True if outer joined rows can be locked via FOR UPDATE. + * @return True if outer joined rows can be locked via {@code FOR UPDATE}. */ public boolean supportsOuterJoinForUpdate() { return true; } /** - * Get the FOR UPDATE OF column_list fragment appropriate for this + * Get the {@code FOR UPDATE OF column_list} fragment appropriate for this * dialect given the aliases of the columns to be write locked. * * @param aliases The columns to be write locked. - * @return The appropriate FOR UPDATE OF column_list clause string. + * @return The appropriate {@code FOR UPDATE OF column_list} clause string. */ public String getForUpdateString(String aliases) { // by default we simply return the getForUpdateString() result since @@ -2062,12 +2062,12 @@ public abstract class Dialect implements ConversionContext { } /** - * Get the FOR UPDATE OF column_list fragment appropriate for this + * Get the {@code FOR UPDATE OF column_list} fragment appropriate for this * dialect given the aliases of the columns to be write locked. * * @param aliases The columns to be write locked. * @param lockOptions the lock options to apply - * @return The appropriate FOR UPDATE OF column_list clause string. + * @return The appropriate {@code FOR UPDATE OF column_list} clause string. */ public String getForUpdateString(String aliases, LockOptions lockOptions) { LockMode lockMode = lockOptions.getLockMode(); @@ -2085,9 +2085,9 @@ public abstract class Dialect implements ConversionContext { } /** - * Retrieves the FOR UPDATE NOWAIT syntax specific to this dialect. + * Retrieves the {@code FOR UPDATE NOWAIT} syntax specific to this dialect. * - * @return The appropriate FOR UPDATE NOWAIT clause string. + * @return The appropriate {@code FOR UPDATE NOWAIT} clause string. */ public String getForUpdateNowaitString() { // by default we report no support for NOWAIT lock semantics @@ -2095,9 +2095,9 @@ public abstract class Dialect implements ConversionContext { } /** - * Retrieves the FOR UPDATE SKIP LOCKED syntax specific to this dialect. + * Retrieves the {@code FOR UPDATE SKIP LOCKED} syntax specific to this dialect. * - * @return The appropriate FOR UPDATE SKIP LOCKED clause string. + * @return The appropriate {@code FOR UPDATE SKIP LOCKED} clause string. */ public String getForUpdateSkipLockedString() { // by default we report no support for SKIP_LOCKED lock semantics @@ -2105,29 +2105,29 @@ public abstract class Dialect implements ConversionContext { } /** - * Get the FOR UPDATE OF column_list NOWAIT fragment appropriate + * Get the {@code FOR UPDATE OF column_list NOWAIT} fragment appropriate * for this dialect given the aliases of the columns to be write locked. * * @param aliases The columns to be write locked. - * @return The appropriate FOR UPDATE OF colunm_list NOWAIT clause string. + * @return The appropriate {@code FOR UPDATE OF colunm_list NOWAIT} clause string. */ public String getForUpdateNowaitString(String aliases) { return getForUpdateString( aliases ); } /** - * Get the FOR UPDATE OF column_list SKIP LOCKED fragment appropriate + * Get the {@code FOR UPDATE OF column_list SKIP LOCKED} fragment appropriate * for this dialect given the aliases of the columns to be write locked. * * @param aliases The columns to be write locked. - * @return The appropriate FOR UPDATE colunm_list SKIP LOCKED clause string. + * @return The appropriate {@code FOR UPDATE colunm_list SKIP LOCKED} clause string. */ public String getForUpdateSkipLockedString(String aliases) { return getForUpdateString( aliases ); } /** - * Some dialects support an alternative means to SELECT FOR UPDATE, + * Some dialects support an alternative means to {@code SELECT FOR UPDATE}, * whereby a "lock hint" is appended to the table name in the from clause. *

* contributed by Helge Schulz @@ -2144,9 +2144,9 @@ public abstract class Dialect implements ConversionContext { * Modifies the given SQL by applying the appropriate updates for the specified * lock modes and key columns. *

- * The behavior here is that of an ANSI SQL SELECT FOR UPDATE. This + * The behavior here is that of an ANSI SQL {@code SELECT FOR UPDATE}. This * method is really intended to allow dialects which do not support - * SELECT FOR UPDATE to achieve this in their own fashion. + * {@code SELECT FOR UPDATE} to achieve this in their own fashion. * * @param sql the SQL string to modify * @param aliasedLockOptions lock options indexed by aliased table names. @@ -2809,7 +2809,7 @@ public abstract class Dialect implements ConversionContext { } /** - * Does this dialect support the ALTER TABLE syntax? + * Does this dialect support the {@code ALTER TABLE} syntax? * * @return True if we support altering of tables; false otherwise. */ @@ -3107,8 +3107,8 @@ public abstract class Dialect implements ConversionContext { } /** - * Does this dialect support parameters within the SELECT clause of - * INSERT ... SELECT ... statements? + * Does this dialect support parameters within the {@code SELECT} clause of + * {@code INSERT ... SELECT ...} statements? * * @return True if this is supported; false otherwise. * @since 3.2 @@ -3148,7 +3148,7 @@ public abstract class Dialect implements ConversionContext { } /** - * Does this dialect require that integer divisions be wrapped in cast() + * Does this dialect require that integer divisions be wrapped in {@code cast()} * calls to tell the db parser the expected type. * * @return True if integer divisions must be cast()ed to float diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/identity/SQLServerIdentityColumnSupport.java b/hibernate-core/src/main/java/org/hibernate/dialect/identity/SQLServerIdentityColumnSupport.java index dfaa0dddfa..89515ec2ac 100644 --- a/hibernate-core/src/main/java/org/hibernate/dialect/identity/SQLServerIdentityColumnSupport.java +++ b/hibernate-core/src/main/java/org/hibernate/dialect/identity/SQLServerIdentityColumnSupport.java @@ -11,7 +11,7 @@ package org.hibernate.dialect.identity; */ public class SQLServerIdentityColumnSupport extends AbstractTransactSQLIdentityColumnSupport { /** - * Use insert table(...) values(...) select SCOPE_IDENTITY() + * Use {@code insert table(...) values(...) select SCOPE_IDENTITY()} *

* {@inheritDoc} */ diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/lock/AbstractSelectLockingStrategy.java b/hibernate-core/src/main/java/org/hibernate/dialect/lock/AbstractSelectLockingStrategy.java index c8115590d3..aae2f03bf3 100644 --- a/hibernate-core/src/main/java/org/hibernate/dialect/lock/AbstractSelectLockingStrategy.java +++ b/hibernate-core/src/main/java/org/hibernate/dialect/lock/AbstractSelectLockingStrategy.java @@ -12,7 +12,7 @@ import org.hibernate.persister.entity.Lockable; /** * Base {@link LockingStrategy} implementation to support implementations - * based on issuing SQL SELECT statements + * based on issuing {@code SQL} {@code SELECT} statements * * @author Steve Ebersole */ diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/pagination/AbstractLimitHandler.java b/hibernate-core/src/main/java/org/hibernate/dialect/pagination/AbstractLimitHandler.java index 15c4cba05b..9131766c39 100644 --- a/hibernate-core/src/main/java/org/hibernate/dialect/pagination/AbstractLimitHandler.java +++ b/hibernate-core/src/main/java/org/hibernate/dialect/pagination/AbstractLimitHandler.java @@ -76,7 +76,7 @@ public abstract class AbstractLimitHandler implements LimitHandler { /** * Does the offset/limit clause come at the start of the - * SELECT statement, or at the end of the query? + * {@code SELECT} statement, or at the end of the query? * * @return true if limit parameters come before other parameters */ diff --git a/hibernate-core/src/main/java/org/hibernate/engine/config/spi/ConfigurationService.java b/hibernate-core/src/main/java/org/hibernate/engine/config/spi/ConfigurationService.java index 48b9569931..ebe6312c2f 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/config/spi/ConfigurationService.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/config/spi/ConfigurationService.java @@ -66,7 +66,7 @@ public interface ConfigurationService extends Service { public T getSetting(String name, Class expected, T defaultValue); /** - * Cast candidate to the instance of expected type. + * Cast {@code candidate} to the instance of {@code expected} type. * * @param expected The type of instance expected to return. * @param candidate The candidate object to be casted. diff --git a/hibernate-core/src/main/java/org/hibernate/engine/internal/ForeignKeys.java b/hibernate-core/src/main/java/org/hibernate/engine/internal/ForeignKeys.java index 5396c383dd..53cb33f3cd 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/internal/ForeignKeys.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/internal/ForeignKeys.java @@ -235,7 +235,7 @@ public final class ForeignKeys { /** * Is this instance persistent or detached? *

- * If assumed is non-null, don't hit the database to make the determination, instead assume that + * If {@code assumed} is non-null, don't hit the database to make the determination, instead assume that * value; the client code must be prepared to "recover" in the case that this assumed result is incorrect. * * @param entityName The name of the entity @@ -263,7 +263,7 @@ public final class ForeignKeys { /** * Is this instance, which we know is not persistent, actually transient? *

- * If assumed is non-null, don't hit the database to make the determination, instead assume that + * If {@code assumed} is non-null, don't hit the database to make the determination, instead assume that * value; the client code must be prepared to "recover" in the case that this assumed result is incorrect. * * @param entityName The name of the entity diff --git a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/spi/SqlExceptionHelper.java b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/spi/SqlExceptionHelper.java index fc64e78cd5..a9a26fe9cf 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/spi/SqlExceptionHelper.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/spi/SqlExceptionHelper.java @@ -71,7 +71,7 @@ public class SqlExceptionHelper { /** * Inject the exception converter to use. *

- * NOTE : null is allowed and signifies to use the default. + * NOTE : {@code null} is allowed and signifies to use the default. * * @param sqlExceptionConverter The converter to use. */ diff --git a/hibernate-core/src/main/java/org/hibernate/engine/profile/FetchProfile.java b/hibernate-core/src/main/java/org/hibernate/engine/profile/FetchProfile.java index f0959983ad..07657c1844 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/profile/FetchProfile.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/profile/FetchProfile.java @@ -114,7 +114,7 @@ public class FetchProfile { } /** - * Getter for property 'fetches'. Map of {@link Fetch} instances, keyed by association role + * Getter for property 'fetches'. Map of {@link Fetch} instances, keyed by association {@code role} * * @return Value for property 'fetches'. */ diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/IdentifierValue.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/IdentifierValue.java index 084be2cbae..591a152fcc 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/spi/IdentifierValue.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/spi/IdentifierValue.java @@ -15,7 +15,7 @@ import org.jboss.logging.Logger; /** * A strategy for determining if an identifier value is an identifier of * a new transient instance or a previously persistent transient instance. - * The strategy is determined by the unsaved-value attribute in + * The strategy is determined by the {@code unsaved-value} attribute in * the mapping file. * * @author Gavin King @@ -116,7 +116,7 @@ public class IdentifierValue implements UnsavedValueStrategy { /** * Assume the transient instance is newly instantiated if - * its identifier is null or equal to value + * its identifier is null or equal to {@code value} */ public IdentifierValue(Object value) { this.value = value; diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/Mapping.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/Mapping.java index e9b519d671..2315688ad5 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/spi/Mapping.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/spi/Mapping.java @@ -10,9 +10,9 @@ import org.hibernate.MappingException; import org.hibernate.type.Type; /** - * Defines operations common to "compiled" mappings (ie. SessionFactory) - * and "uncompiled" mappings (ie. Configuration) that are used by - * implementors of Type. + * Defines operations common to "compiled" mappings (ie. {@code SessionFactory}) + * and "uncompiled" mappings (ie. {@code Configuration}) that are used by + * implementors of {@code Type}. * * @see Type * @see org.hibernate.internal.SessionFactoryImpl diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/PersistenceContext.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/PersistenceContext.java index cbca135f8f..28dfb79c40 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/spi/PersistenceContext.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/spi/PersistenceContext.java @@ -331,14 +331,14 @@ public interface PersistenceContext { Object narrowProxy(Object proxy, EntityPersister persister, EntityKey key, Object object); /** - * Return the existing proxy associated with the given EntityKey, or the + * Return the existing proxy associated with the given {@code EntityKey}, or the * third argument (the entity associated with the key) if no proxy exists. Init * the proxy to the target implementation, if necessary. */ Object proxyFor(EntityPersister persister, EntityKey key, Object impl); /** - * Return the existing proxy associated with the given EntityKey, or the + * Return the existing proxy associated with the given {@code EntityKey}, or the * argument (the entity associated with the key) if no proxy exists. * (slower than the form above) */ @@ -406,7 +406,7 @@ public interface PersistenceContext { Object id); /** - * Get the collection instance associated with the CollectionKey + * Get the collection instance associated with the {@code CollectionKey} */ PersistentCollection getCollection(CollectionKey collectionKey); @@ -424,12 +424,12 @@ public interface PersistenceContext { void initializeNonLazyCollections() throws HibernateException; /** - * Get the PersistentCollection object for an array + * Get the {@code PersistentCollection} object for an array */ PersistentCollection getCollectionHolder(Object array); /** - * Register a PersistentCollection object for an array. + * Register a {@code PersistentCollection} object for an array. * Associates a holder with an array - MUST be called after loading * array, since the array instance is not created until endLoad(). */ @@ -583,8 +583,8 @@ public interface PersistenceContext { String toString(); /** - * Search this persistence context for an associated entity instance which is considered the "owner" of - * the given childEntity, and return that owner's id value. This is performed in the scenario of a + * Search {@code this} persistence context for an associated entity instance which is considered the "owner" of + * the given {@code childEntity}, and return that owner's id value. This is performed in the scenario of a * uni-directional, non-inverse one-to-many collection (which means that the collection elements do not maintain * a direct reference to the owner). *

@@ -592,7 +592,7 @@ public interface PersistenceContext { * context and for those of the correct entity (sub) type to extract its collection role property value and see * if the child is contained within that collection. If so, we have found the owner; if not, we go on. *

- * Also need to account for mergeMap which acts as a local copy cache managed for the duration of a merge + * Also need to account for {@code mergeMap} which acts as a local copy cache managed for the duration of a merge * operation. It represents a map of the detached entity instances pointing to the corresponding managed instance. * * @param entityName The entity name for the entity type which would own the child diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionBuilderImplementor.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionBuilderImplementor.java index 22f33ec5cb..613e267478 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionBuilderImplementor.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionBuilderImplementor.java @@ -9,7 +9,7 @@ package org.hibernate.engine.spi; import org.hibernate.SessionBuilder; /** - * Defines the internal contract between the SessionBuilder and other parts of + * Defines the internal contract between the {@code SessionBuilder} and other parts of * Hibernate.. * * @see SessionBuilder diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionFactoryImplementor.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionFactoryImplementor.java index 1896f90d98..be2d4d24ab 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionFactoryImplementor.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionFactoryImplementor.java @@ -50,8 +50,8 @@ import org.hibernate.type.descriptor.WrapperOptions; import org.hibernate.type.spi.TypeConfiguration; /** - * Defines the internal contract between the SessionFactory and other parts of - * Hibernate such as implementors of Type. + * Defines the internal contract between the {@code SessionFactory} and other parts of + * Hibernate such as implementors of {@code Type}. * * @see SessionFactory * @see org.hibernate.internal.SessionFactoryImpl diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionContractImplementor.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionContractImplementor.java index 46d586ac89..9cd4fcbb1a 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionContractImplementor.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionContractImplementor.java @@ -76,7 +76,7 @@ public interface SharedSessionContractImplementor // 5) #disableTransactionAutoJoin /** - * Get the creating SessionFactoryImplementor + * Get the creating {@code SessionFactoryImplementor} */ SessionFactoryImplementor getFactory(); @@ -207,7 +207,7 @@ public interface SharedSessionContractImplementor CacheTransactionSynchronization getCacheTransactionSynchronization(); /** - * Does this Session have an active Hibernate transaction + * Does this {@code Session} have an active Hibernate transaction * or is there a JTA transaction in progress? */ boolean isTransactionInProgress(); @@ -265,14 +265,14 @@ public interface SharedSessionContractImplementor /** * Load an instance without checking if it was deleted. *

- * When nullable is disabled this method may create a new proxy or + * When {@code nullable} is disabled this method may create a new proxy or * return an existing proxy; if it does not exist, throw an exception. *

- * When nullable is enabled, the method does not create new proxies + * When {@code nullable} is enabled, the method does not create new proxies * (but might return an existing proxy); if it does not exist, return - * null. + * {@code null}. *

- * When eager is enabled, the object is eagerly fetched + * When {@code eager} is enabled, the object is eagerly fetched */ Object internalLoad(String entityName, Object id, boolean eager, boolean nullable) throws HibernateException; @@ -285,7 +285,7 @@ public interface SharedSessionContractImplementor /** - * Get the EntityPersister for any instance + * Get the {@code EntityPersister} for any instance * * @param entityName optional entity name * @param object the entity instance @@ -293,7 +293,7 @@ public interface SharedSessionContractImplementor EntityPersister getEntityPersister(String entityName, Object object) throws HibernateException; /** - * Get the entity instance associated with the given Key, + * Get the entity instance associated with the given {@code Key}, * calling the Interceptor if necessary */ Object getEntityUsingInterceptor(EntityKey key) throws HibernateException; diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/VersionValue.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/VersionValue.java index 0a719b7cac..d667fd5595 100644 --- a/hibernate-core/src/main/java/org/hibernate/engine/spi/VersionValue.java +++ b/hibernate-core/src/main/java/org/hibernate/engine/spi/VersionValue.java @@ -15,7 +15,7 @@ import org.jboss.logging.Logger; /** * A strategy for determining if a version value is a version of * a new transient instance or a previously persistent transient instance. - * The strategy is determined by the unsaved-value attribute in + * The strategy is determined by the {@code unsaved-value} attribute in * the mapping file. * * @author Gavin King @@ -105,7 +105,7 @@ public class VersionValue implements UnsavedValueStrategy { /** * Assume the transient instance is newly instantiated if - * its version is null or equal to value + * its version is null or equal to {@code value} * * @param value value to compare to */ diff --git a/hibernate-core/src/main/java/org/hibernate/event/spi/PreDeleteEvent.java b/hibernate-core/src/main/java/org/hibernate/event/spi/PreDeleteEvent.java index dcc186905b..7eabf3fbd8 100644 --- a/hibernate-core/src/main/java/org/hibernate/event/spi/PreDeleteEvent.java +++ b/hibernate-core/src/main/java/org/hibernate/event/spi/PreDeleteEvent.java @@ -10,7 +10,7 @@ import org.hibernate.persister.entity.EntityPersister; /** - * Represents a pre-delete event, which occurs just prior to + * Represents a {@code pre-delete} event, which occurs just prior to * performing the deletion of an entity from the database. * * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/event/spi/PreInsertEvent.java b/hibernate-core/src/main/java/org/hibernate/event/spi/PreInsertEvent.java index c27cbed681..ebe3f8a94e 100644 --- a/hibernate-core/src/main/java/org/hibernate/event/spi/PreInsertEvent.java +++ b/hibernate-core/src/main/java/org/hibernate/event/spi/PreInsertEvent.java @@ -9,7 +9,7 @@ package org.hibernate.event.spi; import org.hibernate.persister.entity.EntityPersister; /** - * Represents a pre-insert event, which occurs just prior to + * Represents a {@code pre-insert} event, which occurs just prior to * performing the insert of an entity into the database. * * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/event/spi/PreUpdateEvent.java b/hibernate-core/src/main/java/org/hibernate/event/spi/PreUpdateEvent.java index 9a10256145..b01ccde722 100644 --- a/hibernate-core/src/main/java/org/hibernate/event/spi/PreUpdateEvent.java +++ b/hibernate-core/src/main/java/org/hibernate/event/spi/PreUpdateEvent.java @@ -9,7 +9,7 @@ package org.hibernate.event.spi; import org.hibernate.persister.entity.EntityPersister; /** - * Represents a pre-update event, which occurs just prior to + * Represents a {@code pre-update} event, which occurs just prior to * performing the update of an entity in the database. * * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/id/Assigned.java b/hibernate-core/src/main/java/org/hibernate/id/Assigned.java index 44ff7ed85d..071bb18d4d 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/Assigned.java +++ b/hibernate-core/src/main/java/org/hibernate/id/Assigned.java @@ -18,7 +18,7 @@ import org.hibernate.type.Type; /** * assigned *

- * An IdentifierGenerator that returns the current identifier assigned + * An {@code IdentifierGenerator} that returns the current identifier assigned * to an instance. * * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/id/Configurable.java b/hibernate-core/src/main/java/org/hibernate/id/Configurable.java index 87d53fba0d..225d1ea3f1 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/Configurable.java +++ b/hibernate-core/src/main/java/org/hibernate/id/Configurable.java @@ -26,7 +26,7 @@ import org.hibernate.type.Type; public interface Configurable { /** * Configure this instance, given the value of parameters - * specified by the user as <param> elements. + * specified by the user as {@code <param>} elements. * This method is called just once, following instantiation. * * @param type The id property type descriptor diff --git a/hibernate-core/src/main/java/org/hibernate/id/ForeignGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/ForeignGenerator.java index 6d5c3fb496..4c91288de7 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/ForeignGenerator.java +++ b/hibernate-core/src/main/java/org/hibernate/id/ForeignGenerator.java @@ -27,7 +27,7 @@ import static org.hibernate.internal.CoreLogging.messageLogger; /** * foreign *

- * An Identifier generator that uses the value of the id property of an + * An {@code Identifier} generator that uses the value of the id property of an * associated object *

* One mapping parameter is required: property. diff --git a/hibernate-core/src/main/java/org/hibernate/id/GUIDGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/GUIDGenerator.java index f18dfe7ac8..83361e5cae 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/GUIDGenerator.java +++ b/hibernate-core/src/main/java/org/hibernate/id/GUIDGenerator.java @@ -17,7 +17,7 @@ import org.hibernate.internal.CoreLogging; import org.hibernate.internal.CoreMessageLogger; /** - * Generates string values using the SQL Server NEWID() function. + * Generates {@code string} values using the SQL Server NEWID() function. * * @author Joseph Fifield * diff --git a/hibernate-core/src/main/java/org/hibernate/id/IdentifierGenerationException.java b/hibernate-core/src/main/java/org/hibernate/id/IdentifierGenerationException.java index 4fc603b02e..4cf973595c 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/IdentifierGenerationException.java +++ b/hibernate-core/src/main/java/org/hibernate/id/IdentifierGenerationException.java @@ -8,7 +8,7 @@ package org.hibernate.id; import org.hibernate.HibernateException; /** - * Thrown by IdentifierGenerator implementation class when + * Thrown by {@code IdentifierGenerator} implementation class when * ID generation fails. * * @see IdentifierGenerator diff --git a/hibernate-core/src/main/java/org/hibernate/id/IdentifierGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/IdentifierGenerator.java index 2c76967307..03198d6ffd 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/IdentifierGenerator.java +++ b/hibernate-core/src/main/java/org/hibernate/id/IdentifierGenerator.java @@ -20,7 +20,7 @@ import org.hibernate.type.Type; /** * The general contract between a class that generates unique - * identifiers and the Session. It is not intended that + * identifiers and the {@code Session}. It is not intended that * this interface ever be exposed to the application. It is * intended that users implement this interface to provide * custom identifier generation strategies. @@ -28,7 +28,7 @@ import org.hibernate.type.Type; * Implementors should provide a public default constructor. *

* Implementations that accept configuration parameters should - * also implement Configurable. + * also implement {@code Configurable}. *

* Implementors must be thread-safe * @@ -60,7 +60,7 @@ public interface IdentifierGenerator extends Configurable, ExportableProducer { /** * Configure this instance, given the value of parameters - * specified by the user as <param> elements. + * specified by the user as {@code <param>} elements. *

* This method is called just once, following instantiation, and before {@link #registerExportables(Database)}. * diff --git a/hibernate-core/src/main/java/org/hibernate/id/IdentityGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/IdentityGenerator.java index dd8a5551ad..e104d140a2 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/IdentityGenerator.java +++ b/hibernate-core/src/main/java/org/hibernate/id/IdentityGenerator.java @@ -25,7 +25,7 @@ import org.hibernate.id.insert.InsertSelectIdentityInsert; * A generator for use with ANSI-SQL IDENTITY columns used as the primary key. * The IdentityGenerator for autoincrement/identity key generation. *

- * Indicates to the Session that identity (ie. identity/autoincrement + * Indicates to the {@code Session} that identity (ie. identity/autoincrement * column) key generation should be used. * * @author Christoph Sturm diff --git a/hibernate-core/src/main/java/org/hibernate/id/IncrementGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/IncrementGenerator.java index ed0ccfa96f..87aa5dfd36 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/IncrementGenerator.java +++ b/hibernate-core/src/main/java/org/hibernate/id/IncrementGenerator.java @@ -33,7 +33,7 @@ import org.hibernate.type.Type; /** * increment *

- * An IdentifierGenerator that returns a long, constructed by + * An {@code IdentifierGenerator} that returns a {@code long}, constructed by * counting from the maximum primary key value at startup. Not safe for use in a * cluster! *

diff --git a/hibernate-core/src/main/java/org/hibernate/id/IntegralDataTypeHolder.java b/hibernate-core/src/main/java/org/hibernate/id/IntegralDataTypeHolder.java index 71ac7ed127..1de2598371 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/IntegralDataTypeHolder.java +++ b/hibernate-core/src/main/java/org/hibernate/id/IntegralDataTypeHolder.java @@ -21,7 +21,7 @@ public interface IntegralDataTypeHolder extends Serializable { * * @param value The primitive integral value. * - * @return this, for method chaining + * @return {@code this}, for method chaining */ public IntegralDataTypeHolder initialize(long value); @@ -32,7 +32,7 @@ public interface IntegralDataTypeHolder extends Serializable { * @param resultSet The JDBC result set * @param defaultValue The default value to use if we did not get a result set value. * - * @return this, for method chaining + * @return {@code this}, for method chaining * * @throws SQLException Any exception from accessing the result set */ @@ -51,7 +51,7 @@ public interface IntegralDataTypeHolder extends Serializable { /** * Equivalent to a ++ operation * - * @return this, for method chaining + * @return {@code this}, for method chaining */ public IntegralDataTypeHolder increment(); @@ -60,14 +60,14 @@ public interface IntegralDataTypeHolder extends Serializable { * * @param addend The value to add to this integral. * - * @return this, for method chaining + * @return {@code this}, for method chaining */ public IntegralDataTypeHolder add(long addend); /** * Equivalent to a -- operation * - * @return this, for method chaining + * @return {@code this}, for method chaining */ public IntegralDataTypeHolder decrement(); @@ -76,7 +76,7 @@ public interface IntegralDataTypeHolder extends Serializable { * * @param subtrahend The value to subtract from this integral. * - * @return this, for method chaining + * @return {@code this}, for method chaining */ public IntegralDataTypeHolder subtract(long subtrahend); @@ -85,7 +85,7 @@ public interface IntegralDataTypeHolder extends Serializable { * * @param factor The factor by which to multiple this integral * - * @return this, for method chaining + * @return {@code this}, for method chaining */ public IntegralDataTypeHolder multiplyBy(IntegralDataTypeHolder factor); @@ -94,7 +94,7 @@ public interface IntegralDataTypeHolder extends Serializable { * * @param factor The factor by which to multiple this integral * - * @return this, for method chaining + * @return {@code this}, for method chaining */ public IntegralDataTypeHolder multiplyBy(long factor); diff --git a/hibernate-core/src/main/java/org/hibernate/id/PersistentIdentifierGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/PersistentIdentifierGenerator.java index dd1a772b0a..442d9acd97 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/PersistentIdentifierGenerator.java +++ b/hibernate-core/src/main/java/org/hibernate/id/PersistentIdentifierGenerator.java @@ -14,9 +14,9 @@ import org.hibernate.service.ServiceRegistry; import org.hibernate.type.Type; /** - * An IdentifierGenerator that requires creation of database objects. + * An {@code IdentifierGenerator} that requires creation of database objects. *

- * All PersistentIdentifierGenerators have access to a special mapping parameter + * All {@code PersistentIdentifierGenerator}s have access to a special mapping parameter * in their {@link #configure(Type, Properties, ServiceRegistry)} method: schema * * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/id/PostInsertIdentityPersister.java b/hibernate-core/src/main/java/org/hibernate/id/PostInsertIdentityPersister.java index da4daca7df..776bb0410b 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/PostInsertIdentityPersister.java +++ b/hibernate-core/src/main/java/org/hibernate/id/PostInsertIdentityPersister.java @@ -9,7 +9,7 @@ import org.hibernate.persister.entity.EntityPersister; /** * A persister that may have an identity assigned by execution of - * a SQL INSERT. + * a SQL {@code INSERT}. * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/id/UUIDHexGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/UUIDHexGenerator.java index 6504d4964a..4cc2db3dde 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/UUIDHexGenerator.java +++ b/hibernate-core/src/main/java/org/hibernate/id/UUIDHexGenerator.java @@ -19,7 +19,7 @@ import org.hibernate.type.Type; /** * uuid *

- * A UUIDGenerator that returns a string of length 32, + * A {@code UUIDGenerator} that returns a string of length 32, * This string will consist of only hex digits. Optionally, * the string may be generated with separators between each * component of the UUID. diff --git a/hibernate-core/src/main/java/org/hibernate/id/enhanced/InitialValueAwareOptimizer.java b/hibernate-core/src/main/java/org/hibernate/id/enhanced/InitialValueAwareOptimizer.java index 079553288d..dc85fe9070 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/enhanced/InitialValueAwareOptimizer.java +++ b/hibernate-core/src/main/java/org/hibernate/id/enhanced/InitialValueAwareOptimizer.java @@ -18,9 +18,9 @@ public interface InitialValueAwareOptimizer { /** * Reports the user specified initial value to the optimizer. *

- * -1 is used to indicate that the user did not specify. + * {@code -1} is used to indicate that the user did not specify. * - * @param initialValue The initial value specified by the user, or -1 to indicate that the + * @param initialValue The initial value specified by the user, or {@code -1} to indicate that the * user did not specify. */ public void injectInitialValue(long initialValue); diff --git a/hibernate-core/src/main/java/org/hibernate/id/factory/IdentifierGeneratorFactory.java b/hibernate-core/src/main/java/org/hibernate/id/factory/IdentifierGeneratorFactory.java index 7c0679437b..4aa717e934 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/factory/IdentifierGeneratorFactory.java +++ b/hibernate-core/src/main/java/org/hibernate/id/factory/IdentifierGeneratorFactory.java @@ -17,7 +17,7 @@ import org.hibernate.type.descriptor.java.JavaType; import jakarta.persistence.GenerationType; /** - * Contract for a factory of {@link IdentifierGenerator} instances. + * Contract for a {@code factory} of {@link IdentifierGenerator} instances. * * @author Steve Ebersole */ diff --git a/hibernate-core/src/main/java/org/hibernate/id/factory/internal/StandardIdentifierGeneratorFactory.java b/hibernate-core/src/main/java/org/hibernate/id/factory/internal/StandardIdentifierGeneratorFactory.java index ee5ea0fbe6..f1344bc084 100644 --- a/hibernate-core/src/main/java/org/hibernate/id/factory/internal/StandardIdentifierGeneratorFactory.java +++ b/hibernate-core/src/main/java/org/hibernate/id/factory/internal/StandardIdentifierGeneratorFactory.java @@ -55,7 +55,7 @@ import jakarta.persistence.GenerationType; import static org.hibernate.id.factory.IdGenFactoryLogging.ID_GEN_FAC_LOGGER; /** - * Basic templated support for {@link org.hibernate.id.factory.IdentifierGeneratorFactory} implementations. + * Basic {@code templated} support for {@link org.hibernate.id.factory.IdentifierGeneratorFactory} implementations. * * @author Steve Ebersole */ diff --git a/hibernate-core/src/main/java/org/hibernate/internal/SessionFactoryImpl.java b/hibernate-core/src/main/java/org/hibernate/internal/SessionFactoryImpl.java index e67fa3c28f..96381c97dc 100644 --- a/hibernate-core/src/main/java/org/hibernate/internal/SessionFactoryImpl.java +++ b/hibernate-core/src/main/java/org/hibernate/internal/SessionFactoryImpl.java @@ -138,16 +138,16 @@ import org.jboss.logging.Logger; /** - * Concrete implementation of the SessionFactory interface. Has the following + * Concrete implementation of the {@code SessionFactory} interface. Has the following * responsibilities *

    *
  • caches configuration settings (immutably) - *
  • caches "compiled" mappings ie. EntityPersisters and - * CollectionPersisters (immutable) + *
  • caches "compiled" mappings ie. {@code EntityPersister}s and + * {@code CollectionPersister}s (immutable) *
  • caches "compiled" queries (memory sensitive cache) - *
  • manages PreparedStatements - *
  • delegates JDBC Connection management to the ConnectionProvider - *
  • factory for instances of SessionImpl + *
  • manages {@code PreparedStatement}s + *
  • delegates JDBC {@code Connection} management to the {@code ConnectionProvider} + *
  • factory for instances of {@code SessionImpl} *
* This class must appear immutable to clients, even if it does all kinds of caching * and pooling under the covers. It is crucial that the class is not only thread diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/BoundedConcurrentHashMap.java b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/BoundedConcurrentHashMap.java index ed1b9870ed..86a39fba1d 100644 --- a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/BoundedConcurrentHashMap.java +++ b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/BoundedConcurrentHashMap.java @@ -45,19 +45,19 @@ import static java.util.Collections.unmodifiableMap; * adjustable expected concurrency for updates. This class obeys the * same functional specification as {@link java.util.Hashtable}, and * includes versions of methods corresponding to each method of - * Hashtable. However, even though all operations are + * {@code Hashtable}. However, even though all operations are * thread-safe, retrieval operations do not entail locking, * and there is not any support for locking the entire table * in a way that prevents all access. This class is fully - * interoperable with Hashtable in programs that rely on its + * interoperable with {@code Hashtable} in programs that rely on its * thread safety but not on its synchronization details. *

- *

Retrieval operations (including get) generally do not + *

Retrieval operations (including {@code get}) generally do not * block, so may overlap with update operations (including - * put and remove). Retrievals reflect the results + * {@code put} and {@code remove}). Retrievals reflect the results * of the most recently completed update operations holding - * upon their onset. For aggregate operations such as putAll - * and clear, concurrent retrievals may reflect insertion or + * upon their onset. For aggregate operations such as {@code putAll} + * and {@code clear}, concurrent retrievals may reflect insertion or * removal of only some entries. Similarly, Iterators and * Enumerations return elements reflecting the state of the hash table * at some point at or since the creation of the iterator/enumeration. @@ -65,8 +65,8 @@ import static java.util.Collections.unmodifiableMap; * However, iterators are designed to be used by only one thread at a time. *

*

The allowed concurrency among update operations is guided by - * the optional concurrencyLevel constructor argument - * (default 16), which is used as a hint for internal sizing. The + * the optional {@code concurrencyLevel} constructor argument + * (default {@code 16}), which is used as a hint for internal sizing. The * table is internally partitioned to try to permit the indicated * number of concurrent updates without contention. Because placement * in hash tables is essentially random, the actual concurrency will @@ -93,7 +93,7 @@ import static java.util.Collections.unmodifiableMap; *

*

*

Like {@link java.util.Hashtable} but unlike {@link HashMap}, this class - * does not allow null to be used as a key or value. + * does not allow {@code null} to be used as a key or value. * * @param the type of keys maintained by this map * @param the type of mapped values @@ -1195,8 +1195,8 @@ public class BoundedConcurrentHashMap extends AbstractMap /** * The table is rehashed when its size exceeds this threshold. - * (The value of this field is always (int)(capacity * - * loadFactor).) + * (The value of this field is always {@code (int)(capacity * + * loadFactor)}.) */ transient int threshold; @@ -1733,9 +1733,9 @@ public class BoundedConcurrentHashMap extends AbstractMap } /** - * Returns true if this map contains no key-value mappings. + * Returns {@code true} if this map contains no key-value mappings. * - * @return true if this map contains no key-value mappings + * @return {@code true} if this map contains no key-value mappings */ @Override public boolean isEmpty() { @@ -1774,8 +1774,8 @@ public class BoundedConcurrentHashMap extends AbstractMap /** * Returns the number of key-value mappings in this map. If the - * map contains more than Integer.MAX_VALUE elements, returns - * Integer.MAX_VALUE. + * map contains more than {@code Integer.MAX_VALUE} elements, returns + * {@code Integer.MAX_VALUE}. * * @return the number of key-value mappings in this map */ @@ -1854,9 +1854,9 @@ public class BoundedConcurrentHashMap extends AbstractMap * * @param key possible key * - * @return true if and only if the specified object + * @return {@code true} if and only if the specified object * is a key in this table, as determined by the - * equals method; false otherwise. + * {@code equals} method; {@code false} otherwise. * * @throws NullPointerException if the specified key is null */ @@ -1867,14 +1867,14 @@ public class BoundedConcurrentHashMap extends AbstractMap } /** - * Returns true if this map maps one or more keys to the + * Returns {@code true} if this map maps one or more keys to the * specified value. Note: This method requires a full internal * traversal of the hash table, and so is much slower than - * method containsKey. + * method {@code containsKey}. * * @param value value whose presence in this map is to be tested * - * @return true if this map maps one or more keys to the + * @return {@code true} if this map maps one or more keys to the * specified value * * @throws NullPointerException if the specified value is null @@ -1947,10 +1947,10 @@ public class BoundedConcurrentHashMap extends AbstractMap * * @param value a value to search for * - * @return true if and only if some key maps to the - * value argument in this table as - * determined by the equals method; - * false otherwise + * @return {@code true} if and only if some key maps to the + * {@code value} argument in this table as + * determined by the {@code equals} method; + * {@code false} otherwise * * @throws NullPointerException if the specified value is null */ @@ -1962,14 +1962,14 @@ public class BoundedConcurrentHashMap extends AbstractMap * Maps the specified key to the specified value in this table. * Neither the key nor the value can be null. *

- *

The value can be retrieved by calling the get method + *

The value can be retrieved by calling the {@code get} method * with a key that is equal to the original key. * * @param key key with which the specified value is to be associated * @param value value to be associated with the specified key * - * @return the previous value associated with key, or - * null if there was no mapping for key + * @return the previous value associated with {@code key}, or + * {@code null} if there was no mapping for {@code key} * * @throws NullPointerException if the specified key or value is null */ @@ -1986,7 +1986,7 @@ public class BoundedConcurrentHashMap extends AbstractMap * {@inheritDoc} * * @return the previous value associated with the specified key, - * or null if there was no mapping for the key + * or {@code null} if there was no mapping for the key * * @throws NullPointerException if the specified key or value is null */ @@ -2019,8 +2019,8 @@ public class BoundedConcurrentHashMap extends AbstractMap * * @param key the key that needs to be removed * - * @return the previous value associated with key, or - * null if there was no mapping for key + * @return the previous value associated with {@code key}, or + * {@code null} if there was no mapping for {@code key} * * @throws NullPointerException if the specified key is null */ @@ -2062,7 +2062,7 @@ public class BoundedConcurrentHashMap extends AbstractMap * {@inheritDoc} * * @return the previous value associated with the specified key, - * or null if there was no mapping for the key + * or {@code null} if there was no mapping for the key * * @throws NullPointerException if the specified key or value is null */ @@ -2090,12 +2090,12 @@ public class BoundedConcurrentHashMap extends AbstractMap * The set is backed by the map, so changes to the map are * reflected in the set, and vice-versa. The set supports element * removal, which removes the corresponding mapping from this map, - * via the Iterator.remove, Set.remove, - * removeAll, retainAll, and clear - * operations. It does not support the add or - * addAll operations. + * via the {@code Iterator.remove}, {@code Set.remove}, + * {@code removeAll}, {@code retainAll}, and {@code clear} + * operations. It does not support the {@code add} or + * {@code addAll} operations. *

- *

The view's iterator is a "weakly consistent" iterator + *

The view's {@code iterator} is a "weakly consistent" iterator * that will never throw {@link java.util.ConcurrentModificationException}, * and guarantees to traverse elements as they existed upon * construction of the iterator, and may (but is not guaranteed to) @@ -2112,12 +2112,12 @@ public class BoundedConcurrentHashMap extends AbstractMap * The collection is backed by the map, so changes to the map are * reflected in the collection, and vice-versa. The collection * supports element removal, which removes the corresponding - * mapping from this map, via the Iterator.remove, - * Collection.remove, removeAll, - * retainAll, and clear operations. It does not - * support the add or addAll operations. + * mapping from this map, via the {@code Iterator.remove}, + * {@code Collection.remove}, {@code removeAll}, + * {@code retainAll}, and {@code clear} operations. It does not + * support the {@code add} or {@code addAll} operations. *

- *

The view's iterator is a "weakly consistent" iterator + *

The view's {@code iterator} is a "weakly consistent" iterator * that will never throw {@link java.util.ConcurrentModificationException}, * and guarantees to traverse elements as they existed upon * construction of the iterator, and may (but is not guaranteed to) @@ -2134,12 +2134,12 @@ public class BoundedConcurrentHashMap extends AbstractMap * The set is backed by the map, so changes to the map are * reflected in the set, and vice-versa. The set supports element * removal, which removes the corresponding mapping from the map, - * via the Iterator.remove, Set.remove, - * removeAll, retainAll, and clear - * operations. It does not support the add or - * addAll operations. + * via the {@code Iterator.remove}, {@code Set.remove}, + * {@code removeAll}, {@code retainAll}, and {@code clear} + * operations. It does not support the {@code add} or + * {@code addAll} operations. *

- *

The view's iterator is a "weakly consistent" iterator + *

The view's {@code iterator} is a "weakly consistent" iterator * that will never throw {@link java.util.ConcurrentModificationException}, * and guarantees to traverse elements as they existed upon * construction of the iterator, and may (but is not guaranteed to) @@ -2410,7 +2410,7 @@ public class BoundedConcurrentHashMap extends AbstractMap /* ---------------- Serialization Support -------------- */ /** - * Save the state of the ConcurrentHashMap instance to a + * Save the state of the {@code ConcurrentHashMap} instance to a * stream (i.e., serialize it). * * @param s the stream @@ -2443,7 +2443,7 @@ public class BoundedConcurrentHashMap extends AbstractMap } /** - * Reconstitute the ConcurrentHashMap instance from a + * Reconstitute the {@code ConcurrentHashMap} instance from a * stream (i.e., deserialize it). * * @param s the stream diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/ConcurrentReferenceHashMap.java b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/ConcurrentReferenceHashMap.java index 94a9cfd00a..da69b03b9a 100644 --- a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/ConcurrentReferenceHashMap.java +++ b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/ConcurrentReferenceHashMap.java @@ -49,8 +49,8 @@ import java.util.concurrent.locks.ReentrantLock; * discarded by the garbage collector. Once a key has been discarded by the * collector, the corresponding entry is no longer visible to this table; * however, the entry may occupy space until a future table operation decides to - * reclaim it. For this reason, summary functions such as size and - * isEmpty might return a value greater than the observed number of + * reclaim it. For this reason, summary functions such as {@code size} and + * {@code isEmpty} might return a value greater than the observed number of * entries. In order to support a high level of concurrency, stale entries are * only reclaimed during blocking (usually mutating) operations. *

@@ -75,19 +75,19 @@ import java.util.concurrent.locks.ReentrantLock; * Just like {@link java.util.concurrent.ConcurrentHashMap}, this class obeys * the same functional specification as {@link java.util.Hashtable}, and * includes versions of methods corresponding to each method of - * Hashtable. However, even though all operations are thread-safe, + * {@code Hashtable}. However, even though all operations are thread-safe, * retrieval operations do not entail locking, and there is * not any support for locking the entire table in a way that * prevents all access. This class is fully interoperable with - * Hashtable in programs that rely on its thread safety but not on + * {@code Hashtable} in programs that rely on its thread safety but not on * its synchronization details. *

*

- * Retrieval operations (including get) generally do not block, so - * may overlap with update operations (including put and - * remove). Retrievals reflect the results of the most recently + * Retrieval operations (including {@code get}) generally do not block, so + * may overlap with update operations (including {@code put} and + * {@code remove}). Retrievals reflect the results of the most recently * completed update operations holding upon their onset. For - * aggregate operations such as putAll and clear, + * aggregate operations such as {@code putAll} and {@code clear}, * concurrent retrievals may reflect insertion or removal of only some entries. * Similarly, Iterators and Enumerations return elements reflecting the state of * the hash table at some point at or since the creation of the @@ -97,7 +97,7 @@ import java.util.concurrent.locks.ReentrantLock; *

*

* The allowed concurrency among update operations is guided by the optional - * concurrencyLevel constructor argument (default 16), + * {@code concurrencyLevel} constructor argument (default {@code 16}), * which is used as a hint for internal sizing. The table is internally * partitioned to try to permit the indicated number of concurrent updates * without contention. Because placement in hash tables is essentially random, @@ -118,7 +118,7 @@ import java.util.concurrent.locks.ReentrantLock; *

*

* Like {@link java.util.Hashtable} but unlike {@link java.util.HashMap}, this class does - * not allow null to be used as a key or value. + * not allow {@code null} to be used as a key or value. *

*

* This class is a member of the @@ -518,8 +518,8 @@ public class ConcurrentReferenceHashMap extends AbstractMap /** * The table is rehashed when its size exceeds this threshold. - * (The value of this field is always (int)(capacity * - * loadFactor).) + * (The value of this field is always {@code (int)(capacity * + * loadFactor)}.) */ transient int threshold; @@ -1078,9 +1078,9 @@ public class ConcurrentReferenceHashMap extends AbstractMap } /** - * Returns true if this map contains no key-value mappings. + * Returns {@code true} if this map contains no key-value mappings. * - * @return true if this map contains no key-value mappings + * @return {@code true} if this map contains no key-value mappings */ @Override public boolean isEmpty() { @@ -1120,8 +1120,8 @@ public class ConcurrentReferenceHashMap extends AbstractMap /** * Returns the number of key-value mappings in this map. If the - * map contains more than Integer.MAX_VALUE elements, returns - * Integer.MAX_VALUE. + * map contains more than {@code Integer.MAX_VALUE} elements, returns + * {@code Integer.MAX_VALUE}. * * @return the number of key-value mappings in this map */ @@ -1199,9 +1199,9 @@ public class ConcurrentReferenceHashMap extends AbstractMap * * @param key possible key * - * @return true if and only if the specified object + * @return {@code true} if and only if the specified object * is a key in this table, as determined by the - * equals method; false otherwise. + * {@code equals} method; {@code false} otherwise. * * @throws NullPointerException if the specified key is null */ @@ -1215,14 +1215,14 @@ public class ConcurrentReferenceHashMap extends AbstractMap } /** - * Returns true if this map maps one or more keys to the + * Returns {@code true} if this map maps one or more keys to the * specified value. Note: This method requires a full internal * traversal of the hash table, and so is much slower than - * method containsKey. + * method {@code containsKey}. * * @param value value whose presence in this map is to be tested * - * @return true if this map maps one or more keys to the + * @return {@code true} if this map maps one or more keys to the * specified value */ @Override @@ -1292,10 +1292,10 @@ public class ConcurrentReferenceHashMap extends AbstractMap * * @param value a value to search for * - * @return true if and only if some key maps to the - * value argument in this table as - * determined by the equals method; - * false otherwise + * @return {@code true} if and only if some key maps to the + * {@code value} argument in this table as + * determined by the {@code equals} method; + * {@code false} otherwise * * @throws NullPointerException if the specified value is null */ @@ -1307,14 +1307,14 @@ public class ConcurrentReferenceHashMap extends AbstractMap * Maps the specified key to the specified value in this table. * Neither the key nor the value can be null. *

- *

The value can be retrieved by calling the get method + *

The value can be retrieved by calling the {@code get} method * with a key that is equal to the original key. * * @param key key with which the specified value is to be associated * @param value value to be associated with the specified key * - * @return the previous value associated with key, or - * null if there was no mapping for key + * @return the previous value associated with {@code key}, or + * {@code null} if there was no mapping for {@code key} * * @throws NullPointerException if the specified key or value is null */ @@ -1331,7 +1331,7 @@ public class ConcurrentReferenceHashMap extends AbstractMap * {@inheritDoc} * * @return the previous value associated with the specified key, - * or null if there was no mapping for the key + * or {@code null} if there was no mapping for the key * * @throws NullPointerException if the specified key or value is null */ @@ -1364,8 +1364,8 @@ public class ConcurrentReferenceHashMap extends AbstractMap * * @param key the key that needs to be removed * - * @return the previous value associated with key, or - * null if there was no mapping for key + * @return the previous value associated with {@code key}, or + * {@code null} if there was no mapping for {@code key} * * @throws NullPointerException if the specified key is null */ @@ -1410,7 +1410,7 @@ public class ConcurrentReferenceHashMap extends AbstractMap * {@inheritDoc} * * @return the previous value associated with the specified key, - * or null if there was no mapping for the key + * or {@code null} if there was no mapping for the key * * @throws NullPointerException if the specified key or value is null */ @@ -1456,12 +1456,12 @@ public class ConcurrentReferenceHashMap extends AbstractMap * The set is backed by the map, so changes to the map are * reflected in the set, and vice-versa. The set supports element * removal, which removes the corresponding mapping from this map, - * via the Iterator.remove, Set.remove, - * removeAll, retainAll, and clear - * operations. It does not support the add or - * addAll operations. + * via the {@code Iterator.remove}, {@code Set.remove}, + * {@code removeAll}, {@code retainAll}, and {@code clear} + * operations. It does not support the {@code add} or + * {@code addAll} operations. *

- *

The view's iterator is a "weakly consistent" iterator + *

The view's {@code iterator} is a "weakly consistent" iterator * that will never throw {@link java.util.ConcurrentModificationException}, * and guarantees to traverse elements as they existed upon * construction of the iterator, and may (but is not guaranteed to) @@ -1478,12 +1478,12 @@ public class ConcurrentReferenceHashMap extends AbstractMap * The collection is backed by the map, so changes to the map are * reflected in the collection, and vice-versa. The collection * supports element removal, which removes the corresponding - * mapping from this map, via the Iterator.remove, - * Collection.remove, removeAll, - * retainAll, and clear operations. It does not - * support the add or addAll operations. + * mapping from this map, via the {@code Iterator.remove}, + * {@code Collection.remove}, {@code removeAll}, + * {@code retainAll}, and {@code clear} operations. It does not + * support the {@code add} or {@code addAll} operations. *

- *

The view's iterator is a "weakly consistent" iterator + *

The view's {@code iterator} is a "weakly consistent" iterator * that will never throw {@link java.util.ConcurrentModificationException}, * and guarantees to traverse elements as they existed upon * construction of the iterator, and may (but is not guaranteed to) @@ -1500,12 +1500,12 @@ public class ConcurrentReferenceHashMap extends AbstractMap * The set is backed by the map, so changes to the map are * reflected in the set, and vice-versa. The set supports element * removal, which removes the corresponding mapping from the map, - * via the Iterator.remove, Set.remove, - * removeAll, retainAll, and clear - * operations. It does not support the add or - * addAll operations. + * via the {@code Iterator.remove}, {@code Set.remove}, + * {@code removeAll}, {@code retainAll}, and {@code clear} + * operations. It does not support the {@code add} or + * {@code addAll} operations. *

- *

The view's iterator is a "weakly consistent" iterator + *

The view's {@code iterator} is a "weakly consistent" iterator * that will never throw {@link java.util.ConcurrentModificationException}, * and guarantees to traverse elements as they existed upon * construction of the iterator, and may (but is not guaranteed to) @@ -1853,7 +1853,7 @@ public class ConcurrentReferenceHashMap extends AbstractMap /* ---------------- Serialization Support -------------- */ /** - * Save the state of the ConcurrentReferenceHashMap instance to a + * Save the state of the {@code ConcurrentReferenceHashMap} instance to a * stream (i.e., serialize it). * * @param s the stream @@ -1892,7 +1892,7 @@ public class ConcurrentReferenceHashMap extends AbstractMap } /** - * Reconstitute the ConcurrentReferenceHashMap instance from a + * Reconstitute the {@code ConcurrentReferenceHashMap} instance from a * stream (i.e., deserialize it). * * @param s the stream diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/IdentityMap.java b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/IdentityMap.java index 8bec05efe0..77d933b502 100644 --- a/hibernate-core/src/main/java/org/hibernate/internal/util/collections/IdentityMap.java +++ b/hibernate-core/src/main/java/org/hibernate/internal/util/collections/IdentityMap.java @@ -17,8 +17,8 @@ import java.util.function.BiConsumer; import java.util.function.Consumer; /** - * A Map where keys are compared by object identity, - * rather than equals(). + * A {@code Map} where keys are compared by object identity, + * rather than {@code equals()}. */ public final class IdentityMap implements Map { @@ -47,9 +47,9 @@ public final class IdentityMap implements Map { } /** - * Return the map entries (as instances of Map.Entry in a collection that + * Return the map entries (as instances of {@code Map.Entry} in a collection that * is safe from concurrent modification). ie. we may safely add new instances to - * the underlying Map during iteration of the entries(). + * the underlying {@code Map} during iteration of the {@code entries()}. * * @param map The map of entries * @return Collection diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/config/ConfigurationHelper.java b/hibernate-core/src/main/java/org/hibernate/internal/util/config/ConfigurationHelper.java index a0af1ddaa5..4bca5fde8f 100644 --- a/hibernate-core/src/main/java/org/hibernate/internal/util/config/ConfigurationHelper.java +++ b/hibernate-core/src/main/java/org/hibernate/internal/util/config/ConfigurationHelper.java @@ -303,7 +303,7 @@ public final class ConfigurationHelper { /** * Extract a property value by name from the given properties object. *

- * Both null and empty string are viewed as the same, and return null. + * Both {@code null} and {@code empty string} are viewed as the same, and return null. * * @param propertyName The name of the property for which to extract value * @param properties The properties object @@ -323,7 +323,7 @@ public final class ConfigurationHelper { /** * Extract a property value by name from the given properties object. *

- * Both null and empty string are viewed as the same, and return null. + * Both {@code null} and {@code empty string} are viewed as the same, and return null. * * @param propertyName The name of the property for which to extract value * @param properties The properties object diff --git a/hibernate-core/src/main/java/org/hibernate/internal/util/xml/DTDEntityResolver.java b/hibernate-core/src/main/java/org/hibernate/internal/util/xml/DTDEntityResolver.java index a83bfd41fa..932fef085e 100644 --- a/hibernate-core/src/main/java/org/hibernate/internal/util/xml/DTDEntityResolver.java +++ b/hibernate-core/src/main/java/org/hibernate/internal/util/xml/DTDEntityResolver.java @@ -20,11 +20,11 @@ import org.xml.sax.InputSource; /** * An {@link EntityResolver} implementation which attempts to resolve * various systemId URLs to local classpath look ups

    - *
  1. Any systemId URL beginning with http://www.hibernate.org/dtd/ is + *
  2. Any systemId URL beginning with {@code http://www.hibernate.org/dtd/} is * searched for as a classpath resource in the classloader which loaded the * Hibernate classes.
    3. - *
  3. Any systemId URL using classpath as the scheme (i.e. starting - * with classpath:// is searched for as a classpath resource using first + *
  4. Any systemId URL using {@code classpath} as the scheme (i.e. starting + * with {@code classpath://} is searched for as a classpath resource using first * the current thread context classloader and then the classloader which loaded * the Hibernate classes. *
diff --git a/hibernate-core/src/main/java/org/hibernate/mapping/IdentifierBag.java b/hibernate-core/src/main/java/org/hibernate/mapping/IdentifierBag.java index 7aea4b2539..f6bc4df62c 100644 --- a/hibernate-core/src/main/java/org/hibernate/mapping/IdentifierBag.java +++ b/hibernate-core/src/main/java/org/hibernate/mapping/IdentifierBag.java @@ -13,7 +13,7 @@ import org.hibernate.type.CollectionType; import org.hibernate.type.IdentifierBagType; /** - * An IdentifierBag has a primary key consisting of + * An {@code IdentifierBag} has a primary key consisting of * just the identifier column */ public class IdentifierBag extends IdentifierCollection { diff --git a/hibernate-core/src/main/java/org/hibernate/metadata/ClassMetadata.java b/hibernate-core/src/main/java/org/hibernate/metadata/ClassMetadata.java index f8fa1ed76b..ed8f3993e3 100644 --- a/hibernate-core/src/main/java/org/hibernate/metadata/ClassMetadata.java +++ b/hibernate-core/src/main/java/org/hibernate/metadata/ClassMetadata.java @@ -257,7 +257,7 @@ public interface ClassMetadata { /** - * Does the class implement the Lifecycle interface? + * Does the class implement the {@code Lifecycle} interface? */ @SuppressWarnings( {"UnusedDeclaration"}) boolean implementsLifecycle(); diff --git a/hibernate-core/src/main/java/org/hibernate/persister/collection/AbstractCollectionPersister.java b/hibernate-core/src/main/java/org/hibernate/persister/collection/AbstractCollectionPersister.java index e97a00e62d..60ba283c0c 100644 --- a/hibernate-core/src/main/java/org/hibernate/persister/collection/AbstractCollectionPersister.java +++ b/hibernate-core/src/main/java/org/hibernate/persister/collection/AbstractCollectionPersister.java @@ -135,7 +135,7 @@ import org.hibernate.type.Type; import org.jboss.logging.Logger; /** - * Base implementation of the QueryableCollection interface. + * Base implementation of the {@code QueryableCollection} interface. * * @author Gavin King * @see BasicCollectionPersister @@ -1017,7 +1017,7 @@ public abstract class AbstractCollectionPersister } /** - * Write the key to a JDBC PreparedStatement + * Write the key to a JDBC {@code PreparedStatement} */ protected int writeKey(PreparedStatement st, Object key, int i, SharedSessionContractImplementor session) throws HibernateException, SQLException { @@ -1030,7 +1030,7 @@ public abstract class AbstractCollectionPersister } /** - * Write the element to a JDBC PreparedStatement + * Write the element to a JDBC {@code PreparedStatement} */ protected int writeElement(PreparedStatement st, Object elt, int i, SharedSessionContractImplementor session) throws HibernateException, SQLException { @@ -1049,7 +1049,7 @@ public abstract class AbstractCollectionPersister } /** - * Write the index to a JDBC PreparedStatement + * Write the index to a JDBC {@code PreparedStatement} */ protected int writeIndex(PreparedStatement st, Object index, int i, SharedSessionContractImplementor session) throws HibernateException, SQLException { @@ -1074,7 +1074,7 @@ public abstract class AbstractCollectionPersister } /** - * Write the element to a JDBC PreparedStatement + * Write the element to a JDBC {@code PreparedStatement} */ protected int writeElementToWhere(PreparedStatement st, Object elt, int i, SharedSessionContractImplementor session) throws HibernateException, SQLException { @@ -1093,7 +1093,7 @@ public abstract class AbstractCollectionPersister } /** - * Write the index to a JDBC PreparedStatement + * Write the index to a JDBC {@code PreparedStatement} */ protected int writeIndexToWhere(PreparedStatement st, Object index, int i, SharedSessionContractImplementor session) throws HibernateException, SQLException { @@ -1111,7 +1111,7 @@ public abstract class AbstractCollectionPersister } /** - * Write the identifier to a JDBC PreparedStatement + * Write the identifier to a JDBC {@code PreparedStatement} */ public int writeIdentifier(PreparedStatement st, Object id, int i, SharedSessionContractImplementor session) throws HibernateException, SQLException { diff --git a/hibernate-core/src/main/java/org/hibernate/persister/collection/CollectionPersister.java b/hibernate-core/src/main/java/org/hibernate/persister/collection/CollectionPersister.java index e5f33d0288..a1469dee6a 100644 --- a/hibernate-core/src/main/java/org/hibernate/persister/collection/CollectionPersister.java +++ b/hibernate-core/src/main/java/org/hibernate/persister/collection/CollectionPersister.java @@ -46,7 +46,7 @@ import org.hibernate.type.Type; * Implements persistence of a collection instance while the instance is * referenced in a particular role. *

- * This class is highly coupled to the PersistentCollection + * This class is highly coupled to the {@code PersistentCollection} * hierarchy, since double dispatch is used to load and update collection * elements. *

@@ -95,7 +95,7 @@ public interface CollectionPersister extends CollectionDefinition, Restrictable */ CacheEntryStructure getCacheEntryStructure(); /** - * Get the associated Type + * Get the associated {@code Type} */ CollectionType getCollectionType(); /** diff --git a/hibernate-core/src/main/java/org/hibernate/persister/collection/QueryableCollection.java b/hibernate-core/src/main/java/org/hibernate/persister/collection/QueryableCollection.java index 111c56d723..62dd817cb2 100644 --- a/hibernate-core/src/main/java/org/hibernate/persister/collection/QueryableCollection.java +++ b/hibernate-core/src/main/java/org/hibernate/persister/collection/QueryableCollection.java @@ -68,7 +68,7 @@ public interface QueryableCollection extends PropertyMapping, Joinable, Collecti * Get the persister of the element class, if this is a * collection of entities (optional operation). Note that * for a one-to-many association, the returned persister - * must be OuterJoinLoadable. + * must be {@code OuterJoinLoadable}. */ public abstract EntityPersister getElementPersister(); /** diff --git a/hibernate-core/src/main/java/org/hibernate/persister/entity/AbstractEntityPersister.java b/hibernate-core/src/main/java/org/hibernate/persister/entity/AbstractEntityPersister.java index dc173807e4..eb2d2e1043 100644 --- a/hibernate-core/src/main/java/org/hibernate/persister/entity/AbstractEntityPersister.java +++ b/hibernate-core/src/main/java/org/hibernate/persister/entity/AbstractEntityPersister.java @@ -4200,16 +4200,16 @@ public abstract class AbstractEntityPersister } /** - * Load an instance using either the forUpdateLoader or the outer joining loader, - * depending upon the value of the lock parameter + * Load an instance using either the {@code forUpdateLoader} or the outer joining {@code loader}, + * depending upon the value of the {@code lock} parameter */ public Object load(Object id, Object optionalObject, LockMode lockMode, SharedSessionContractImplementor session) { return load( id, optionalObject, new LockOptions().setLockMode( lockMode ), session ); } /** - * Load an instance using either the forUpdateLoader or the outer joining loader, - * depending upon the value of the lock parameter + * Load an instance using either the {@code forUpdateLoader} or the outer joining {@code loader}, + * depending upon the value of the {@code lock} parameter */ public Object load(Object id, Object optionalObject, LockOptions lockOptions, SharedSessionContractImplementor session) throws HibernateException { @@ -4423,7 +4423,7 @@ public abstract class AbstractEntityPersister * @param entity The entity for which we are checking state dirtiness. * @param session The session in which the check is occurring. * - * @return null or the indices of the dirty properties + * @return {@code null} or the indices of the dirty properties * * @throws HibernateException */ @@ -4453,7 +4453,7 @@ public abstract class AbstractEntityPersister * @param entity The entity for which we are checking state modification. * @param session The session in which the check is occurring. * - * @return null or the indices of the modified properties + * @return {@code null} or the indices of the modified properties * * @throws HibernateException */ diff --git a/hibernate-core/src/main/java/org/hibernate/persister/entity/EntityPersister.java b/hibernate-core/src/main/java/org/hibernate/persister/entity/EntityPersister.java index f4acf09239..c3babacea7 100644 --- a/hibernate-core/src/main/java/org/hibernate/persister/entity/EntityPersister.java +++ b/hibernate-core/src/main/java/org/hibernate/persister/entity/EntityPersister.java @@ -893,12 +893,12 @@ public interface EntityPersister * However, we still need to account for possible subclassing and potentially re-route to the more appropriate * persister. *

- * For example, a request names Animal as the entity-name which gets resolved to this persister. But the - * actual instance is really an instance of Cat which is a subclass of Animal. So, here the - * Animal persister is being asked to return the persister specific to Cat. + * For example, a request names {@code Animal} as the entity-name which gets resolved to this persister. But the + * actual instance is really an instance of {@code Cat} which is a subclass of {@code Animal}. So, here the + * {@code Animal} persister is being asked to return the persister specific to {@code Cat}. *

- * It is also possible that the instance is actually an Animal instance in the above example in which - * case we would return this from this method. + * It is also possible that the instance is actually an {@code Animal} instance in the above example in which + * case we would return {@code this} from this method. * * @param instance The entity instance * @param factory Reference to the SessionFactory diff --git a/hibernate-core/src/main/java/org/hibernate/persister/entity/JoinedSubclassEntityPersister.java b/hibernate-core/src/main/java/org/hibernate/persister/entity/JoinedSubclassEntityPersister.java index 43d5b4e1f8..bb760e1d71 100644 --- a/hibernate-core/src/main/java/org/hibernate/persister/entity/JoinedSubclassEntityPersister.java +++ b/hibernate-core/src/main/java/org/hibernate/persister/entity/JoinedSubclassEntityPersister.java @@ -72,7 +72,7 @@ import org.jboss.logging.Logger; import static java.util.Collections.emptyMap; /** - * An EntityPersister implementing the normalized "table-per-subclass" + * An {@code EntityPersister} implementing the normalized "table-per-subclass" * mapping strategy * * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/persister/entity/Loadable.java b/hibernate-core/src/main/java/org/hibernate/persister/entity/Loadable.java index 8240284d45..a03b55f005 100644 --- a/hibernate-core/src/main/java/org/hibernate/persister/entity/Loadable.java +++ b/hibernate-core/src/main/java/org/hibernate/persister/entity/Loadable.java @@ -14,8 +14,8 @@ import org.hibernate.engine.spi.SharedSessionContractImplementor; import org.hibernate.type.Type; /** - * Implemented by a EntityPersister that may be loaded - * using Loader. + * Implemented by a {@code EntityPersister} that may be loaded + * using {@code Loader}. * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/persister/entity/OuterJoinLoadable.java b/hibernate-core/src/main/java/org/hibernate/persister/entity/OuterJoinLoadable.java index 8e2d4849bf..b2817fe6e7 100644 --- a/hibernate-core/src/main/java/org/hibernate/persister/entity/OuterJoinLoadable.java +++ b/hibernate-core/src/main/java/org/hibernate/persister/entity/OuterJoinLoadable.java @@ -11,8 +11,8 @@ import org.hibernate.type.EntityType; import org.hibernate.type.Type; /** - * A EntityPersister that may be loaded by outer join using - * the OuterJoinLoader hierarchy and may be an element + * A {@code EntityPersister} that may be loaded by outer join using + * the {@code OuterJoinLoader} hierarchy and may be an element * of a one-to-many association. * * @see org.hibernate.loader.OuterJoinLoader diff --git a/hibernate-core/src/main/java/org/hibernate/persister/entity/Queryable.java b/hibernate-core/src/main/java/org/hibernate/persister/entity/Queryable.java index 26d3fdcb7b..d62b7e7619 100644 --- a/hibernate-core/src/main/java/org/hibernate/persister/entity/Queryable.java +++ b/hibernate-core/src/main/java/org/hibernate/persister/entity/Queryable.java @@ -7,7 +7,7 @@ package org.hibernate.persister.entity; /** - * Extends the generic EntityPersister contract to add + * Extends the generic {@code EntityPersister} contract to add * operations required by the Hibernate Query Language * * @author Gavin King diff --git a/hibernate-core/src/main/java/org/hibernate/persister/entity/SingleTableEntityPersister.java b/hibernate-core/src/main/java/org/hibernate/persister/entity/SingleTableEntityPersister.java index 0ea9e3406a..1ac0093c1a 100644 --- a/hibernate-core/src/main/java/org/hibernate/persister/entity/SingleTableEntityPersister.java +++ b/hibernate-core/src/main/java/org/hibernate/persister/entity/SingleTableEntityPersister.java @@ -67,7 +67,7 @@ import org.hibernate.type.Type; import org.hibernate.type.descriptor.java.JavaType; /** - * The default implementation of the EntityPersister interface. + * The default implementation of the {@code EntityPersister} interface. * Implements the "table-per-class-hierarchy" or "roll-up" mapping strategy * for an entity class and its inheritance hierarchy. This is implemented * as a single table holding all classes in the hierarchy with a discriminator diff --git a/hibernate-core/src/main/java/org/hibernate/query/Query.java b/hibernate-core/src/main/java/org/hibernate/query/Query.java index 15a32f88f0..6a1077bb4f 100644 --- a/hibernate-core/src/main/java/org/hibernate/query/Query.java +++ b/hibernate-core/src/main/java/org/hibernate/query/Query.java @@ -120,9 +120,9 @@ public interface Query extends TypedQuery, CommonQueryContract { ScrollableResults scroll(ScrollMode scrollMode); /** - * Return the query results as a List. If the query contains + * Return the query results as a {@code List}. If the query contains * multiple results per row, the results are returned in an instance - * of Object[]. + * of {@code Object[]}. * * @return the result list */ @@ -140,7 +140,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * Convenience method to return a single instance that matches * the query, or {@code null} if the query returns no results. * - * @return the single result or null + * @return the single result or {@code null} * * @throws NonUniqueResultException if there is more than one matching result */ @@ -228,7 +228,7 @@ public interface Query extends TypedQuery, CommonQueryContract { Query setLockOptions(LockOptions lockOptions); /** - * Set the LockMode to use for specific alias (as defined in the query's FROM clause). + * Set the LockMode to use for specific alias (as defined in the query's {@code FROM} clause). *

* The alias-specific lock modes specified here are added to the query's internal * {@link #getLockOptions() LockOptions}. @@ -298,7 +298,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * Bind a value to a JDBC-style query parameter. * * @param position the position of the parameter in the query - * string, numbered from 0. + * string, numbered from {@code 0}. * @param val the possibly-null parameter value * @param type the Hibernate allowable parameter type * @@ -321,7 +321,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * Bind a value to a JDBC-style query parameter. * * @param position the position of the parameter in the query - * string, numbered from 0. + * string, numbered from {@code 0}. * @param val the possibly-null parameter value * @param type the Hibernate allowable parameter type * @@ -346,7 +346,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * the indicated temporal-type. * * @param position the position of the parameter in the query - * string, numbered from 0. + * string, numbered from {@code 0}. * @param val the possibly-null parameter value * @param temporalType the temporal-type to use in binding the date/time * @@ -486,7 +486,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * should be used instead * * @param position the position of the parameter in the query - * string, numbered from 0. + * string, numbered from {@code 0}. * @param value the possibly-null parameter value * * @return {@code this}, for method chaining @@ -521,7 +521,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * Bind multiple values to a query parameter using its inferred Type. The Hibernate type of the parameter values is * first detected via the usage/position in the query and if not sufficient secondly * guessed from the class of the first object in the collection. This is useful for binding a list of values - * to an expression such as foo.bar in (:value_list). + * to an expression such as {@code foo.bar in (:value_list)}. * * @param parameter the parameter memento * @param values a collection of values to list @@ -534,7 +534,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * Bind multiple values to a named query parameter. The Hibernate type of the parameter is * first detected via the usage/position in the query and if not sufficient secondly * guessed from the class of the first object in the collection. This is useful for binding a list of values - * to an expression such as foo.bar in (:value_list). + * to an expression such as {@code foo.bar in (:value_list)}. * * @param name the name of the parameter * @param values a collection of values to list @@ -547,7 +547,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * Bind multiple values to a positional query parameter. The Hibernate type of the parameter is * first detected via the usage/position in the query and if not sufficient secondly * guessed from the class of the first object in the collection. This is useful for binding a list of values - * to an expression such as foo.bar in (:value_list). + * to an expression such as {@code foo.bar in (:value_list)}. * * @param position the parameter positional label * @param values a collection of values to list @@ -560,7 +560,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * Bind multiple values to a named query parameter. The Hibernate type of the parameter is * first detected via the usage/position in the query and if not sufficient secondly * guessed from the class of the first object in the collection. This is useful for binding a list of values - * to an expression such as foo.bar in (:value_list). + * to an expression such as {@code foo.bar in (:value_list)}. * * @param name the name of the parameter * @param values a collection of values to list @@ -573,7 +573,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * Bind multiple values to a positional query parameter. The Hibernate type of the parameter is * first detected via the usage/position in the query and if not sufficient secondly * guessed from the class of the first object in the collection. This is useful for binding a list of values - * to an expression such as foo.bar in (:value_list). + * to an expression such as {@code foo.bar in (:value_list)}. * * @param position the parameter positional label * @param values a collection of values to list @@ -584,7 +584,7 @@ public interface Query extends TypedQuery, CommonQueryContract { // /** // * Bind multiple values to a named query parameter. This is useful for binding -// * a list of values to an expression such as foo.bar in (:value_list). +// * a list of values to an expression such as {@code foo.bar in (:value_list)}. // * // * @param name the name of the parameter // * @param values a collection of values to list @@ -601,7 +601,7 @@ public interface Query extends TypedQuery, CommonQueryContract { // /** // * Bind multiple values to a named query parameter. This is useful for binding -// * a list of values to an expression such as foo.bar in (:value_list). +// * a list of values to an expression such as {@code foo.bar in (:value_list)}. // * // * @param position the parameter positional label // * @param values a collection of values to list @@ -618,7 +618,7 @@ public interface Query extends TypedQuery, CommonQueryContract { /** * Bind multiple values to a named query parameter. This is useful for binding - * a list of values to an expression such as foo.bar in (:value_list). + * a list of values to an expression such as {@code foo.bar in (:value_list)}. * * @param name the name of the parameter * @param values a collection of values to list @@ -630,7 +630,7 @@ public interface Query extends TypedQuery, CommonQueryContract { /** * Bind multiple values to a positional query parameter. This is useful for binding - * a list of values to an expression such as foo.bar in (?1). + * a list of values to an expression such as {@code foo.bar in (?1)}. * * @param position the parameter positional label * @param values a collection of values to list @@ -642,7 +642,7 @@ public interface Query extends TypedQuery, CommonQueryContract { /** * Bind multiple values to a named query parameter. This is useful for binding - * a list of values to an expression such as foo.bar in (:value_list). + * a list of values to an expression such as {@code foo.bar in (:value_list)}. * * @param name the name of the parameter * @param values a collection of values to list @@ -654,7 +654,7 @@ public interface Query extends TypedQuery, CommonQueryContract { /** * Bind multiple values to a named query parameter. This is useful for binding - * a list of values to an expression such as foo.bar in (:value_list). + * a list of values to an expression such as {@code foo.bar in (:value_list)}. * * @param position the parameter positional label * @param values a collection of values to list @@ -668,7 +668,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * Bind multiple values to a named query parameter. The Hibernate type of the parameter is * first detected via the usage/position in the query and if not sufficient secondly * guessed from the class of the first object in the array. This is useful for binding a list of values - * to an expression such as foo.bar in (:value_list). + * to an expression such as {@code foo.bar in (:value_list)}. * * @param name the name of the parameter * @param values a collection of values to list @@ -681,7 +681,7 @@ public interface Query extends TypedQuery, CommonQueryContract { * Bind multiple values to a named query parameter. The Hibernate type of the parameter is * first detected via the usage/position in the query and if not sufficient secondly * guessed from the class of the first object in the array. This is useful for binding a list of values - * to an expression such as foo.bar in (:value_list). + * to an expression such as {@code foo.bar in (:value_list)}. * * @param position the parameter positional label * @param values a collection of values to list diff --git a/hibernate-core/src/main/java/org/hibernate/sql/Delete.java b/hibernate-core/src/main/java/org/hibernate/sql/Delete.java index 61d97c4a3b..0bf55b99ba 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/Delete.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/Delete.java @@ -12,7 +12,7 @@ import java.util.Map; import org.hibernate.dialect.Dialect; /** - * An SQL DELETE statement + * An SQL {@code DELETE} statement * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/sql/Insert.java b/hibernate-core/src/main/java/org/hibernate/sql/Insert.java index 9b9538dcb8..8ffeafa18a 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/Insert.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/Insert.java @@ -13,7 +13,7 @@ import org.hibernate.MappingException; import org.hibernate.dialect.Dialect; /** - * An SQL INSERT statement + * An SQL {@code INSERT} statement * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/sql/SimpleSelect.java b/hibernate-core/src/main/java/org/hibernate/sql/SimpleSelect.java index 9ab8ae9366..6e1dfcfaf8 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/SimpleSelect.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/SimpleSelect.java @@ -19,7 +19,7 @@ import org.hibernate.LockOptions; import org.hibernate.dialect.Dialect; /** - * An SQL SELECT statement with no table joins + * An SQL {@code SELECT} statement with no table joins * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/sql/Update.java b/hibernate-core/src/main/java/org/hibernate/sql/Update.java index 1a8be060ee..676c866960 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/Update.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/Update.java @@ -12,7 +12,7 @@ import java.util.Map; import org.hibernate.dialect.Dialect; /** - * An SQL UPDATE statement + * An SQL {@code UPDATE} statement * * @author Gavin King */ diff --git a/hibernate-core/src/main/java/org/hibernate/sql/results/graph/entity/AbstractEntityInitializer.java b/hibernate-core/src/main/java/org/hibernate/sql/results/graph/entity/AbstractEntityInitializer.java index 90e46f0c10..5589dc8ca7 100644 --- a/hibernate-core/src/main/java/org/hibernate/sql/results/graph/entity/AbstractEntityInitializer.java +++ b/hibernate-core/src/main/java/org/hibernate/sql/results/graph/entity/AbstractEntityInitializer.java @@ -453,7 +453,7 @@ public abstract class AbstractEntityInitializer extends AbstractFetchParentAcces } /** - * Check the version of the object in the RowProcessingState against + * Check the version of the object in the {@code RowProcessingState} against * the object version in the session cache, throwing an exception * if the version numbers are different */ diff --git a/hibernate-core/src/main/java/org/hibernate/stat/SessionStatistics.java b/hibernate-core/src/main/java/org/hibernate/stat/SessionStatistics.java index 328c7467a4..bf9c85771d 100644 --- a/hibernate-core/src/main/java/org/hibernate/stat/SessionStatistics.java +++ b/hibernate-core/src/main/java/org/hibernate/stat/SessionStatistics.java @@ -24,12 +24,12 @@ public interface SessionStatistics { int getCollectionCount(); /** - * Get the set of all EntityKeys + * Get the set of all {@code EntityKey}s * @see org.hibernate.engine.spi.EntityKey */ Set getEntityKeys(); /** - * Get the set of all CollectionKeys + * Get the set of all {@code CollectionKey}s * @see org.hibernate.engine.spi.CollectionKey */ Set getCollectionKeys(); diff --git a/hibernate-core/src/main/java/org/hibernate/stat/Statistics.java b/hibernate-core/src/main/java/org/hibernate/stat/Statistics.java index 5c9cf24011..8cc8dc1dd2 100644 --- a/hibernate-core/src/main/java/org/hibernate/stat/Statistics.java +++ b/hibernate-core/src/main/java/org/hibernate/stat/Statistics.java @@ -339,7 +339,7 @@ public interface Statistics { long getCloseStatementCount(); /** - * The number of Hibernate StaleObjectStateExceptions or JPA OptimisticLockExceptions + * The number of Hibernate {@code StaleObjectStateException}s or JPA {@code OptimisticLockException}s * that occurred. */ long getOptimisticFailureCount(); diff --git a/hibernate-core/src/main/java/org/hibernate/transform/Transformers.java b/hibernate-core/src/main/java/org/hibernate/transform/Transformers.java index e99b814fbd..cd4837444f 100644 --- a/hibernate-core/src/main/java/org/hibernate/transform/Transformers.java +++ b/hibernate-core/src/main/java/org/hibernate/transform/Transformers.java @@ -12,13 +12,13 @@ final public class Transformers { private Transformers() {} /** - * Each row of results is a Map from alias to values/entities + * Each row of results is a {@code Map} from alias to values/entities */ public static final AliasToEntityMapResultTransformer ALIAS_TO_ENTITY_MAP = AliasToEntityMapResultTransformer.INSTANCE; /** - * Each row of results is a List + * Each row of results is a {@code List} */ public static final ToListResultTransformer TO_LIST = ToListResultTransformer.INSTANCE; diff --git a/hibernate-core/src/main/java/org/hibernate/tuple/entity/EntityTuplizer.java b/hibernate-core/src/main/java/org/hibernate/tuple/entity/EntityTuplizer.java index 5292d2f55c..9e27413e7a 100644 --- a/hibernate-core/src/main/java/org/hibernate/tuple/entity/EntityTuplizer.java +++ b/hibernate-core/src/main/java/org/hibernate/tuple/entity/EntityTuplizer.java @@ -69,13 +69,13 @@ public interface EntityTuplizer extends Tuplizer { * asked to determine if there is a more appropriate entity-name to use, specifically within an inheritance * hierarchy. *

- * For example, consider a case where a user calls session.update( "Animal", cat );. Here, the - * user has explicitly provided Animal as the entity-name. However, they have passed in an instance - * of Cat which is a subclass of Animal. In this case, we would return Cat as the + * For example, consider a case where a user calls {@code session.update( "Animal", cat );}. Here, the + * user has explicitly provided {@code Animal} as the entity-name. However, they have passed in an instance + * of {@code Cat} which is a subclass of {@code Animal}. In this case, we would return {@code Cat} as the * entity-name. *

- * null may be returned from calls to this method. The meaning of null in that case is assumed - * to be that we should use whatever explicit entity-name the user provided (Animal rather than Cat + * {@code null} may be returned from calls to this method. The meaning of {@code null} in that case is assumed + * to be that we should use whatever explicit entity-name the user provided ({@code Animal} rather than {@code Cat} * in the example above). * * @param entityInstance The entity instance. diff --git a/hibernate-core/src/main/java/org/hibernate/type/CollectionType.java b/hibernate-core/src/main/java/org/hibernate/type/CollectionType.java index c6d99ad44a..1c9b8d75fc 100644 --- a/hibernate-core/src/main/java/org/hibernate/type/CollectionType.java +++ b/hibernate-core/src/main/java/org/hibernate/type/CollectionType.java @@ -50,7 +50,7 @@ import org.hibernate.type.spi.TypeConfiguration; import org.jboss.logging.Logger; /** - * A type that handles Hibernate PersistentCollections (including arrays). + * A type that handles Hibernate {@code PersistentCollection}s (including arrays). * * @author Gavin King */ @@ -365,7 +365,7 @@ public abstract class CollectionType extends AbstractType implements Association public abstract PersistentCollection wrap(SharedSessionContractImplementor session, Object collection); /** - * Note: return true because this type is castable to AssociationType. Not because + * Note: return true because this type is castable to {@code AssociationType}. Not because * all collections are associations. */ @Override diff --git a/hibernate-core/src/main/java/org/hibernate/type/CustomCollectionType.java b/hibernate-core/src/main/java/org/hibernate/type/CustomCollectionType.java index 789587082d..0107bcd336 100644 --- a/hibernate-core/src/main/java/org/hibernate/type/CustomCollectionType.java +++ b/hibernate-core/src/main/java/org/hibernate/type/CustomCollectionType.java @@ -20,7 +20,7 @@ import org.hibernate.usertype.LoggableUserType; import org.hibernate.usertype.UserCollectionType; /** - * A custom type for mapping user-written classes that implement PersistentCollection + * A custom type for mapping user-written classes that implement {@code PersistentCollection} * * @see PersistentCollection * @see UserCollectionType diff --git a/hibernate-core/src/main/java/org/hibernate/type/DbTimestampType.java b/hibernate-core/src/main/java/org/hibernate/type/DbTimestampType.java index cb62892a4d..e16236c4c2 100644 --- a/hibernate-core/src/main/java/org/hibernate/type/DbTimestampType.java +++ b/hibernate-core/src/main/java/org/hibernate/type/DbTimestampType.java @@ -20,7 +20,7 @@ import org.hibernate.type.descriptor.jdbc.TimestampJdbcType; import org.jboss.logging.Logger; /** - * dbtimestamp: A type that maps between {@link java.sql.Types#TIMESTAMP TIMESTAMP} and {@link Timestamp}. + * {@code dbtimestamp}: A type that maps between {@link java.sql.Types#TIMESTAMP TIMESTAMP} and {@link Timestamp}. * It maps to the database's current timestamp, rather than the jvm's * current timestamp. *

diff --git a/hibernate-core/src/main/java/org/hibernate/type/Type.java b/hibernate-core/src/main/java/org/hibernate/type/Type.java index ac60277d29..67737950ce 100644 --- a/hibernate-core/src/main/java/org/hibernate/type/Type.java +++ b/hibernate-core/src/main/java/org/hibernate/type/Type.java @@ -286,7 +286,7 @@ public interface Type extends Serializable { /** * Bind a value represented by an instance of the {@link #getReturnedClass() mapped class} to the JDBC prepared * statement, ignoring some columns as dictated by the 'settable' parameter. Implementors should handle the - * possibility of null values. A multi-column type should bind parameters starting from index. + * possibility of null values. A multi-column type should bind parameters starting from {@code index}. * * @param st The JDBC prepared statement to which to bind * @param value the object to write @@ -308,7 +308,7 @@ public interface Type extends Serializable { /** * Bind a value represented by an instance of the {@link #getReturnedClass() mapped class} to the JDBC prepared * statement. Implementors should handle possibility of null values. A multi-column type should bind parameters - * starting from index. + * starting from {@code index}. * * @param st The JDBC prepared statement to which to bind * @param value the object to write diff --git a/hibernate-core/src/main/java/org/hibernate/type/descriptor/java/MutabilityPlan.java b/hibernate-core/src/main/java/org/hibernate/type/descriptor/java/MutabilityPlan.java index e99ec86a58..d1d66e43ae 100644 --- a/hibernate-core/src/main/java/org/hibernate/type/descriptor/java/MutabilityPlan.java +++ b/hibernate-core/src/main/java/org/hibernate/type/descriptor/java/MutabilityPlan.java @@ -18,7 +18,7 @@ import org.hibernate.SharedSessionContract; */ public interface MutabilityPlan extends Serializable { /** - * Can the internal state of instances of T be changed? + * Can the internal state of instances of {@code T} be changed? * * @return True if the internal state can be changed; false otherwise. */ diff --git a/hibernate-core/src/main/java/org/hibernate/type/descriptor/jdbc/JdbcType.java b/hibernate-core/src/main/java/org/hibernate/type/descriptor/jdbc/JdbcType.java index 59dd2f1982..1f158be353 100644 --- a/hibernate-core/src/main/java/org/hibernate/type/descriptor/jdbc/JdbcType.java +++ b/hibernate-core/src/main/java/org/hibernate/type/descriptor/jdbc/JdbcType.java @@ -18,7 +18,7 @@ import org.hibernate.type.descriptor.java.JavaType; import org.hibernate.type.spi.TypeConfiguration; /** - * Descriptor for the SQL/JDBC side of a value mapping. + * Descriptor for the {@code SQL}/{@code JDBC} side of a value mapping. *

* NOTE : Implementations should be registered with the {@link JdbcType}. The built-in Hibernate * implementations register themselves on construction. diff --git a/hibernate-core/src/main/java/org/hibernate/type/descriptor/jdbc/TinyIntJdbcType.java b/hibernate-core/src/main/java/org/hibernate/type/descriptor/jdbc/TinyIntJdbcType.java index 763c433ba1..76092a8a71 100644 --- a/hibernate-core/src/main/java/org/hibernate/type/descriptor/jdbc/TinyIntJdbcType.java +++ b/hibernate-core/src/main/java/org/hibernate/type/descriptor/jdbc/TinyIntJdbcType.java @@ -23,7 +23,7 @@ import org.hibernate.type.spi.TypeConfiguration; /** * Descriptor for {@link Types#TINYINT TINYINT} handling. *

- * Note that JDBC states that TINYINT should be mapped to either byte or short, but points out + * Note that {@code JDBC} states that TINYINT should be mapped to either byte or short, but points out * that using byte can in fact lead to loss of data. * * @author Steve Ebersole diff --git a/hibernate-core/src/main/java/org/hibernate/usertype/UserCollectionType.java b/hibernate-core/src/main/java/org/hibernate/usertype/UserCollectionType.java index da504e237a..167f94ff6a 100644 --- a/hibernate-core/src/main/java/org/hibernate/usertype/UserCollectionType.java +++ b/hibernate-core/src/main/java/org/hibernate/usertype/UserCollectionType.java @@ -15,7 +15,7 @@ import org.hibernate.engine.spi.SharedSessionContractImplementor; import org.hibernate.persister.collection.CollectionPersister; /** - * A custom type for mapping user-written classes that implement PersistentCollection + * A custom type for mapping user-written classes that implement {@code PersistentCollection} * * @author Gavin King * @see PersistentCollection diff --git a/hibernate-core/src/main/java/org/hibernate/usertype/UserType.java b/hibernate-core/src/main/java/org/hibernate/usertype/UserType.java index 035e07739c..12e46b14e4 100644 --- a/hibernate-core/src/main/java/org/hibernate/usertype/UserType.java +++ b/hibernate-core/src/main/java/org/hibernate/usertype/UserType.java @@ -22,7 +22,7 @@ import org.hibernate.engine.spi.SharedSessionContractImplementor; *

* This interface *

    - *
  • abstracts user code from future changes to the Type + *
  • abstracts user code from future changes to the {@code Type} * interface,
    • *
  • simplifies the implementation of custom types and
    • *
  • hides certain "internal" interfaces from user code.
    • @@ -31,15 +31,15 @@ import org.hibernate.engine.spi.SharedSessionContractImplementor; * Implementors must be immutable and must declare a public * default constructor. *

    - * The actual class mapped by a UserType may be just + * The actual class mapped by a {@code UserType} may be just * about anything. *

    - * CompositeUserType provides an extended version of + * {@code CompositeUserType} provides an extended version of * this interface that is useful for more complex cases. *

    - * Alternatively, custom types could implement Type + * Alternatively, custom types could implement {@code Type} * directly or extend one of the abstract classes in - * org.hibernate.type. This approach risks future + * {@code org.hibernate.type}. This approach risks future * incompatible changes to classes or interfaces in that * package. * @@ -52,14 +52,14 @@ public interface UserType { /** * Return the SQL type codes for the columns mapped by this type. The - * codes are defined on java.sql.Types. + * codes are defined on {@code java.sql.Types}. * @see java.sql.Types * @return int[] the typecodes */ int[] sqlTypes(); /** - * The class returned by nullSafeGet(). + * The class returned by {@code nullSafeGet()}. * * @return Class */ @@ -89,7 +89,7 @@ public interface UserType { /** * Write an instance of the mapped class to a prepared statement. Implementors * should handle possibility of null values. A multi-column type should be written - * to parameters starting from index. + * to parameters starting from {@code index}. */ void nullSafeSet(PreparedStatement st, J value, int index, SharedSessionContractImplementor session) throws SQLException; diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/schemaupdate/SchemaUpdateSchemaNameTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/schemaupdate/SchemaUpdateSchemaNameTest.java index 398d1bcbff..0b151db92f 100644 --- a/hibernate-core/src/test/java/org/hibernate/orm/test/schemaupdate/SchemaUpdateSchemaNameTest.java +++ b/hibernate-core/src/test/java/org/hibernate/orm/test/schemaupdate/SchemaUpdateSchemaNameTest.java @@ -28,7 +28,7 @@ import org.hibernate.testing.orm.junit.RequiresDialect; import org.hibernate.testing.TestForIssue; /** - * Test to illustrate that the org.hibernate.mapping.Table#sqlAlterStrings method + * Test to illustrate that the {@code org.hibernate.mapping.Table#sqlAlterStrings} method * uses legacy logic for building table names and doesn't adequately specify the catalog * or schema name properly. * diff --git a/hibernate-proxool/src/main/java/org/hibernate/proxool/internal/ProxoolConnectionProvider.java b/hibernate-proxool/src/main/java/org/hibernate/proxool/internal/ProxoolConnectionProvider.java index 7b4c8b6ea0..2ffa8b9680 100644 --- a/hibernate-proxool/src/main/java/org/hibernate/proxool/internal/ProxoolConnectionProvider.java +++ b/hibernate-proxool/src/main/java/org/hibernate/proxool/internal/ProxoolConnectionProvider.java @@ -37,7 +37,7 @@ import org.logicalcobwebs.proxool.configuration.PropertyConfigurator; /** * A connection provider that uses a Proxool connection pool. Hibernate will use this by - * default if the hibernate.proxool.* properties are set. + * default if the {@code hibernate.proxool.*} properties are set. * * @see ConnectionProvider */ diff --git a/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaExportTask.java b/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaExportTask.java index 6e888d9d88..b93793a319 100644 --- a/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaExportTask.java +++ b/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaExportTask.java @@ -37,7 +37,7 @@ import org.apache.tools.ant.taskdefs.MatchingTask; import org.apache.tools.ant.types.FileSet; /** - * An Ant task for SchemaExport. + * An Ant task for {@code SchemaExport}. * * 

      * <taskdef name="schemaexport"
diff --git a/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaUpdateTask.java b/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaUpdateTask.java
index aef304e85f..6801b519b3 100644
--- a/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaUpdateTask.java
+++ b/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaUpdateTask.java
@@ -33,7 +33,7 @@ import org.apache.tools.ant.taskdefs.MatchingTask;
 import org.apache.tools.ant.types.FileSet;
 
 /**
- * An Ant task for SchemaUpdate.
+ * An Ant task for {@code SchemaUpdate}.
  * 
    
  * 
      * <taskdef name="schemaupdate"
diff --git a/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaValidatorTask.java b/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaValidatorTask.java
index 6e28952fbd..30ba434168 100644
--- a/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaValidatorTask.java
+++ b/tooling/hibernate-ant/src/main/java/org/hibernate/tool/hbm2ddl/SchemaValidatorTask.java
@@ -34,7 +34,7 @@ import org.apache.tools.ant.taskdefs.MatchingTask;
 import org.apache.tools.ant.types.FileSet;
 
 /**
- * An Ant task for SchemaUpdate.
+ * An Ant task for {@code SchemaUpdate}.
  *
  * 
      * <taskdef name="schemavalidator"