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

HHH-13802 fix javadoc warnings

This commit is contained in:
Nathan Xu 2020-01-04 15:20:09 -05:00 committed by Steve Ebersole
parent 6cf7fdaa97
commit 3df0fcefa4
48 changed files with 97 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
hibernate-core/src/main/antlr/order-by.g
View File

@ -127,7 +127,7 @@ tokens
/**
* Process the given node as a function.
*
* @param The node representing the function invocation (including parameters as subtree components).
* @param ast The node representing the function invocation (including parameters as subtree components).
*
* @return The processed node.
*/
@ -149,7 +149,7 @@ tokens
/**
* Allow post processing of each <tt>sort specification</tt>
*
* @param The grammar-built sort specification subtree.
* @param sortSpec The grammar-built sort specification subtree.
*
* @return The processed sort specification subtree.
*/

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

@ -41,7 +41,7 @@ public interface CustomEntityDirtinessStrategy {
* @param persister The persister corresponding to the given entity
* @param session The session from which this check originates.
*
* @return {@code true} indicates the entity is dirty; {@link false} indicates the entity is not dirty.
* @return {@code true} indicates the entity is dirty; {@code false} indicates the entity is not dirty.
*/
public boolean isDirty(Object entity, EntityPersister persister, Session session);

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

@ -49,7 +49,7 @@ import org.hibernate.type.Type;
* {@link #addFetch} and {@link #addScalar} methods
* </li>
* </ul>
*
*
* @author Gavin King
* @author Steve Ebersole
*
@ -105,7 +105,7 @@ public interface SQLQuery<T> extends Query<T>, SynchronizeableQuery<T> {
SQLQuery<T> addScalar(String columnAlias, Type type);
/**
* Add a new root return mapping, returning a {@link NativeQuery.RootReturn} to allow further definition.
* Add a new root return mapping, returning a {@link SQLQuery.RootReturn} to allow further definition.
*
* @param tableAlias The SQL table alias to map to this entity
* @param entityName The name of the entity.
@ -117,7 +117,7 @@ public interface SQLQuery<T> extends Query<T>, SynchronizeableQuery<T> {
RootReturn addRoot(String tableAlias, String entityName);
/**
* Add a new root return mapping, returning a {@link NativeQuery.RootReturn} to allow further definition.
* Add a new root return mapping, returning a {@link SQLQuery.RootReturn} to allow further definition.
*
* @param tableAlias The SQL table alias to map to this entity
* @param entityType The java type of the entity.

2
hibernate-core/src/main/java/org/hibernate/action/spi/package-info.java
View File

@ -7,6 +7,6 @@
/**
* Defines SPI hooks into the {@link org.hibernate.engine.spi.ActionQueue}. Mainly for registering custom
* {@link AfterTransactionCompletionProcess} and {@link BeforeTransactionCompletionProcess} hooks.
* {@link org.hibernate.action.spi.AfterTransactionCompletionProcess} and {@link org.hibernate.action.spi.BeforeTransactionCompletionProcess} hooks.
*/
package org.hibernate.action.spi;

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

@ -40,7 +40,7 @@ public @interface Filter {
/**
* If true, automatically determine all points within the condition fragment that an alias should be injected.
* Otherwise, injection will only replace instances of explicit "{alias}" instances or
* @SqlFragmentAlias descriptors.
* {@link SqlFragmentAlias} descriptors.
*/
boolean deduceAliasInjectionPoints() default true;

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

@ -25,8 +25,6 @@ public enum FlushModeType {
*/
COMMIT,
/**
* Corresponds to {@link org.hibernate.FlushMode#NEVER}.
*
* @deprecated use MANUAL, will be removed in a subsequent release
*/
@Deprecated

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

@ -98,7 +98,7 @@ public interface MetadataBuilder {
* Specify the second-level cache mode to be used. This is the cache mode in terms of whether or
* not to cache.
* <p/>
* Its default is defined by the {@coce javax.persistence.sharedCache.mode} setting if using
* Its default is defined by the {@code javax.persistence.sharedCache.mode} setting if using
* property-based configuration.
*
* @param cacheMode The cache mode.

2
hibernate-core/src/main/java/org/hibernate/boot/archive/scan/spi/AbstractScannerImpl.java
View File

@ -79,7 +79,7 @@ public abstract class AbstractScannerImpl implements Scanner {
*
* JPA allows for to be specific
* @param url
* @return
* @return The resolved non-root URL
*/
protected URL resolveNonRootUrl(URL url) {
return null;

2
hibernate-core/src/main/java/org/hibernate/boot/model/naming/Identifier.java
View File

@ -88,7 +88,7 @@ public class Identifier implements Comparable<Identifier> {
*
* @param name
*
* @return
* @return {@code true} if the given identifier text is considered quoted; {@code false} otherwise.
*/
public static boolean isQuoted(String name) {
return ( name.startsWith( "`" ) && name.endsWith( "`" ) )

4
hibernate-core/src/main/java/org/hibernate/boot/model/source/spi/FilterSource.java
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,7 +28,7 @@ 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();

2
hibernate-core/src/main/java/org/hibernate/boot/model/source/spi/Orderable.java
View File

@ -26,7 +26,7 @@ public interface Orderable {
* If the ordering element is not specified, ordering by
* the primary key of the associated entity is assumed
*
* {@see javax.persistence.OrderBy#value()}
* @see javax.persistence.OrderBy#value()
*
* @return The {@code ORDER BY} fragment used during loading this plural attribute from DB.
*/

14
hibernate-core/src/main/java/org/hibernate/boot/registry/package-info.java
View File

@ -13,14 +13,14 @@
* "override" services from parent registries. It also allows granular building of registries as services
* become available.
*
* {@link BootstrapServiceRegistry} is the base service registry, intended to be built via
* {@link BootstrapServiceRegistryBuilder} if you need customization. For non-customized
* {@link BootstrapServiceRegistry} usage, the {@link BootstrapServiceRegistryBuilder} and
* {@link BootstrapServiceRegistry} can be bypassed altogether.
* {@link org.hibernate.boot.registry.BootstrapServiceRegistry} is the base service registry, intended to be built via
* {@link org.hibernate.boot.registry.BootstrapServiceRegistryBuilder} if you need customization. For non-customized
* {@link org.hibernate.boot.registry.BootstrapServiceRegistry} usage, the {@link org.hibernate.boot.registry.BootstrapServiceRegistryBuilder} and
* {@link org.hibernate.boot.registry.BootstrapServiceRegistry} can be bypassed altogether.
*
* Usually the next level in a standard registry set up is the {@link StandardServiceRegistry}, intended to be built
* by the {@link StandardServiceRegistryBuilder} if you need customization. The builder optionally takes the
* {@link BootstrapServiceRegistry} to use as a base; if none is provided a default one is generated assuming sensible
* Usually the next level in a standard registry set up is the {@link org.hibernate.boot.registry.StandardServiceRegistry}, intended to be built
* by the {@link org.hibernate.boot.registry.StandardServiceRegistryBuilder} if you need customization. The builder optionally takes the
* {@link org.hibernate.boot.registry.BootstrapServiceRegistry} to use as a base; if none is provided a default one is generated assuming sensible
* defaults in Java SE and EE environments, particularly in respect to Class loading.
*/
package org.hibernate.boot.registry;

2
hibernate-core/src/main/java/org/hibernate/boot/registry/selector/spi/package-info.java
View File

@ -6,6 +6,6 @@
*/
/**
* Defines actual contract used for strategy selection : {@link StrategySelector}.
* Defines actual contract used for strategy selection : {@link org.hibernate.boot.registry.selector.spi.StrategySelector}.
*/
package org.hibernate.boot.registry.selector.spi;

2
hibernate-core/src/main/java/org/hibernate/boot/spi/MetadataBuildingContext.java
View File

@ -54,7 +54,7 @@ public interface MetadataBuildingContext {
/**
* Not sure how I feel about this exposed here
*
* @return
* @return The ObjectNameNormalizer
*/
ObjectNameNormalizer getObjectNameNormalizer();
}

2
hibernate-core/src/main/java/org/hibernate/boot/spi/MetadataImplementor.java
View File

@ -33,7 +33,7 @@ public interface MetadataImplementor extends Metadata, Mapping {
/**
* Access to the options used to build this Metadata
*
* @return
* @return Access to the MetadataBuildingOptions
*/
MetadataBuildingOptions getMetadataBuildingOptions();

2
hibernate-core/src/main/java/org/hibernate/cache/spi/access/NaturalIdDataAccess.java vendored
View File

@ -16,7 +16,7 @@ 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

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

@ -21,7 +21,7 @@ package org.hibernate.cfg;
* @author Gavin King
* @author Emmanuel Bernard
*
* @deprecated A {@link org.hibernate.cfg.naming.NamingStrategyDelegator} should be used instead.
* @deprecated {@link org.hibernate.boot.model.naming.ImplicitNamingStrategy} and {@link org.hibernate.boot.model.naming.PhysicalNamingStrategy} should be used instead.
*/
@Deprecated
public interface NamingStrategy {

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

@ -104,7 +104,7 @@ public interface PropertyHolder {
* Determine the AttributeConverter to use for the given property.
*
* @param property
* @return
* @return The ConverterDescriptor
*/
ConverterDescriptor resolveAttributeConverterDescriptor(XProperty property);
}

2
hibernate-core/src/main/java/org/hibernate/cfg/annotations/reflection/JPAOverriddenAnnotationReader.java
View File

@ -250,7 +250,7 @@ public class JPAOverriddenAnnotationReader implements AnnotationReader {
private AccessibleObject mirroredAttribute;
/**
* @deprecated Use {@link JPAMetadataProvider(AnnotatedElement, XMLContext, BootstrapContext)} instead.
* @deprecated Use {@link #JPAOverriddenAnnotationReader(AnnotatedElement, XMLContext, BootstrapContext)} instead.
*/
public JPAOverriddenAnnotationReader(
AnnotatedElement el,

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

@ -545,7 +545,7 @@ public class DB2Dialect extends Dialect {
* if expression has not been explicitly specified.
* @param nullPrecedence Nulls precedence. Default value: {@link NullPrecedence#NONE}.
*
* @return
* @return SQL string.
*/
@Override
public String renderOrderByElement(String expression, String collation, String order, NullPrecedence nullPrecedence) {

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

@ -1674,7 +1674,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.
*/
@ -1687,11 +1687,11 @@ public abstract class Dialect implements ConversionContext {
* Build an instance of a {@link SQLExceptionConversionDelegate} for
* interpreting dialect-specific error or SQLState codes.
* <p/>
* When {@link #buildSQLExceptionConverter} returns null, the default
* When {@link #buildSQLExceptionConverter} returns null, the default
* {@link SQLExceptionConverter} is used to interpret SQLState and
* error codes. If this method is overridden to return a non-null value,
* the default {@link SQLExceptionConverter} will use the returned
* {@link SQLExceptionConversionDelegate} in addition to the following
* {@link SQLExceptionConversionDelegate} in addition to the following
* standard delegates:
* <ol>
* <li>a "static" delegate based on the JDBC 4 defined SQLException hierarchy;</li>
@ -2877,7 +2877,7 @@ public abstract class Dialect implements ConversionContext {
/**
* By default interpret this based on DatabaseMetaData.
*
* @return
* @return The NameQualifierSupport.
*/
public NameQualifierSupport getNameQualifierSupport() {
return null;

13
hibernate-core/src/main/java/org/hibernate/dialect/Oracle8iDialect.java
View File

@ -653,7 +653,7 @@ public class Oracle8iDialect extends Dialect {
public boolean supportsEmptyInList() {
return false;
}
@Override
public boolean supportsExistsInSelect() {
return false;
@ -663,7 +663,7 @@ public class Oracle8iDialect extends Dialect {
public int getInExpressionCountLimit() {
return PARAM_LIST_SIZE_LIMIT;
}
@Override
public boolean forceLobAsLastValue() {
return true;
@ -672,7 +672,8 @@ public class Oracle8iDialect extends Dialect {
/**
* For Oracle, the FOR UPDATE clause cannot be applied when using ORDER BY, DISTINCT or views.
* @param parameters
* @return
* @return {@code true} indicates that the dialect requests that locking be applied by subsequent select;
* {@code false} (the default) indicates that locking should be applied to the main SQL statement..
@see <a href="https://docs.oracle.com/database/121/SQLRF/statements_10002.htm#SQLRF01702">Oracle FOR UPDATE restrictions</a>
*/
@Override
@ -697,12 +698,12 @@ public class Oracle8iDialect extends Dialect {
return true;
}
}
@Override
public String getNotExpression( String expression ) {
return "not (" + expression + ")";
}
@Override
public String getQueryHintString(String sql, String hints) {
String statementType = statementType(sql);
@ -724,7 +725,7 @@ public class Oracle8iDialect extends Dialect {
return sql;
}
@Override
public int getMaxAliasLength() {
// Oracle's max identifier length is 30, but Hibernate needs to add "uniqueing info" so we account for that,

2
hibernate-core/src/main/java/org/hibernate/engine/jdbc/SerializableBlobProxy.java
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;

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

@ -71,7 +71,7 @@ public interface JdbcEnvironment extends Service {
/**
* Obtain the level of support for qualified names.
*
* @return
* @return The NameQualifierSupport.
*/
NameQualifierSupport getNameQualifierSupport();

4
hibernate-core/src/main/java/org/hibernate/engine/spi/ActionQueue.java
View File

@ -1102,11 +1102,11 @@ public class ActionQueue {
/**
* Check if the this {@link BatchIdentifier} has a parent or grand parent
* matching the given {@link BatchIdentifier reference.
* 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 (

2
hibernate-core/src/main/java/org/hibernate/engine/spi/BatchFetchQueue.java
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;

43
hibernate-core/src/main/java/org/hibernate/engine/spi/PersistenceContext.java
View File

@ -33,7 +33,7 @@ import org.hibernate.persister.entity.EntityPersister;
* </ul>
* <p/>
* Often referred to as the "first level cache".
*
*
* @author Gavin King
* @author Steve Ebersole
*/
@ -250,7 +250,7 @@ public interface PersistenceContext {
final boolean disableVersionIncrement);
/**
* Generates an appropriate EntityEntry instance and adds it
* Generates an appropriate EntityEntry instance and adds it
* to the event source's internal caches.
*/
EntityEntry addEntry(
@ -286,7 +286,7 @@ public interface PersistenceContext {
/**
* If a deleted entity instance is re-saved, and it has a proxy, we need to
* reset the identifier of the proxy
* reset the identifier of the proxy
*/
void reassociateProxy(Object value, Serializable id) throws MappingException;
@ -478,7 +478,7 @@ public interface PersistenceContext {
*/
Object removeProxy(EntityKey key);
/**
/**
* Retrieve the set of EntityKeys representing nullifiable references
* @deprecated Use {@link #containsNullifiableEntityKey(Supplier)} or {@link #registerNullifiableEntityKey(EntityKey)} or {@link #isNullifiableEntityKeysEmpty()}
*/
@ -496,8 +496,6 @@ public interface PersistenceContext {
/**
* Provides access to the entity/EntityEntry combos associated with the persistence context in a manner that
* is safe from reentrant access. Specifically, it is safe from additions/removals while iterating.
*
* @return
*/
Map.Entry<Object,EntityEntry>[] reentrantSafeEntityEntries();
@ -574,7 +572,7 @@ public interface PersistenceContext {
void afterLoad();
/**
* Is in a two-phase load?
* Is in a two-phase load?
*/
boolean isLoadFinished();
/**
@ -631,12 +629,12 @@ public interface PersistenceContext {
* To determine the read-only/modifiable setting for a particular entity
* or proxy:
* @see PersistenceContext#isReadOnly(Object)
* @see org.hibernate.Session#isReadOnly(Object)
* @see org.hibernate.Session#isReadOnly(Object)
*
* @return true, loaded entities/proxies will be made read-only by default;
* false, loaded entities/proxies will be made modifiable by default.
*
* @see org.hibernate.Session#isDefaultReadOnly()
* @see org.hibernate.Session#isDefaultReadOnly()
*/
boolean isDefaultReadOnly();
@ -799,7 +797,6 @@ public interface PersistenceContext {
/**
* A read-only iterator on all entities managed by this persistence context
* @return
*/
Iterator managedEntitiesIterator();
@ -811,10 +808,10 @@ public interface PersistenceContext {
/**
* Given an array of "full entity state", extract the portions that represent the natural id
*
*
* @param state The attribute state array
* @param persister The persister representing the entity type.
*
*
* @return The extracted natural id values
*/
Object[] extractNaturalIdValues(Object[] state, EntityPersister persister);
@ -848,7 +845,7 @@ public interface PersistenceContext {
* @param persister The persister representing the entity type.
* @param id The primary key value
* @param state Generally the "full entity state array", though could also be the natural id values array
* @param previousState Generally the "full entity state array", though could also be the natural id values array.
* @param previousState Generally the "full entity state array", though could also be the natural id values array.
* Specifically represents the previous values on update, and so is only used with {@link CachedNaturalIdValueSource#UPDATE}
* @param source Enumeration representing how these values are coming into cache.
*/
@ -861,11 +858,11 @@ public interface PersistenceContext {
/**
* Cleans up local cross-reference entries.
*
*
* @param persister The persister representing the entity type.
* @param id The primary key value
* @param state Generally the "full entity state array", though could also be the natural id values array
*
*
* @return The local cached natural id values (could be different from given values).
*/
Object[] removeLocalNaturalIdCrossReference(EntityPersister persister, Serializable id, Object[] state);
@ -876,7 +873,7 @@ public interface PersistenceContext {
* @param persister The persister representing the entity type.
* @param id The primary key value
* @param state Generally the "full entity state array", though could also be the natural id values array
* @param previousState Generally the "full entity state array", though could also be the natural id values array.
* @param previousState Generally the "full entity state array", though could also be the natural id values array.
* Specifically represents the previous values on update, and so is only used with {@link CachedNaturalIdValueSource#UPDATE}
* @param source Enumeration representing how these values are coming into cache.
*/
@ -901,7 +898,7 @@ public interface PersistenceContext {
*
* @param persister The persister representing the entity type.
* @param pk The primary key value
*
*
* @return The cross-referenced natural-id values, or {@code null}
*/
Object[] findCachedNaturalId(EntityPersister persister, Serializable pk);
@ -914,9 +911,9 @@ public interface PersistenceContext {
* @param persister The persister representing the entity type.
* @param naturalIdValues The natural id value(s)
*
* @return The corresponding cross-referenced primary key,
* @return The corresponding cross-referenced primary key,
* {@link PersistenceContext.NaturalIdHelper#INVALID_NATURAL_ID_REFERENCE},
* or {@code null}.
* or {@code null}.
*/
Serializable findCachedNaturalIdResolution(EntityPersister persister, Object[] naturalIdValues);
@ -924,14 +921,14 @@ public interface PersistenceContext {
* Find all the locally cached primary key cross-reference entries for the given persister.
*
* @param persister The persister representing the entity type.
*
*
* @return The primary keys
*/
Collection<Serializable> getCachedPkResolutions(EntityPersister persister);
/**
* Part of the "load synchronization process". Responsible for maintaining cross-reference entries
* when natural-id values were found to have changed. Also responsible for tracking the old values
* when natural-id values were found to have changed. Also responsible for tracking the old values
* as no longer valid until the next flush because otherwise going to the database would just re-pull
* the old values as valid. In this last responsibility, {@link #cleanupFromSynchronizations} is
* the inverse process called after flush to clean up those entries.
@ -939,7 +936,7 @@ public interface PersistenceContext {
* @param persister The persister representing the entity type.
* @param pk The primary key
* @param entity The entity instance
*
*
* @see #cleanupFromSynchronizations
*/
void handleSynchronization(EntityPersister persister, Serializable pk, Object entity);
@ -962,7 +959,7 @@ public interface PersistenceContext {
/**
* Access to the natural-id helper for this persistence context
*
*
* @return This persistence context's natural-id helper
*/
NaturalIdHelper getNaturalIdHelper();

2
hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionContractImplementor.java
View File

@ -194,7 +194,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() ) {

2
hibernate-core/src/main/java/org/hibernate/event/service/spi/EventListenerGroup.java
View File

@ -40,7 +40,7 @@ public interface EventListenerGroup<T> extends Serializable {
/**
* @deprecated this is not the most efficient way for iterating the event listeners.
* See {@link #fireEventOnEachListener(Object, BiConsumer)} and its overloaded variants for better alternatives.
* @return
* @return The Iterable.
*/
@Deprecated
public Iterable<T> listeners();

2
hibernate-core/src/main/java/org/hibernate/loader/plan/build/spi/ExpandingCollectionQuerySpace.java
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.
*/

2
hibernate-core/src/main/java/org/hibernate/loader/plan/exec/process/spi/ResultSetProcessingContext.java
View File

@ -49,7 +49,7 @@ public interface ResultSetProcessingContext extends LockModeResolver {
/**
*
* @return
* @return Whether there is no identifier for this entity reference
*/
boolean isMissingIdentifier();

7
hibernate-core/src/main/java/org/hibernate/loader/plan/exec/process/spi/ScrollableResultSetProcessor.java
View File

@ -10,6 +10,7 @@ import java.sql.ResultSet;
import org.hibernate.engine.spi.QueryParameters;
import org.hibernate.engine.spi.SessionImplementor;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
/**
* Contract for processing JDBC ResultSets a single logical row at a time. These are intended for use by
@ -25,7 +26,7 @@ public interface ScrollableResultSetProcessor {
/**
* Give a ResultSet, extract just a single result row.
*
* Copy of {@link org.hibernate.loader.Loader#loadSingleRow(java.sql.ResultSet, org.hibernate.engine.spi.SessionImplementor, org.hibernate.engine.spi.QueryParameters, boolean)}
* Copy of {@link org.hibernate.loader.Loader#loadSingleRow(ResultSet, SharedSessionContractImplementor, QueryParameters, boolean)}
* but dropping the 'returnProxies' (that method has only one use in the entire codebase and it always passes in
* false...)
*
@ -47,7 +48,7 @@ public interface ScrollableResultSetProcessor {
* properly ordered to account for any to-many fetches. Multiple ResultSet rows are read into a single query
* result "row".
*
* Copy of {@link org.hibernate.loader.Loader#loadSequentialRowsForward(java.sql.ResultSet, org.hibernate.engine.spi.SessionImplementor, org.hibernate.engine.spi.QueryParameters, boolean)}
* Copy of {@link org.hibernate.loader.Loader#loadSequentialRowsForward(ResultSet, SharedSessionContractImplementor, QueryParameters, boolean)}
* but dropping the 'returnProxies' (that method has only one use in the entire codebase and it always passes in
* false...)
*
@ -67,7 +68,7 @@ public interface ScrollableResultSetProcessor {
/**
* Like {@link #extractLogicalRowForward} but here moving through the ResultSet in reverse.
*
* Copy of {@link org.hibernate.loader.Loader#loadSequentialRowsReverse(java.sql.ResultSet, org.hibernate.engine.spi.SessionImplementor, org.hibernate.engine.spi.QueryParameters, boolean, boolean)}
* Copy of {@link org.hibernate.loader.Loader#loadSequentialRowsReverse(ResultSet, SharedSessionContractImplementor, QueryParameters, boolean, boolean)}
* but dropping the 'returnProxies' (that method has only one use in the entire codebase and it always passes in
* false...).
*

3
hibernate-core/src/main/java/org/hibernate/metamodel/model/domain/EmbeddedDomainType.java
View File

@ -7,9 +7,10 @@
package org.hibernate.metamodel.model.domain;
import javax.persistence.metamodel.EmbeddableType;
import javax.persistence.metamodel.EntityType;
/**
* Hibernate extension to the JPA {@link } contract.
* Hibernate extension to the JPA {@link EntityType} contract.
*
* @apiNote Notice that this describes {@link javax.persistence.Embedded}, not
* {@link javax.persistence.Embeddable} - like {@link CollectionDomainType}, it includes

2
hibernate-core/src/main/java/org/hibernate/persister/entity/AbstractEntityPersister.java
View File

@ -2548,7 +2548,7 @@ public abstract class AbstractEntityPersister
*
* @param lockMode The lock mode to apply to the thing being loaded.
*
* @return
* @return The UniqueEntityLoader.
*
* @throws MappingException
*/

4
hibernate-core/src/main/java/org/hibernate/persister/entity/JoinedSubclassEntityPersister.java
View File

@ -350,7 +350,7 @@ public class JoinedSubclassEntityPersister extends AbstractEntityPersister {
* For the Client entity:
* naturalOrderTableNames -> PERSON, CLIENT; this reflects the sequence in which the tableNames are
* added to the meta-data when the annotated entities are processed.
* However, in some instances, for example when generating joins, the CLIENT table needs to be
* However, in some instances, for example when generating joins, the CLIENT table needs to be
* the first table as it will the driving table.
* tableNames -> CLIENT, PERSON
*/
@ -623,7 +623,7 @@ public class JoinedSubclassEntityPersister extends AbstractEntityPersister {
*
* @param persistentClass
* @param factory
* @return
* @return subclassNamesBySubclassTable
*/
private String[][] buildSubclassNamesBySubclassTableMapping(PersistentClass persistentClass, SessionFactoryImplementor factory) {
// this value represents the number of subclasses (and not the class itself)

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

@ -432,7 +432,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

3
hibernate-core/src/main/java/org/hibernate/query/spi/QueryParameterListBinding.java
View File

@ -10,12 +10,13 @@ import java.util.Collection;
import javax.persistence.TemporalType;
import org.hibernate.Incubating;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.query.internal.QueryParameterBindingsImpl;
import org.hibernate.type.Type;
/**
* Represents a "parameter list" binding: aka the binding of a collection of values for a single
* query parameter. At some point these need to be "expanded"; see {@link QueryParameterBindingsImpl#expandListValuedParameters(String)}
* query parameter. At some point these need to be "expanded"; see {@link QueryParameterBindingsImpl#expandListValuedParameters(String, SharedSessionContractImplementor)}
* for details.
*
* @author Steve Ebersole

2
hibernate-core/src/main/java/org/hibernate/resource/transaction/spi/DdlTransactionIsolator.java
View File

@ -38,7 +38,7 @@ public interface DdlTransactionIsolator {
* Connection will be isolated (transactionally) from any
* transaction in effect prior to the call to {@link #prepare}.
*
* @return
* @return The Connection.
*/
Connection getIsolatedConnection();

1
hibernate-core/src/main/java/org/hibernate/service/spi/SessionFactoryServiceRegistryFactory.java
View File

@ -25,7 +25,6 @@ public interface SessionFactoryServiceRegistryFactory extends Service {
* for grabbing a reference for later use. However, care should be taken when invoking on
* the session factory until after it has been fully initialized.
* @param sessionFactoryOptions The build options.
* @param sessionFactoryOptions The build options.
*
* @return The registry
*/

2
hibernate-core/src/main/java/org/hibernate/sql/ordering/antlr/OrderByTranslation.java
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
*/

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

@ -12,7 +12,7 @@ import javax.management.MXBean;
* 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
*/
@MXBean
@ -42,7 +42,7 @@ public interface Statistics {
/**
* find entity statistics per name
*
*
* @param entityName entity name
* @return EntityStatistics object
*/
@ -50,7 +50,7 @@ public interface Statistics {
/**
* Get collection statistics per role
*
*
* @param role collection role
* @return CollectionStatistics
*/
@ -366,7 +366,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);

4
hibernate-core/src/main/java/org/hibernate/tool/schema/extract/spi/DatabaseInformation.java
View File

@ -61,9 +61,9 @@ public interface DatabaseInformation {
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}
*/

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

@ -30,8 +30,6 @@ public class IdentifierProperty extends AbstractAttribute implements IdentifierA
*
* @param name The name of the property representing the identifier within
* its owning entity.
* @param node The node name to use for XML-based representation of this
* property.
* @param type The Hibernate Type for the identifier property.
* @param embedded Is this an embedded identifier.
* @param unsavedValue The value which, if found as the value on the identifier

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

@ -117,7 +117,7 @@ public interface Type extends Serializable {
* NOTE: The number of elements in this array matches the return from {@link #getColumnSpan}.
*
* @param mapping The mapping object :/
* @todo Would be much much better to have this aware of Dialect once the service/metamodel split is done
* TODO: Would be much much better to have this aware of Dialect once the service/metamodel split is done
*
* @return The dictated sizes.
*
@ -132,7 +132,7 @@ public interface Type extends Serializable {
* NOTE: The number of elements in this array matches the return from {@link #getColumnSpan}.
*
* @param mapping The mapping object :/
* @todo Would be much much better to have this aware of Dialect once the service/metamodel split is done
* TODO: Would be much much better to have this aware of Dialect once the service/metamodel split is done
*
* @return The default sizes.
*

4
hibernate-core/src/main/java/org/hibernate/type/descriptor/sql/LobTypeMappings.java
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

2
hibernate-core/src/main/java/org/hibernate/type/descriptor/sql/NationalizedTypeMappings.java
View File

@ -50,7 +50,7 @@ public final class NationalizedTypeMappings {
/**
* @deprecated use {@link #toNationalizedTypeCode(int)}
* @param jdbcCode
* @return
* @return corresponding nationalized code
*/
@Deprecated
public int getCorrespondingNationalizedCode(int jdbcCode) {

2
hibernate-core/src/main/java/org/hibernate/type/spi/TypeConfiguration.java
View File

@ -142,7 +142,7 @@ public class TypeConfiguration implements SessionFactoryObserver, Serializable {
* bound here. See {@link Scope} for more details regarding the stages
* a TypeConfiguration goes through
*
* @return
* @return The MetadataBuildingContext
*/
public MetadataBuildingContext getMetadataBuildingContext() {
return scope.getMetadataBuildingContext();

4
hibernate-core/src/test/java/org/hibernate/test/annotations/cascade/CascadeTest.java
View File

@ -23,7 +23,7 @@ import static org.junit.Assert.assertNull;
/**
* Check some of the individual cascade styles
*
* @todo do something for refresh
* TODO: do something for refresh
*
* @author Emmanuel Bernard
*/
@ -149,7 +149,7 @@ public class CascadeTest extends BaseCoreFunctionalTestCase {
s = openSession();
tx = s.beginTransaction();
s.delete( s.get( Mouth.class, mouth.id ) );
tx.commit();
s.close();
}