HHH-13925 Fix invalid javadoc syntax
This wasn't detected by checkstyle in Gradle 5, but it is now, and that fails the build.
This commit is contained in:
Yoann Rodière
parent
1cd9ad0efe
commit
aebf9d192f
|
|
@ -68,7 +68,7 @@ public abstract class AbstractEntityInsertAction extends EntityAction {
|
|||
* entity state.
|
||||
* @return the entity state.
|
||||
*
|
||||
* @see {@link #nullifyTransientReferencesIfNotAlready}
|
||||
* @see #nullifyTransientReferencesIfNotAlready
|
||||
*/
|
||||
public Object[] getState() {
|
||||
return state;
|
||||
|
|
@ -107,7 +107,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 ) {
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
* @Entity
|
||||
* @BatchSize(size=100)
|
||||
* <blockquote><pre>{@code
|
||||
* @Entity
|
||||
* @BatchSize(size=100)
|
||||
* class Product {
|
||||
* ...
|
||||
* }
|
||||
* </pre></blockquote>
|
||||
* }</pre></blockquote>
|
||||
* will initialize up to 100 lazy Product entity proxies at a time.
|
||||
*
|
||||
* <blockquote><pre>
|
||||
* @OneToMany
|
||||
* @BatchSize(size = 5) /
|
||||
* <blockquote><pre>{@code
|
||||
* @OneToMany
|
||||
* @BatchSize(size = 5) /
|
||||
* Set<Product> getProducts() { ... };
|
||||
* </pre></blockquote>
|
||||
* }</pre></blockquote>
|
||||
* will initialize up to 5 lazy collections of products at a time
|
||||
*
|
||||
* @author Emmanuel Bernard
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1776,7 +1776,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.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
package org.hibernate.boot.model.source.spi;
|
||||
|
||||
/**
|
||||
* Describes an {@link <any/>} mapping
|
||||
* Describes an {@code <any/>} mapping
|
||||
*
|
||||
* @author Steve Ebersole
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -89,7 +89,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) {
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
|
|
@ -2538,7 +2538,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.
|
||||
|
|
|
|||
|
|
@ -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() {
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ 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
|
||||
*/
|
||||
|
|
@ -149,7 +149,7 @@ public 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 @@ public 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 @@ public 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 @@ public 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 );
|
||||
|
|
|
|||
|
|
@ -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 because 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 {
|
||||
|
|
|
|||
|
|
@ -1838,7 +1838,7 @@ public interface CoreMessageLogger extends BasicLogger {
|
|||
@Message(value = "Using @AttributeOverride or @AttributeOverrides in conjunction with entity inheritance is not supported: %s. The overriding definitions are ignored.", id = 499)
|
||||
void unsupportedAttributeOverrideWithEntityInheritance(String entityName);
|
||||
|
||||
/** 6.0 message loggers
|
||||
/* 6.0 message loggers
|
||||
@LogMessage(level = WARN)
|
||||
@Message(value = "The bytecode provider class [%s] could not be loaded", id = 500)
|
||||
void bytecodeProviderClassNotFound(String className);
|
||||
|
|
|
|||
|
|
@ -304,7 +304,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.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -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";
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ import org.hibernate.persister.collection.SQLLoadableCollection;
|
|||
|
||||
/**
|
||||
* CollectionAliases that uses column names instead of generated aliases.
|
||||
* Aliases can still be overwritten via <return-property>
|
||||
* Aliases can still be overwritten via {@code <return-property>}
|
||||
*
|
||||
* @author Max Rydahl Andersen
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -54,7 +54,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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -73,7 +73,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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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) {
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -160,7 +160,8 @@ public class ConnectionProviderBuilder implements DialectCheck {
|
|||
try {
|
||||
actualConnection.close();
|
||||
}
|
||||
catch (SQLException ignore) {}
|
||||
catch (SQLException ignore) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*
|
||||
|
|
|
|||
Loading…
Reference in New Issue