Merge pull request #981 from hazendaz/master

[docs] Remove legacy inheritDoc as @OVERRIDES does same thing

Author: hazendaz

src/main/java/org/mybatis/spring/MyBatisExceptionTranslator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2023 the original author or authors.
+ * Copyright 2010-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -74,9 +74,6 @@ public MyBatisExceptionTranslator(Supplier<SQLExceptionTranslator> exceptionTran
     }
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public DataAccessException translateExceptionIfPossible(RuntimeException e) {
     if (e instanceof PersistenceException) {

src/main/java/org/mybatis/spring/SqlSessionFactoryBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2023 the original author or authors.
+ * Copyright 2010-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -564,9 +564,6 @@ private <T> T[] appendArrays(T[] oldArrays, T[] newArrays, IntFunction<T[]> gene
     }
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void afterPropertiesSet() throws Exception {
     notNull(dataSource, "Property 'dataSource' is required");
@@ -711,9 +708,6 @@ protected SqlSessionFactory buildSqlSessionFactory() throws Exception {
     return this.sqlSessionFactoryBuilder.build(targetConfiguration);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public SqlSessionFactory getObject() throws Exception {
     if (this.sqlSessionFactory == null) {
@@ -723,25 +717,16 @@ public SqlSessionFactory getObject() throws Exception {
     return this.sqlSessionFactory;
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public Class<? extends SqlSessionFactory> getObjectType() {
     return this.sqlSessionFactory == null ? SqlSessionFactory.class : this.sqlSessionFactory.getClass();
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public boolean isSingleton() {
     return true;
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void onApplicationEvent(ContextRefreshedEvent event) {
     if (failFast) {

src/main/java/org/mybatis/spring/SqlSessionTemplate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2022 the original author or authors.
+ * Copyright 2010-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -144,243 +144,151 @@ public PersistenceExceptionTranslator getPersistenceExceptionTranslator() {
     return this.exceptionTranslator;
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <T> T selectOne(String statement) {
     return this.sqlSessionProxy.selectOne(statement);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <T> T selectOne(String statement, Object parameter) {
     return this.sqlSessionProxy.selectOne(statement, parameter);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <K, V> Map<K, V> selectMap(String statement, String mapKey) {
     return this.sqlSessionProxy.selectMap(statement, mapKey);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <K, V> Map<K, V> selectMap(String statement, Object parameter, String mapKey) {
     return this.sqlSessionProxy.selectMap(statement, parameter, mapKey);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <K, V> Map<K, V> selectMap(String statement, Object parameter, String mapKey, RowBounds rowBounds) {
     return this.sqlSessionProxy.selectMap(statement, parameter, mapKey, rowBounds);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <T> Cursor<T> selectCursor(String statement) {
     return this.sqlSessionProxy.selectCursor(statement);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <T> Cursor<T> selectCursor(String statement, Object parameter) {
     return this.sqlSessionProxy.selectCursor(statement, parameter);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <T> Cursor<T> selectCursor(String statement, Object parameter, RowBounds rowBounds) {
     return this.sqlSessionProxy.selectCursor(statement, parameter, rowBounds);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <E> List<E> selectList(String statement) {
     return this.sqlSessionProxy.selectList(statement);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <E> List<E> selectList(String statement, Object parameter) {
     return this.sqlSessionProxy.selectList(statement, parameter);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) {
     return this.sqlSessionProxy.selectList(statement, parameter, rowBounds);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void select(String statement, ResultHandler handler) {
     this.sqlSessionProxy.select(statement, handler);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void select(String statement, Object parameter, ResultHandler handler) {
     this.sqlSessionProxy.select(statement, parameter, handler);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void select(String statement, Object parameter, RowBounds rowBounds, ResultHandler handler) {
     this.sqlSessionProxy.select(statement, parameter, rowBounds, handler);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public int insert(String statement) {
     return this.sqlSessionProxy.insert(statement);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public int insert(String statement, Object parameter) {
     return this.sqlSessionProxy.insert(statement, parameter);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public int update(String statement) {
     return this.sqlSessionProxy.update(statement);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public int update(String statement, Object parameter) {
     return this.sqlSessionProxy.update(statement, parameter);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public int delete(String statement) {
     return this.sqlSessionProxy.delete(statement);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public int delete(String statement, Object parameter) {
     return this.sqlSessionProxy.delete(statement, parameter);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public <T> T getMapper(Class<T> type) {
     return getConfiguration().getMapper(type, this);
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void commit() {
     throw new UnsupportedOperationException("Manual commit is not allowed over a Spring managed SqlSession");
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void commit(boolean force) {
     throw new UnsupportedOperationException("Manual commit is not allowed over a Spring managed SqlSession");
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void rollback() {
     throw new UnsupportedOperationException("Manual rollback is not allowed over a Spring managed SqlSession");
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void rollback(boolean force) {
     throw new UnsupportedOperationException("Manual rollback is not allowed over a Spring managed SqlSession");
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void close() {
     throw new UnsupportedOperationException("Manual close is not allowed over a Spring managed SqlSession");
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public void clearCache() {
     this.sqlSessionProxy.clearCache();
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public Configuration getConfiguration() {
     return this.sqlSessionFactory.getConfiguration();
   }
 
-  /**
-   * {@inheritDoc}
-   */
   @Override
   public Connection getConnection() {
     return this.sqlSessionProxy.getConnection();
   }
 
-  /**
-   * {@inheritDoc}
-   *
-   * @since 1.0.2
-   */
   @Override
   public List<BatchResult> flushStatements() {
     return this.sqlSessionProxy.flushStatements();

src/main/java/org/mybatis/spring/SqlSessionUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2023 the original author or authors.
+ * Copyright 2010-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -241,18 +241,12 @@ public SqlSessionSynchronization(SqlSessionHolder holder, SqlSessionFactory sess
       this.sessionFactory = sessionFactory;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public int getOrder() {
       // order right before any Connection synchronization
       return DataSourceUtils.CONNECTION_SYNCHRONIZATION_ORDER - 1;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void suspend() {
       if (this.holderActive) {
@@ -261,9 +255,6 @@ public void suspend() {
       }
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void resume() {
       if (this.holderActive) {
@@ -272,9 +263,6 @@ public void resume() {
       }
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void beforeCommit(boolean readOnly) {
       // Connection commit or rollback will be handled by ConnectionSynchronization or
@@ -300,9 +288,6 @@ public void beforeCommit(boolean readOnly) {
       }
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void beforeCompletion() {
       // Issue #18 Close SqlSession and deregister it now
@@ -317,9 +302,6 @@ public void beforeCompletion() {
       }
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void afterCompletion(int status) {
       if (this.holderActive) {