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

add missing @Override annotations and more @see in jdoc

This commit is contained in:
Gavin King 2024-11-16 18:16:31 +01:00
parent ce48367607
commit 06961d7dbe
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
hibernate-core/src/main/java/org/hibernate/boot/spi/SessionFactoryOptions.java
View File

@ -59,6 +59,7 @@ public interface SessionFactoryOptions extends QueryEngineOptions {
* @see org.hibernate.internal.SessionFactoryRegistry#getSessionFactory * @see org.hibernate.internal.SessionFactoryRegistry#getSessionFactory
* @see SessionFactoryImplementor#getUuid * @see SessionFactoryImplementor#getUuid
*/ */
@Override
String getUuid(); String getUuid();
/** /**
@ -81,6 +82,7 @@ public interface SessionFactoryOptions extends QueryEngineOptions {
/** /**
* @see org.hibernate.cfg.JpaComplianceSettings * @see org.hibernate.cfg.JpaComplianceSettings
*/ */
@Override
JpaCompliance getJpaCompliance(); JpaCompliance getJpaCompliance();
/** /**
@ -111,6 +113,7 @@ public interface SessionFactoryOptions extends QueryEngineOptions {
* *
* @see org.hibernate.cfg.PersistenceSettings#SESSION_FACTORY_NAME * @see org.hibernate.cfg.PersistenceSettings#SESSION_FACTORY_NAME
*/ */
@Override
String getSessionFactoryName(); String getSessionFactoryName();
/** /**
@ -378,6 +381,7 @@ public interface SessionFactoryOptions extends QueryEngineOptions {
/** /**
* @see org.hibernate.cfg.AvailableSettings#CRITERIA_VALUE_HANDLING_MODE * @see org.hibernate.cfg.AvailableSettings#CRITERIA_VALUE_HANDLING_MODE
*/ */
@Override
default ValueHandlingMode getCriteriaValueHandlingMode() { default ValueHandlingMode getCriteriaValueHandlingMode() {
return ValueHandlingMode.BIND; return ValueHandlingMode.BIND;
} }

17
hibernate-core/src/main/java/org/hibernate/query/spi/QueryEngineOptions.java
View File

@ -26,6 +26,8 @@ public interface QueryEngineOptions {
* Translator for transforming HQL (as an Antlr parse tree) into an SQM tree. * Translator for transforming HQL (as an Antlr parse tree) into an SQM tree.
* *
* @see org.hibernate.query.hql * @see org.hibernate.query.hql
*
* @see org.hibernate.cfg.QuerySettings#SEMANTIC_QUERY_PRODUCER
*/ */
HqlTranslator getCustomHqlTranslator(); HqlTranslator getCustomHqlTranslator();
@ -34,6 +36,8 @@ public interface QueryEngineOptions {
* For standard ORM implementations this will generally be some form of SQL tree. * For standard ORM implementations this will generally be some form of SQL tree.
* *
* @see org.hibernate.sql.ast.tree * @see org.hibernate.sql.ast.tree
*
* @see org.hibernate.cfg.QuerySettings#SEMANTIC_QUERY_TRANSLATOR
*/ */
SqmTranslatorFactory getCustomSqmTranslatorFactory(); SqmTranslatorFactory getCustomSqmTranslatorFactory();
@ -59,19 +63,32 @@ public interface QueryEngineOptions {
/** /**
* Contract for handling SQM trees representing mutation (UPDATE or DELETE) queries * Contract for handling SQM trees representing mutation (UPDATE or DELETE) queries
* where the target of the mutation is a multi-table entity. * where the target of the mutation is a multi-table entity.
*
* @see org.hibernate.cfg.QuerySettings#QUERY_MULTI_TABLE_MUTATION_STRATEGY
*/ */
SqmMultiTableMutationStrategy getCustomSqmMultiTableMutationStrategy(); SqmMultiTableMutationStrategy getCustomSqmMultiTableMutationStrategy();
/** /**
* Contract for handling SQM trees representing insertion (INSERT) queries where the * Contract for handling SQM trees representing insertion (INSERT) queries where the
* target of the mutation is a multi-table entity. * target of the mutation is a multi-table entity.
*
* @see org.hibernate.cfg.QuerySettings#QUERY_MULTI_TABLE_INSERT_STRATEGY
*/ */
SqmMultiTableInsertStrategy getCustomSqmMultiTableInsertStrategy(); SqmMultiTableInsertStrategy getCustomSqmMultiTableInsertStrategy();
/**
* @see org.hibernate.cfg.JpaComplianceSettings
*/
JpaCompliance getJpaCompliance(); JpaCompliance getJpaCompliance();
/**
* @see org.hibernate.cfg.QuerySettings#CRITERIA_VALUE_HANDLING_MODE
*/
ValueHandlingMode getCriteriaValueHandlingMode(); ValueHandlingMode getCriteriaValueHandlingMode();
/**
* @see org.hibernate.cfg.QuerySettings#IMMUTABLE_ENTITY_UPDATE_QUERY_HANDLING_MODE
*/
default ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode() { default ImmutableEntityUpdateQueryHandlingMode getImmutableEntityUpdateQueryHandlingMode() {
return ImmutableEntityUpdateQueryHandlingMode.WARNING; return ImmutableEntityUpdateQueryHandlingMode.WARNING;
} }