HHH-14640 : Fix checkstyle errors

This commit is contained in:
Andrea Boriero 2021-05-26 15:25:51 +02:00 committed by gbadner
parent cc6fe84f30
commit b3ae29406a
67 changed files with 144 additions and 140 deletions

View File

@ -67,7 +67,7 @@ public abstract class AbstractEntityInsertAction extends EntityAction {
* entity state.
* @return the entity state.
*
* @see {@link #nullifyTransientReferencesIfNotAlready}
* @see #nullifyTransientReferencesIfNotAlready
*/
public Object[] getState() {
return state;
@ -106,7 +106,7 @@ public abstract class AbstractEntityInsertAction extends EntityAction {
* called for a this object, so it can safely be called both when
* the entity is made "managed" and when this action is executed.
*
* @see {@link #makeEntityManaged() }
* @see #makeEntityManaged()
*/
protected final void nullifyTransientReferencesIfNotAlready() {
if ( ! areTransientReferencesNullified ) {

View File

@ -16,20 +16,20 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Defines size for batch loading of collections or lazy entities. For example...
* <blockquote><pre>
* &#064;Entity
* &#064;BatchSize(size=100)
* class Product {
* ...
* }
* </pre></blockquote>
* <blockquote><pre>{@code
* @Entity
* @BatchSize(size=100)
* class Product {
* ...
* }
* }</pre></blockquote>
* will initialize up to 100 lazy Product entity proxies at a time.
*
* <blockquote><pre>
* &#064;OneToMany
* &#064;BatchSize(size = 5) /
* Set<Product> getProducts() { ... };
* </pre></blockquote>
* <blockquote><pre>{@code
* @OneToMany
* @BatchSize(size = 5) /
* Set<Product> getProducts() { ... };
* }</pre></blockquote>
* will initialize up to 5 lazy collections of products at a time
*
* @author Emmanuel Bernard

View File

@ -34,7 +34,7 @@ public @interface Sort {
/**
* Specifies the comparator to use. Only valid when {@link #type} specifies {@link SortType#COMPARATOR}.
*
* TODO find a way to use Class<Comparator> -> see HHH-8164
* TODO find a way to use {@code Class<Comparator>} -> see HHH-8164
*/
Class comparator() default void.class;
}

View File

@ -1780,7 +1780,7 @@ public class InFlightMetadataCollectorImpl implements InFlightMetadataCollector
* <p/>
* See <tt>ANN-722</tt> and <tt>ANN-730</tt>
*
* @param orderedFkSecondPasses The list containing the <code>FkSecondPass<code> instances ready
* @param orderedFkSecondPasses The list containing the <code>FkSecondPass</code> instances ready
* for processing.
* @param isADependencyOf Our lookup data structure to determine dependencies between tables
* @param startTable Table name to start recursive algorithm.

View File

@ -9,7 +9,7 @@ package org.hibernate.boot.model.source.spi;
import java.util.Map;
/**
* Defines the source of filter information. May have an associated {@link FilterDefinitionSource}.
* Defines the source of filter information. May have an associated {@link org.hibernate.engine.spi.FilterDefinition}.
* Relates to both {@code <filter/>} and {@link org.hibernate.annotations.Filter @Filter}
*
* @author Steve Ebersole
@ -28,12 +28,12 @@ public interface FilterSource {
*
* @return The condition defined on the filter.
*
* @see {@link FilterDefinitionSource#getCondition()}
* @see org.hibernate.boot.model.source.internal.hbm.FilterSourceImpl#getCondition()
*/
public String getCondition();
/**
* Should Hibernate perform automatic alias injection into the supplied condition string? The default it to
* Should Hibernate perform automatic alias injection into the supplied condition string? The default is to
* perform auto injection *unless* explicit alias(es) are supplied.
*
* @return {@code true} indicates auto injection should occur; {@code false} that it should not

View File

@ -7,7 +7,7 @@
package org.hibernate.boot.model.source.spi;
/**
* Describes an {@link <any/>} mapping
* Describes an {@code <any/>} mapping
*
* @author Steve Ebersole
*/

View File

@ -7,7 +7,7 @@
package org.hibernate.bytecode.enhance.spi;
/**
* Interface to be implemented by collection trackers that hold the expected size od collections, a simplified Map<String, int>.
* Interface to be implemented by collection trackers that hold the expected size od collections, a simplified {@code Map<String, int>}.
*
* @author <a href="mailto:lbarreiro@redhat.com">Luis Barreiro</a>
*/

View File

@ -16,10 +16,10 @@ import org.hibernate.persister.entity.EntityPersister;
* <li><b>INSERTS</b> : {@link #insert} -> {@link #afterInsert}</li>
* <li><b>UPDATES</b> : {@link #lockItem} -> {@link #remove} -> {@link #update} -> {@link #afterUpdate}</li>
* <li><b>DELETES</b> : {@link #lockItem} -> {@link #remove} -> {@link #unlockItem}</li>
* <li><b>LOADS</b> : {@link @putFromLoad}</li>
* <li><b>LOADS</b> : {@link #putFromLoad}</li>
* </ul>
* Note the special case of <b>UPDATES</b> above. Because the cache key itself has changed here we need to remove the
* old entry as well as
* old entry as well
* <p/>
* There is another usage pattern that is used to invalidate entries
* afterQuery performing "bulk" HQL/SQL operations:
@ -44,7 +44,7 @@ public interface NaturalIdDataAccess extends CachedDomainDataAccess {
* @param naturalIdValues the sequence of values which unequivocally identifies a cached element on this region
* @param rootEntityDescriptor the persister of the element being cached
*
* @return a key which can be used to identify this an element unequivocally on this same region
* @return a key which can be used to identify an element unequivocally on this same region
*/
Object generateCacheKey(
Object[] naturalIdValues,
@ -69,7 +69,7 @@ public interface NaturalIdDataAccess extends CachedDomainDataAccess {
* @param key The item key
* @param value The item
*
* @return Were the contents of the cache actual changed by this operation?
* @return Were the contents of the cache actually changed by this operation?
*
* @throws CacheException Propagated from underlying cache provider
*/
@ -84,7 +84,7 @@ public interface NaturalIdDataAccess extends CachedDomainDataAccess {
* @param key The item key
* @param value The item
*
* @return Were the contents of the cache actual changed by this operation?
* @return Were the contents of the cache actually changed by this operation?
*
* @throws CacheException Propagated from underlying cache provider
*/
@ -99,7 +99,7 @@ public interface NaturalIdDataAccess extends CachedDomainDataAccess {
* @param key The item key
* @param value The item
*
* @return Were the contents of the cache actual changed by this operation?
* @return Were the contents of the cache actually changed by this operation?
*
* @throws CacheException Propagated from underlying cache provider
*/
@ -115,7 +115,7 @@ public interface NaturalIdDataAccess extends CachedDomainDataAccess {
* @param value The item
* @param lock The lock previously obtained from {@link #lockItem}
*
* @return Were the contents of the cache actual changed by this operation?
* @return Were the contents of the cache actually changed by this operation?
*
* @throws CacheException Propagated from underlying cache provider
*/

View File

@ -88,7 +88,7 @@ public abstract class AbstractPersistentCollection implements Serializable, Pers
}
/**
* * @deprecated {@link #AbstractPersistentCollection(SharedSessionContractImplementor)} should be used instead.
* @deprecated {@link #AbstractPersistentCollection(SharedSessionContractImplementor)} should be used instead.
*/
@Deprecated
protected AbstractPersistentCollection(SessionImplementor session) {

View File

@ -112,8 +112,8 @@ import org.hibernate.type.descriptor.sql.VarcharTypeDescriptor;
* <p>
* Note: This dialect is configured to create foreign keys with {@code on update cascade}.
*
* @author Andrew Clemons <andrew.clemons@sap.com>
* @author Jonathan Bregler <jonathan.bregler@sap.com>
* @author <a href="mailto:andrew.clemons@sap.com">Andrew Clemons</a>
* @author <a href="mailto:jonathan.bregler@sap.com">Jonathan Bregler</a>
*/
public abstract class AbstractHANADialect extends Dialect {

View File

@ -49,7 +49,7 @@ import org.hibernate.type.StandardBasicTypes;
/**
* Cach&eacute; 2007.1 dialect.
*
* This class is required in order to use Hibernate with Intersystems Cach&eacute; SQL. Compatible with
* This class is required in order to use Hibernate with InterSystems Cach&eacute; SQL. Compatible with
* Cach&eacute; 2007.1.
*
* <h2>PREREQUISITES</h2>
@ -102,7 +102,7 @@ import org.hibernate.type.StandardBasicTypes;
* For example, in Hibernate 3.2, typical entries in hibernate.properties would have the following
* "name=value" pairs:
* <p/>
* <table cols=3 border cellpadding=5 cellspacing=0>
* <table cols=3 border="" cellpadding=5 cellspacing=0>
* <tr>
* <th>Property Name</th>
* <th>Property Value</th>

View File

@ -336,7 +336,7 @@ public abstract class Dialect implements ConversionContext {
/**
* Get the name of the database type associated with the given
* {@link java.sql.Types} typecode with the given storage specification
* {@link Types} typecode with the given storage specification
* parameters.
*
* @param code The {@link java.sql.Types} typecode
@ -1655,7 +1655,7 @@ public abstract class Dialect implements ConversionContext {
* @return The Dialect's preferred SQLExceptionConverter, or null to
* indicate that the default {@link SQLExceptionConverter} should be used.
*
* @see {@link #buildSQLExceptionConversionDelegate()}
* @see #buildSQLExceptionConversionDelegate()
* @deprecated {@link #buildSQLExceptionConversionDelegate()} should be
* overridden instead.
*/
@ -2510,7 +2510,7 @@ public abstract class Dialect implements ConversionContext {
* Are subselects supported as the left-hand-side (LHS) of
* IN-predicates.
* <p/>
* In other words, is syntax like "... <subquery> IN (1, 2, 3) ..." supported?
* In other words, is syntax like {@code ... <subquery> IN (1, 2, 3) ...} supported?
*
* @return True if subselects can appear as the LHS of an in-predicate;
* false otherwise.

View File

@ -22,8 +22,8 @@ import org.hibernate.hql.spi.id.local.AfterUseAction;
* <p>
* Column tables are created by this dialect when using the auto-ddl feature.
*
* @author Andrew Clemons <andrew.clemons@sap.com>
* @author Jonathan Bregler <jonathan.bregler@sap.com>
* @author <a href="mailto:andrew.clemons@sap.com">Andrew Clemons</a>
* @author <a href="mailto:jonathan.bregler@sap.com">Jonathan Bregler</a>
*/
public class HANAColumnStoreDialect extends AbstractHANADialect {

View File

@ -22,8 +22,8 @@ import org.hibernate.hql.spi.id.local.AfterUseAction;
* <p>
* Row tables are created by this dialect when using the auto-ddl feature.
*
* @author Andrew Clemons <andrew.clemons@sap.com>
* @author Jonathan Bregler <jonathan.bregler@sap.com>
* @author <a href="mailto:andrew.clemons@sap.com">Andrew Clemons</a>
* @author <a href="mailto:jonathan.bregler@sap.com">Jonathan Bregler</a>
*/
public class HANARowStoreDialect extends AbstractHANADialect {

View File

@ -18,7 +18,7 @@ import org.hibernate.type.StandardBasicTypes;
* An Hibernate 3 SQL dialect for Mimer SQL. This dialect requires Mimer SQL 9.2.1 or later
* because of the mappings to NCLOB, BINARY, and BINARY VARYING.
*
* @author Fredrik lund <fredrik.alund@mimer.se>
* @author <a href="mailto:fredrik.alund@mimer.se">Fredrik lund</a>
*/
@SuppressWarnings("deprecation")
public class MimerSQLDialect extends Dialect {
@ -27,8 +27,8 @@ public class MimerSQLDialect extends Dialect {
private static final int BINARY_MAX_LENGTH = 2000;
/**
* Even thoug Mimer SQL supports character and binary columns up to 15 000 in lenght,
* this is also the maximum width of the table (exluding LOBs). To avoid breaking the limit all the
* Even though Mimer SQL supports character and binary columns up to 15 000 in length,
* this is also the maximum width of the table (excluding LOBs). To avoid breaking the limit all the
* time we limit the length of the character columns to CHAR_MAX_LENTH, NATIONAL_CHAR_LENGTH for national
* characters, and BINARY_MAX_LENGTH for binary types.
*/

View File

@ -65,7 +65,7 @@ public class TeradataDialect extends Dialect implements IdTableSupport {
// bit_length feels a bit broken to me. We have to cast to char in order to
// pass when a numeric value is supplied. But of course the answers given will
// be wildly different for these two datatypes. 1234.5678 will be 9 bytes as
// be wildly different for these two data types. 1234.5678 will be 9 bytes as
// a char string but will be 8 or 16 bytes as a true numeric.
// Jay Nance 2006-09-22
registerFunction(
@ -103,7 +103,7 @@ public class TeradataDialect extends Dialect implements IdTableSupport {
/**
* Does this dialect support the <tt>FOR UPDATE</tt> syntax?
*
* @return empty string ... Teradata does not support <tt>FOR UPDATE<tt> syntax
* @return empty string ... Teradata does not support <tt>FOR UPDATE</tt> syntax
*/
@Override
public String getForUpdateString() {

View File

@ -37,9 +37,9 @@ import org.hibernate.pretty.MessageHelper;
* A base implementation of EntityEntry
*
* @author Gavin King
* @author Emmanuel Bernard <emmanuel@hibernate.org>
* @author <a href="mailto:emmanuel@hibernate.org">Emmanuel Bernard</a>
* @author Gunnar Morling
* @author Sanne Grinovero <sanne@hibernate.org>
* @author <a href="mailto:sanne@hibernate.org">Sanne Grinovero </a>
*/
public abstract class AbstractEntityEntry implements Serializable, EntityEntry {
protected final Serializable id;

View File

@ -11,7 +11,7 @@ import org.hibernate.engine.spi.EntityEntryExtraState;
/**
* Contains optional state from {@link org.hibernate.engine.spi.EntityEntry}.
*
* @author Emmanuel Bernard <emmanuel@hibernate.org>
* @author <a href="mailto:emmanuel@hibernate.org">Emmanuel Bernard</a>
*/
public class EntityEntryExtraStateHolder implements EntityEntryExtraState {
private EntityEntryExtraState next;

View File

@ -22,12 +22,12 @@ import org.hibernate.persister.entity.EntityPersister;
/**
* An EntityEntry implementation for immutable entities. Note that this implementation is not completely
* immutable in terms of its internal state; the term immutable here refers to the entity is describes.
* immutable in terms of its internal state; the term immutable here refers to the entity it describes.
*
* @author Gavin King
* @author Emmanuel Bernard <emmanuel@hibernate.org>
* @author <a href="mailto:emmanuel@hibernate.org">Emmanuel Bernard</a>
* @author Gunnar Morling
* @author Sanne Grinovero <sanne@hibernate.org>
* @author <a href="mailto:sanne@hibernate.org">Sanne Grinovero </a>
*
* @see org.hibernate.annotations.Immutable
*/

View File

@ -22,9 +22,9 @@ import org.hibernate.persister.entity.EntityPersister;
* An EntityEntry implementation for mutable entities.
*
* @author Gavin King
* @author Emmanuel Bernard <emmanuel@hibernate.org>
* @author <a href="mailto:emmanuel@hibernate.org">Emmanuel Bernard</a>
* @author Gunnar Morling
* @author Sanne Grinovero <sanne@hibernate.org>
* @author <a href="mailto:sanne@hibernate.org">Sanne Grinovero </a>
*/
public final class MutableEntityEntry extends AbstractEntityEntry {
/**

View File

@ -31,7 +31,7 @@ public class SerializableBlobProxy implements InvocationHandler, Serializable {
* Builds a serializable {@link Blob} wrapper around the given {@link Blob}.
*
* @param blob The {@link Blob} to be wrapped.
* @see
* @see #generateProxy(java.sql.Blob)
*/
private SerializableBlobProxy(Blob blob) {
this.blob = blob;

View File

@ -1101,12 +1101,12 @@ public class ActionQueue {
}
/**
* Check if the this {@link BatchIdentifier} has a parent or grand parent
* matching the given {@link BatchIdentifier reference.
* Check if this {@link BatchIdentifier} has a parent or grand parent
* matching the given {@link BatchIdentifier} reference.
*
* @param batchIdentifier {@link BatchIdentifier} reference
*
* @return This {@link BatchIdentifier} has a parent matching the given {@link BatchIdentifier reference
* @return This {@link BatchIdentifier} has a parent matching the given {@link BatchIdentifier} reference
*/
boolean hasParent(BatchIdentifier batchIdentifier) {
return (

View File

@ -40,7 +40,7 @@ public class BatchFetchQueue {
/**
* A map of {@link SubselectFetch subselect-fetch descriptors} keyed by the
* {@link EntityKey) against which the descriptor is registered.
* {@link EntityKey} against which the descriptor is registered.
*/
private Map<EntityKey, SubselectFetch> subselectsByEntityKey;
@ -97,7 +97,7 @@ public class BatchFetchQueue {
}
/**
* Adds a subselect fetch decriptor for the given entity key.
* Adds a subselect fetch descriptor for the given entity key.
*
* @param key The entity for which to register the subselect fetch.
* @param subquery The fetch descriptor.

View File

@ -21,9 +21,9 @@ import org.hibernate.persister.entity.EntityPersister;
* therefore we need to take care of its impact on memory consumption.
*
* @author Gavin King
* @author Emmanuel Bernard <emmanuel@hibernate.org>
* @author <a href="mailto:emmanuel@hibernate.org">Emmanuel Bernard</a>
* @author Gunnar Morling
* @author Sanne Grinovero <sanne@hibernate.org>
* @author <a href="mailto:sanne@hibernate.org">Sanne Grinovero </a>
*/
public interface EntityEntry {
LockMode getLockMode();

View File

@ -10,7 +10,7 @@ package org.hibernate.engine.spi;
/**
* Navigation methods for extra state objects attached to {@link org.hibernate.engine.spi.EntityEntry}.
*
* @author Emmanuel Bernard <emmanuel@hibernate.org>
* @author <a href="mailto:emmanuel@hibernate.org">Emmanuel Bernard</a>
*/
public interface EntityEntryExtraState {

View File

@ -76,7 +76,7 @@ import org.hibernate.type.descriptor.sql.SqlTypeDescriptor;
* API so that only some methods need to be overridden
* (Used by Hibernate Search).
*
* @author Sanne Grinovero <sanne@hibernate.org> (C) 2012 Red Hat Inc.
* @author <a href="mailto:sanne@hibernate.org">Sanne Grinovero</a> (C) 2012 Red Hat Inc.
*/
@SuppressWarnings("deprecation")
public class SessionDelegatorBaseImpl implements SessionImplementor {
@ -107,7 +107,7 @@ public class SessionDelegatorBaseImpl implements SessionImplementor {
}
/**
* Returns the underlying delegate. Be careful that is has a different behavior from the {@link #getDelegate()}
* Returns the underlying delegate. Be careful that it has a different behavior from the {@link #getDelegate()}
* method coming from the EntityManager interface which returns the current session.
*
* @see SessionDelegatorBaseImpl#getDelegate()

View File

@ -113,7 +113,7 @@ public interface SharedSessionContractImplementor
/**
* Checks whether the session is closed. Provided separately from
* {@link #isOpen()} as this method does not attempt any JTA synchronization
* registration, where as {@link #isOpen()} does; which makes this one
* registration, whereas {@link #isOpen()} does; which makes this one
* nicer to use for most internal purposes.
*
* @return {@code true} if the session is closed; {@code false} otherwise.
@ -185,7 +185,7 @@ public interface SharedSessionContractImplementor
* Check if an active Transaction is necessary for the update operation to be executed.
* If an active Transaction is necessary but it is not then a TransactionRequiredException is raised.
*
* @param exceptionMessage, the message to use for the TransactionRequiredException
* @param exceptionMessage the message to use for the TransactionRequiredException
*/
default void checkTransactionNeededForUpdateOperation(String exceptionMessage) {
if ( !isTransactionInProgress() ) {

View File

@ -46,7 +46,7 @@ import org.jboss.logging.Logger;
* <ul>
* <li>Methods that return collections (e.g., {@link #keySet()},
* {@link #values()}, {@link #entrySet()}) return an
* unnmodifiable view of the collection;</li>
* unmodifiable view of the collection;</li>
* <li>If {@link #put(Object mergeEntity, Object) managedEntity} or
* {@link #put(Object mergeEntity, Object managedEntity, boolean isOperatedOn)}
* is executed and this MergeMap already contains a cross-reference for
@ -73,11 +73,11 @@ import org.jboss.logging.Logger;
* The following method is intended to be used by a merge event listener (and other
* classes) in the same package to indicate whether the merge operation is being
* performed on a merge entity already in the MergeContext:
* {@link MergeContext#setOperatedOn(Object mergeEntity, boolean isOperatedOn)
* {@link MergeContext#setOperatedOn(Object mergeEntity, boolean isOperatedOn)}
*
* @author Gail Badner
*/
class MergeContext implements Map {
public class MergeContext implements Map {
private static final Logger LOG = Logger.getLogger( MergeContext.class );
private final EventSource session;
@ -149,7 +149,7 @@ class MergeContext implements Map {
* Returns an unmodifiable set view of the merge-to-managed entity cross-references contained in this MergeContext.
* @return an unmodifiable set view of the merge-to-managed entity cross-references contained in this MergeContext
*
* @see {@link Collections#unmodifiableSet(java.util.Set)}
* @see Collections#unmodifiableSet(java.util.Set)
*/
public Set entrySet() {
return Collections.unmodifiableSet( mergeToManagedEntityXref.entrySet() );
@ -180,7 +180,7 @@ class MergeContext implements Map {
* Returns an unmodifiable set view of the merge entities contained in this MergeContext
* @return an unmodifiable set view of the merge entities contained in this MergeContext
*
* @see {@link Collections#unmodifiableSet(java.util.Set)}
* @see Collections#unmodifiableSet(java.util.Set)
*/
public Set keySet() {
return Collections.unmodifiableSet( mergeToManagedEntityXref.keySet() );
@ -319,7 +319,7 @@ class MergeContext implements Map {
* Returns an unmodifiable Set view of managed entities contained in this MergeContext.
* @return an unmodifiable Set view of managed entities contained in this MergeContext
*
* @see {@link Collections#unmodifiableSet(java.util.Set)}
* @see Collections#unmodifiableSet(java.util.Set)
*/
public Collection values() {
return Collections.unmodifiableSet( managedToMergeEntityXref.keySet() );
@ -367,7 +367,7 @@ class MergeContext implements Map {
*
* @return an unmodifiable map view of the managed-to-merge entity cross-references.
*
* @see {@link Collections#unmodifiableMap(java.util.Map)}
* @see Collections#unmodifiableMap(java.util.Map)
*/
public Map invertMap() {
return Collections.unmodifiableMap( managedToMergeEntityXref );

View File

@ -10,7 +10,9 @@ import javax.persistence.AttributeNode;
import javax.persistence.metamodel.Attribute;
/**
* @author Strong Liu <stliu@hibernate.org>
* Integration version of the AttributeNode contract
*
* @author <a href="mailto:stliu@hibernate.org">Strong Liu</a>
*/
public interface AttributeNodeImplementor<T> extends AttributeNode<T> {
public Attribute<?,T> getAttribute();

View File

@ -10,7 +10,9 @@ import java.util.List;
import javax.persistence.AttributeNode;
/**
* @author Strong Liu <stliu@hibernate.org>
* Integration version of the GraphNode contract
*
* @author <a href="mailto:stliu@hibernate.org">Strong Liu</a>
*/
public interface GraphNodeImplementor {
List<AttributeNodeImplementor<?>> attributeImplementorNodes();

View File

@ -8,7 +8,7 @@ package org.hibernate.hql.internal.ast;
/**
* A custom token class for the HQL grammar.
* <p><i>NOTE:<i> This class must be public becuase it is instantiated by the ANTLR library. Ignore any suggestions
* <p><i>NOTE:</i> This class must be public because it is instantiated by the ANTLR library. Ignore any suggestions
* by various code 'analyzers' about this class being package local.</p>
*/
public class HqlToken extends antlr.CommonToken {

View File

@ -13,7 +13,7 @@ import org.hibernate.id.factory.spi.MutableIdentifierGeneratorFactory;
import org.hibernate.service.spi.ServiceRegistryImplementor;
/**
* @author Emmanuel Bernard <emmanuel@hibernate.org>
* @author <a href="mailto:emmanuel@hibernate.org">Emmanuel Bernard</a>
*/
public class MutableIdentifierGeneratorFactoryInitiator implements StandardServiceInitiator<MutableIdentifierGeneratorFactory> {
public static final MutableIdentifierGeneratorFactoryInitiator INSTANCE = new MutableIdentifierGeneratorFactoryInitiator();

View File

@ -12,7 +12,7 @@ import org.hibernate.service.Service;
/**
* Let people register strategies
*
* @author Emmanuel Bernard <emmanuel@hibernate.org>
* @author <a href="mailto:emmanuel@hibernate.org">Emmanuel Bernard</a>
*/
public interface MutableIdentifierGeneratorFactory extends IdentifierGeneratorFactory, Service {
public void register(String strategy, Class generatorClass);

View File

@ -289,7 +289,7 @@ public final class StringHelper {
/**
* Collapses a name. Mainly intended for use with classnames, where an example might serve best to explain.
* Imagine you have a class named <samp>'org.hibernate.internal.util.StringHelper'</samp>; calling collapse on that
* classname will result in <samp>'o.h.u.StringHelper'<samp>.
* classname will result in <samp>'o.h.u.StringHelper'</samp>.
*
* @param name The name to collapse.
*

View File

@ -236,7 +236,7 @@ public interface AvailableSettings {
* <b>enabled</b> - Do the build
* </li>
* <li>
* <b>disabled</b> - Do not so the build
* <b>disabled</b> - Do not do the build
* </li>
* <li>
* <b>ignoreUnsupported</b> - Do the build, but ignore any non-JPA features that would otherwise
@ -283,14 +283,14 @@ public interface AvailableSettings {
/**
* Caching configuration should follow the following pattern
* hibernate.ejb.classcache.<fully.qualified.Classname> usage[, region]
* {@code hibernate.ejb.classcache.<fully.qualified.Classname> usage[, region]}
* where usage is the cache strategy used and region the cache region name
*/
String CLASS_CACHE_PREFIX = "hibernate.ejb.classcache";
/**
* Caching configuration should follow the following pattern
* hibernate.ejb.collectioncache.<fully.qualified.Classname>.<role> usage[, region]
* {@code hibernate.ejb.collectioncache.<fully.qualified.Classname>.<role> usage[, region]}
* where usage is the cache strategy used and region the cache region name
*/
String COLLECTION_CACHE_PREFIX = "hibernate.ejb.collectioncache";

View File

@ -11,7 +11,7 @@ import org.hibernate.jpa.HibernateEntityManagerFactory;
/**
* Internal contact for things that have {@link HibernateEntityManagerFactory} access.
*
* @author Strong Liu <stliu@hibernate.org>
* @author <a href="mailto:stliu@hibernate.org">Strong Liu</a>
*
* @deprecated (since 5.2) Why do we need an over-arching access to HibernateEntityManagerFactory across
* multiple contract hierarchies?

View File

@ -11,7 +11,7 @@ import java.util.Map;
/**
* Provide a set of IdentifierGenerator strategies allowing to override the Hibernate Core default ones
*
* @author Emmanuel Bernard <emmanuel@hibernate.org>
* @author <a href="mailto:emmanuel@hibernate.org">Emmanuel Bernard</a>
*/
public interface IdentifierGeneratorStrategyProvider {
/**

View File

@ -18,7 +18,7 @@ import org.jboss.logging.Logger;
/**
* Loads a collection of values or a many-to-many association.
* <br>
* The collection persister must implement <tt>QueryableCOllection<tt>. For
* The collection persister must implement <tt>QueryableCollection</tt>. For
* other collections, create a customized subclass of <tt>Loader</tt>.
*
* @see OneToManyLoader

View File

@ -18,7 +18,7 @@ import org.jboss.logging.Logger;
/**
* Loads one-to-many associations<br>
* <br>
* The collection persister must implement <tt>QueryableCOllection<tt>. For
* The collection persister must implement <tt>QueryableCollection</tt>. For
* other collections, create a customized subclass of <tt>Loader</tt>.
*
* @see BasicCollectionLoader

View File

@ -12,8 +12,8 @@ import org.hibernate.loader.CollectionAliases;
import org.hibernate.persister.collection.SQLLoadableCollection;
/**
* CollectionAliases that uses columnnames instead of generated aliases.
* Aliases can still be overwritten via <return-property>
* CollectionAliases that uses column names instead of generated aliases.
* Aliases can still be overwritten via {@code <return-property>}
*
* @author Max Rydahl Andersen
*/

View File

@ -52,7 +52,7 @@ import org.jboss.logging.Logger;
* and we try to match the node to entity graph ( and subgraph ), if there is a match, then the attribute is fetched,
* it is not, then depends on which property is used to apply this entity graph.
*
* @author Strong Liu <stliu@hibernate.org>
* @author <a href="mailto:stliu@hibernate.org">Strong Liu</a>
* @author Brett Meyer
*/
public abstract class AbstractEntityGraphVisitationStrategy

View File

@ -16,7 +16,7 @@ import org.hibernate.persister.walking.spi.AssociationAttributeDefinition;
/**
* Loadplan building strategy for {@link javax.persistence.EntityGraph} is applied in {@code javax.persistence.fetchgraph} mode.
*
* @author Strong Liu <stliu@hibernate.org>
* @author <a href="mailto:stliu@hibernate.org">Strong Liu</a>
*/
public class FetchGraphLoadPlanBuildingStrategy extends AbstractEntityGraphVisitationStrategy {
private final GraphNodeImplementor rootEntityGraph;

View File

@ -19,7 +19,7 @@ import org.hibernate.persister.walking.spi.AssociationAttributeDefinition;
/**
* Loadplan building strategy for {@link javax.persistence.EntityGraph} is applied in {@code javax.persistence.loadgraph} mode.
*
* @author Strong Liu <stliu@hibernate.org>
* @author <a href="mailto:stliu@hibernate.org">Strong Liu</a>
*/
public class LoadGraphLoadPlanBuildingStrategy extends AbstractEntityGraphVisitationStrategy {
private final GraphNodeImplementor rootEntityGraph;

View File

@ -29,7 +29,7 @@ public interface ExpandingCollectionQuerySpace extends CollectionQuerySpace, Exp
* @param join The element or index join to add.
*
* @throws java.lang.IllegalArgumentException if {@code join} is an instance of
* {@link org.hibernate.loader.plan.spi.JoinDefinedByMetadata} and {@code join.getJoinedPropertyName()
* {@link org.hibernate.loader.plan.spi.JoinDefinedByMetadata} and {@code join.getJoinedPropertyName()}
* is neither {@code "elements"} and {@code "indices"}.
* @throws java.lang.IllegalStateException if there is already an existing join with the same joined property name.
*/

View File

@ -154,7 +154,7 @@ public class AliasResolutionContextImpl implements AliasResolutionContext {
* query space UID:
* <ul>
* <li>
* {@link ##resolveCollectionReferenceAliases(String)} can be used to
* {@link #resolveCollectionReferenceAliases(String)} can be used to
* look up the returned collection reference aliases;
* </li>
* <li>

View File

@ -35,7 +35,7 @@ public interface BidirectionalEntityReference extends EntityReference {
/**
* The query space UID returned using {@link #getQuerySpaceUid()} must
* be the same as returned by {@link #getTargetEntityReference()#getQuerySpaceUid()}
* be the same as returned by {@link #getTargetEntityReference()}
*
* @return The query space UID.
*/

View File

@ -55,7 +55,7 @@ public interface FetchSource {
*
* @return the "current" EntityReference or null if none.
* .
* @see org.hibernate.loader.plan.spi.Fetch#getSource().
* @see org.hibernate.loader.plan.spi.Fetch#getSource()
*/
public EntityReference resolveEntityReference();
}

View File

@ -41,7 +41,7 @@ import org.hibernate.type.EntityType;
* <li>{@link #buildAttribute normal attributes}</li>
* <li>{@link #buildIdAttribute id attributes}</li>
* <li>{@link #buildVersionAttribute version attributes}</li>
* <ol>
* </ol>
*
* @author Steve Ebersole
* @author Emmanuel Bernard

View File

@ -21,7 +21,7 @@ import org.hibernate.service.Service;
* <li>the default provider as chosen by Hibernate Core (best choice most of the time)</li>
* </ol>
*
* @author Emmanuel Bernard <emmanuel@hibernate.org>
* @author <a href="mailto:emmanuel@hibernate.org">Emmanuel Bernard</a>
* @author Steve Ebersole
*/
public interface PersisterClassResolver extends Service {

View File

@ -430,7 +430,7 @@ public abstract class AbstractLazyInitializer implements LazyInitializer {
* This method should only be called during deserialization, before associating
* the proxy with a session.
*
* @param readOnlyBeforeAttachedToSession, the read-only/modifiable setting to use when
* @param readOnlyBeforeAttachedToSession the read-only/modifiable setting to use when
* associated with a session; null indicates that the default should be used.
* @param sessionFactoryUuid the session factory uuid, to be used if {@code allowLoadOutsideTransaction} is {@code true}.
* @param allowLoadOutsideTransaction whether the proxy can load data even

View File

@ -15,7 +15,7 @@ import org.hibernate.query.criteria.internal.Renderable;
import org.hibernate.query.criteria.internal.compile.RenderingContext;
/**
* Models an <tt>EXISTS(<subquery>)</tt> predicate
* Models an {@code EXISTS(<subquery>)} predicate
*
* @author Steve Ebersole
*/

View File

@ -7,7 +7,7 @@
package org.hibernate.sql.ordering.antlr;
/**
* Represents the result of an order-by translation by {@link @OrderByTranslator}
* Represents the result of an order-by translation by {@link OrderByFragmentTranslator}
*
* @author Steve Ebersole
*/

View File

@ -31,7 +31,7 @@ public interface TranslationContext {
public Dialect getDialect();
/**
* Retrieves the <tt>SQL function registry/tt> for this context.
* Retrieves the <tt>SQL function registry</tt> for this context.
*
* @return The SQL function registry.
*/

View File

@ -10,7 +10,7 @@ package org.hibernate.stat;
* Exposes statistics for a particular {@link org.hibernate.SessionFactory}. Beware of milliseconds metrics, they
* are dependent of the JVM precision: you may then encounter a 10 ms approximation depending on you OS platform.
* Please refer to the JVM documentation for more information.
*
*
* @author Emmanuel Bernard
*/
public interface Statistics {
@ -37,7 +37,7 @@ public interface Statistics {
/**
* find entity statistics per name
*
*
* @param entityName entity name
* @return EntityStatistics object
*/
@ -45,7 +45,7 @@ public interface Statistics {
/**
* Get collection statistics per role
*
*
* @param role collection role
* @return CollectionStatistics
*/
@ -69,7 +69,7 @@ public interface Statistics {
QueryStatistics getQueryStatistics(String queryString);
/**
* Second level cache statistics per domain data (entity, collection, natural-id) region
* Second-level cache statistics per domain data (entity, collection, natural-id) region
*
* @param regionName The unqualified region name
*
@ -81,7 +81,7 @@ public interface Statistics {
CacheRegionStatistics getDomainDataRegionStatistics(String regionName);
/**
* Second level cache statistics per query region
* Second-level cache statistics per query region
*
* @param regionName The unqualified region name
*
@ -125,7 +125,7 @@ public interface Statistics {
long getEntityLoadCount();
/**
* Get global number of entity fetchs
* Get global number of entity fetches
* @return entity fetch (from DB)
*/
long getEntityFetchCount();
@ -168,34 +168,34 @@ public interface Statistics {
long getQueryCachePutCount();
/**
* Get the global number of naturalId queries executed against the database
* Get the global number of natural id queries executed against the database
*/
long getNaturalIdQueryExecutionCount();
/**
* Get the global maximum query time for naturalId queries executed against the database
* Get the global maximum query time for natural id queries executed against the database
*/
long getNaturalIdQueryExecutionMaxTime();
/**
* Get the region for the maximum naturalId query time
* Get the region for the maximum natural id query time
*/
String getNaturalIdQueryExecutionMaxTimeRegion();
String getNaturalIdQueryExecutionMaxTimeEntity();
/**
* Get the global number of cached naturalId lookups successfully retrieved from cache
* Get the global number of cached natural id lookups successfully retrieved from cache
*/
long getNaturalIdCacheHitCount();
/**
* Get the global number of cached naturalId lookups *not* found in cache
* Get the global number of cached natural id lookups *not* found in cache
*/
long getNaturalIdCacheMissCount();
/**
* Get the global number of cacheable naturalId lookups put in cache
* Get the global number of cacheable natural id lookups put in cache
*/
long getNaturalIdCachePutCount();
@ -205,7 +205,7 @@ public interface Statistics {
long getUpdateTimestampsCacheHitCount();
/**
* Get the global number of tables for which no update timestamps was *not* found in cache
* Get the global number of timestamp requests that were not found in the cache
*/
long getUpdateTimestampsCacheMissCount();
@ -278,9 +278,9 @@ public interface Statistics {
long getCollectionRecreateCount();
/**
* The milliseconds (JVM standard {@link System#currentTimeMillis()}) from
* which all statistics accessed since the initial creation of this Statistics
* instance or the last {@link #clear()}
* The milliseconds (JVM standard {@link System#currentTimeMillis()})
* since the initial creation of this Statistics
* instance or the last time {@link #clear()} was called.
*
* @apiNote This time(stamp) is
*/
@ -336,7 +336,7 @@ public interface Statistics {
/**
* Second level cache statistics per region
* Second-level cache statistics per region
*
* @param regionName qualified region name
*
@ -356,7 +356,7 @@ public interface Statistics {
* @return NaturalIdCacheStatistics
*
* @deprecated (since 5.3) Use {@link #getNaturalIdStatistics} or
* {@link @getDomainDataRegionStatistics} instead depending on need
* {@link #getDomainDataRegionStatistics} instead depending on need
*/
@Deprecated
NaturalIdCacheStatistics getNaturalIdCacheStatistics(String regionName);

View File

@ -72,7 +72,7 @@ public class QueryStatisticsImpl implements QueryStatistics {
/**
* Number of lines returned by all the executions of this query (from DB)
* For now, {@link org.hibernate.Query#iterate()}
* and {@link org.hibernate.Query#scroll()()} do not fill this statistic
* and {@link org.hibernate.Query#scroll()} do not fill this statistic
*
* @return The number of rows cumulatively returned by the given query; iterate
* and scroll queries do not effect this total as their number of returned rows

View File

@ -36,7 +36,7 @@ import java.util.List;
* Code based on from:
* https://github.com/hibernate/hibernate-orm/blob/159bc99a36d86988b61b88ba91eec82cac044e1c/hibernate-core/src/main/java/org/hibernate/tool/enhance/EnhancementTask.java
* https://github.com/hibernate/hibernate-orm/blob/159bc99a36d86988b61b88ba91eec82cac044e1c/tooling/hibernate-enhance-maven-plugin/src/main/java/org/hibernate/orm/tooling/maven/MavenEnhancePlugin.java
*
* <pre>{@code
* <target name="enhance" depends="compile">
* <taskdef name="enhance" classname="org.hibernate.tool.enhance.EnhancementTask">
* <classpath refid="<some-ant-path-including-hibernate-core-jar>"/>
@ -44,6 +44,7 @@ import java.util.List;
* </taskdef>
* <enhance base="${base}" dir="${base}" failOnError="true" enableLazyInitialization="true" enableDirtyTracking="false" enableAssociationManagement="false" enableExtendedEnhancement="false" />
* </target>
* }</pre>
*
* @author Luis Barreiro
* @author Taro App

View File

@ -54,16 +54,16 @@ public interface DatabaseInformation {
/**
* Obtain reference to the named TableInformation
*
* @param tableName The qualfied table name
* @param tableName The qualified table name
*
* @return The table information. May return {@code null} if not found.
*/
TableInformation getTableInformation(QualifiedTableName tableName);
/**
* Obtain reference to all the {@link TableInformation) for a given {@link Namespace}
* Obtain reference to all the {@link TableInformation} for a given {@link Namespace}
*
* @param namespace The {@link Namespace} which contains the {@link TableInformation)
* @param namespace The {@link Namespace} which contains the {@link TableInformation}
*
* @return a {@link NameSpaceTablesInformation}
*/

View File

@ -31,7 +31,7 @@ public final class LobTypeMappings {
/**
*
* @param jdbcTypeCode
* @return
* @return true if corresponding Lob code exists; false otherwise.
* @deprecated use {@link #isMappedToKnownLobCode(int)}
*/
@Deprecated
@ -42,7 +42,7 @@ public final class LobTypeMappings {
/**
*
* @param jdbcTypeCode
* @return
* @return corresponding Lob code
* @deprecated use {@link #getLobCodeTypeMapping(int)}
*/
@Deprecated

View File

@ -38,8 +38,7 @@ public class OsgiServiceUtil implements Stoppable {
* {@link ServiceTracker} (best practice, automatically handles a lot of boilerplate and error conditions).
*
* @param contract The service contract for which to locate implementors
* @param context The OSGi bundle context
* @param T[] The Java type of the service to locate
* @param <T> The Java type of the service to locate
* @return All know implementors
*/
public <T> T[] getServiceImpls(Class<T> contract) {
@ -63,8 +62,7 @@ public class OsgiServiceUtil implements Stoppable {
* {@link ServiceTracker#waitForService(long)}
*
* @param contract The service contract for which to locate implementors
* @param context The OSGi bundle context
* @param T[] The Java type of the service to locate
* @param <T> The Java type of the service to locate
* @return All know implementors
*/
public <T> T getServiceImpl(Class<T> contract) {

View File

@ -250,7 +250,7 @@ public class SDOParameterMap {
/**
* Returns all parameters contained in this instance as a quoted String containing
* the <parameter name>=<parameter value> pairs separated by spaces.
* the {@code <parameter name>=<parameter value>} pairs separated by spaces.
* <p>
* The return format is as expected by the various SDO_GEOMETRY spatial functions.
*

View File

@ -13,7 +13,7 @@ import org.jboss.byteman.rule.helper.Helper;
import org.jboss.logging.Logger;
/**
* @author Sanne Grinovero <sanne@hibernate.org> (C) 2011 Red Hat Inc.
* @author <a href="mailto:sanne@hibernate.org">Sanne Grinovero</a> (C) 2011 Red Hat Inc.
* @author Hardy Ferentschik
*/
public class BytemanHelper extends Helper {

View File

@ -160,7 +160,8 @@ public class ConnectionProviderBuilder implements DialectCheck {
try {
actualConnection.close();
}
catch (SQLException ignore) {}
catch (SQLException ignore) {
}
}
}

View File

@ -17,7 +17,7 @@ import org.jboss.logging.Logger;
* A {@code Logger} implementation which delegates to Log4J but makes it possible
* to test for events being logged (not logged).
*
* @author Sanne Grinovero <sanne@hibernate.org> (C) 2015 Red Hat Inc.
* @author <a href="mailto:sanne@hibernate.org">Sanne Grinovero</a> (C) 2011 Red Hat Inc.
*/
public final class Log4DelegatingLogger extends Logger {

View File

@ -17,7 +17,7 @@ import org.jboss.logging.DelegatingBasicLogger;
* For this to work, it requires JBoss Logging to pick up our custom
* implementation {@code Log4DelegatingLogger} via ServiceLoader.
*
* @author Sanne Grinovero <sanne@hibernate.org> (C) 2015 Red Hat Inc.
* @author <a href="mailto:sanne@hibernate.org">Sanne Grinovero</a> (C) 2015 Red Hat Inc.
*/
final class LogInspectionHelper {

View File

@ -18,7 +18,7 @@ import org.jboss.logging.Logger;
* A {@code LoggerProvider} for JBoss Logger.
* See also META-INF/services/org.jboss.logging.LoggerProvider
*
* @author Sanne Grinovero <sanne@hibernate.org> (C) 2015 Red Hat Inc.
* @author <a href="mailto:sanne@hibernate.org">Sanne Grinovero</a> (C) 2015 Red Hat Inc.
*/
public class TestableLoggerProvider implements org.jboss.logging.LoggerProvider {

View File

@ -53,8 +53,8 @@ public class ImportContextImpl implements ImportContext {
* Attempts to handle fqcn with array and generics references.
* <p/>
* e.g.
* java.util.Collection<org.marvel.Hulk> imports java.util.Collection and returns Collection
* org.marvel.Hulk[] imports org.marvel.Hulk and returns Hulk
* {@code java.util.Collection<org.marvel.Hulk>} imports {@code java.util.Collection} and returns {@code Collection}
* {@code org.marvel.Hulk[]} imports {@code org.marvel.Hulk} and returns {@code Hulk}
*
* @param fqcn Fully qualified class name
*

View File

@ -18,8 +18,8 @@ public interface ImportContext {
* Attempts to handle fqcn with array and generics references.
* <p/>
* e.g.
* java.util.Collection<org.marvel.Hulk> imports java.util.Collection and returns Collection
* org.marvel.Hulk[] imports org.marvel.Hulk and returns Hulk
* {@code java.util.Collection<org.marvel.Hulk>} imports {@code java.util.Collection} and returns {@code Collection}
* {@code org.marvel.Hulk[]} imports {@code org.marvel.Hulk} and returns {@code Hulk}
*
* @param fqcn Fully qualified class name of the type to import.
*