You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2023/03/29 14:47:07 UTC
[shardingsphere] branch master updated: Add more rules for checkstyle (#24895)
This is an automated email from the ASF dual-hosted git repository.
zhaojinchao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new a32f720cc3d Add more rules for checkstyle (#24895)
a32f720cc3d is described below
commit a32f720cc3d1a0ab52b2b7562cfbeeef732e4149
Author: Liang Zhang <zh...@apache.org>
AuthorDate: Wed Mar 29 22:46:57 2023 +0800
Add more rules for checkstyle (#24895)
---
.../agent/core/spi/AgentServiceLoader.java | 2 +
.../agent/plugin/core/spi/PluginServiceLoader.java | 2 +
.../distsql/handler/query/RQLExecutor.java | 2 +
.../DatabaseRequiredQueryableRALExecutor.java | 2 +
...nstanceContextRequiredQueryableRALExecutor.java | 2 +
.../MetaDataRequiredQueryableRALExecutor.java | 2 +
.../handler/ral/query/QueryableRALExecutor.java | 2 +
.../handler/ral/update/GlobalRuleRALUpdater.java | 3 +
.../api/shadow/column/ColumnShadowAlgorithm.java | 2 +
.../sharding/complex/ComplexKeysShardingValue.java | 2 +
.../api/sharding/hint/HintShardingValue.java | 2 +
.../sharding/standard/PreciseShardingValue.java | 2 +
.../api/sharding/standard/RangeShardingValue.java | 2 +
.../value/ListShardingConditionValue.java | 2 +
.../value/RangeShardingConditionValue.java | 2 +
.../ddl/ShardingDDLStatementValidator.java | 4 +-
.../dml/ShardingDMLStatementValidator.java | 4 +-
.../AbstractCosIdIntervalShardingAlgorithm.java | 2 +
.../sharding/mod/CosIdModShardingAlgorithm.java | 2 +
.../infra/executor/audit/SQLAuditor.java | 2 +
.../infra/util/props/TypedProperties.java | 2 +
.../util/spi/ShardingSphereServiceLoader.java | 2 +
.../api/ingest/position/IngestPosition.java | 2 +
.../ingest/dumper/IncrementalDumperCreator.java | 6 +-
.../api/ingest/position/PrimaryKeyPosition.java | 2 +
.../sqlfederation/row/EmptyRowEnumerator.java | 3 +
.../sqlfederation/row/MemoryEnumerator.java | 2 +
.../row/SQLFederationRowEnumerator.java | 2 +
.../converter/statement/SQLStatementConverter.java | 1 +
.../traffic/executor/TrafficExecutorCallback.java | 2 +
.../cluster/consul/props/ConsulPropertyKey.java | 2 +-
.../distsql/ral/UpdatableRALBackendHandler.java | 2 +
...nectionSessionRequiredQueryableRALExecutor.java | 2 +
.../ConnectionSessionRequiredRALUpdater.java | 2 +
.../handler/distsql/rul/RULBackendHandler.java | 8 +-
.../authentication/AuthenticatorFactory.java | 2 +
.../common/value/collection/CollectionValue.java | 2 +
src/resources/checkstyle.xml | 294 +++++++++++----------
src/resources/checkstyle_ci.xml | 272 ++++++++++---------
.../agent/jdbc/project/vo/response/HttpResult.java | 2 +
.../agent/jdbc/project/vo/response/ResponseVo.java | 4 +-
.../test/e2e/engine/type/dml/BaseDMLE2EIT.java | 2 +-
.../sql/parser/external/ExternalSQLParserIT.java | 2 +-
.../sql/parser/internal/InternalSQLParserIT.java | 2 +-
.../internal/InternalUnsupportedSQLParserIT.java | 2 +-
.../dal/impl/SetParameterStatementAssert.java | 2 +-
46 files changed, 398 insertions(+), 273 deletions(-)
diff --git a/agent/core/src/main/java/org/apache/shardingsphere/agent/core/spi/AgentServiceLoader.java b/agent/core/src/main/java/org/apache/shardingsphere/agent/core/spi/AgentServiceLoader.java
index 6d028090d27..2aa5d5f46f0 100644
--- a/agent/core/src/main/java/org/apache/shardingsphere/agent/core/spi/AgentServiceLoader.java
+++ b/agent/core/src/main/java/org/apache/shardingsphere/agent/core/spi/AgentServiceLoader.java
@@ -28,6 +28,8 @@ import java.util.concurrent.ConcurrentHashMap;
/**
* Agent service loader.
+ *
+ * @param <T> type of service
*/
@Getter
public final class AgentServiceLoader<T> {
diff --git a/agent/plugins/core/src/main/java/org/apache/shardingsphere/agent/plugin/core/spi/PluginServiceLoader.java b/agent/plugins/core/src/main/java/org/apache/shardingsphere/agent/plugin/core/spi/PluginServiceLoader.java
index b8fb41b2307..d9711e7ac61 100644
--- a/agent/plugins/core/src/main/java/org/apache/shardingsphere/agent/plugin/core/spi/PluginServiceLoader.java
+++ b/agent/plugins/core/src/main/java/org/apache/shardingsphere/agent/plugin/core/spi/PluginServiceLoader.java
@@ -27,6 +27,8 @@ import java.util.concurrent.ConcurrentHashMap;
/**
* Plugin service loader.
+ *
+ * @param <T> type of service
*/
public final class PluginServiceLoader<T> {
diff --git a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/query/RQLExecutor.java b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/query/RQLExecutor.java
index 7e29b882873..18271a999fb 100644
--- a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/query/RQLExecutor.java
+++ b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/query/RQLExecutor.java
@@ -27,6 +27,8 @@ import java.util.Collection;
/**
* RQL executor.
+ *
+ * @param <T> type of RQL statement
*/
@SingletonSPI
public interface RQLExecutor<T extends RQLStatement> extends TypedSPI {
diff --git a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/DatabaseRequiredQueryableRALExecutor.java b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/DatabaseRequiredQueryableRALExecutor.java
index 2773966bda6..53aee231216 100644
--- a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/DatabaseRequiredQueryableRALExecutor.java
+++ b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/DatabaseRequiredQueryableRALExecutor.java
@@ -25,6 +25,8 @@ import java.util.Collection;
/**
* Database required queryable RAL executor.
+ *
+ * @param <T> type of queryable RAL statement
*/
public interface DatabaseRequiredQueryableRALExecutor<T extends QueryableRALStatement> extends QueryableRALExecutor<T> {
diff --git a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/InstanceContextRequiredQueryableRALExecutor.java b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/InstanceContextRequiredQueryableRALExecutor.java
index cdc2d3c197b..72bc34d68b1 100644
--- a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/InstanceContextRequiredQueryableRALExecutor.java
+++ b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/InstanceContextRequiredQueryableRALExecutor.java
@@ -25,6 +25,8 @@ import java.util.Collection;
/**
* Instance context required queryable RAL executor.
+ *
+ * @param <T> type of queryable RAL statement
*/
public interface InstanceContextRequiredQueryableRALExecutor<T extends QueryableRALStatement> extends QueryableRALExecutor<T> {
diff --git a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/MetaDataRequiredQueryableRALExecutor.java b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/MetaDataRequiredQueryableRALExecutor.java
index b834830f12e..1045345dd90 100644
--- a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/MetaDataRequiredQueryableRALExecutor.java
+++ b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/MetaDataRequiredQueryableRALExecutor.java
@@ -25,6 +25,8 @@ import java.util.Collection;
/**
* Meta data required queryable RAL executor.
+ *
+ * @param <T> type of queryable RAL statement
*/
public interface MetaDataRequiredQueryableRALExecutor<T extends QueryableRALStatement> extends QueryableRALExecutor<T> {
diff --git a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/QueryableRALExecutor.java b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/QueryableRALExecutor.java
index b056156df5d..968de781e8c 100644
--- a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/QueryableRALExecutor.java
+++ b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/query/QueryableRALExecutor.java
@@ -27,6 +27,8 @@ import java.util.Collections;
/**
* Queryable RAL executor.
+ *
+ * @param <T> type of queryable RAL statement
*/
@SingletonSPI
public interface QueryableRALExecutor<T extends QueryableRALStatement> extends TypedSPI {
diff --git a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/update/GlobalRuleRALUpdater.java b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/update/GlobalRuleRALUpdater.java
index 7d0668ceced..9497c8ef9e6 100644
--- a/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/update/GlobalRuleRALUpdater.java
+++ b/distsql/handler/src/main/java/org/apache/shardingsphere/distsql/handler/ral/update/GlobalRuleRALUpdater.java
@@ -24,6 +24,9 @@ import org.apache.shardingsphere.sql.parser.sql.common.statement.SQLStatement;
/**
* RAL updater for global rule.
+ *
+ * @param <T> type of SQL statement
+ * @param <R> type of rule configuration
*/
@SingletonSPI
public interface GlobalRuleRALUpdater<T extends SQLStatement, R extends RuleConfiguration> extends TypedSPI {
diff --git a/features/shadow/api/src/main/java/org/apache/shardingsphere/shadow/api/shadow/column/ColumnShadowAlgorithm.java b/features/shadow/api/src/main/java/org/apache/shardingsphere/shadow/api/shadow/column/ColumnShadowAlgorithm.java
index 8e7858c5cff..399e5da847b 100644
--- a/features/shadow/api/src/main/java/org/apache/shardingsphere/shadow/api/shadow/column/ColumnShadowAlgorithm.java
+++ b/features/shadow/api/src/main/java/org/apache/shardingsphere/shadow/api/shadow/column/ColumnShadowAlgorithm.java
@@ -22,6 +22,8 @@ import org.apache.shardingsphere.shadow.spi.ShadowAlgorithm;
/**
* Column shadow algorithm.
+ *
+ * @param <T> type of column shadow value
*/
public interface ColumnShadowAlgorithm<T extends Comparable<?>> extends ShadowAlgorithm {
diff --git a/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/complex/ComplexKeysShardingValue.java b/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/complex/ComplexKeysShardingValue.java
index fdd9ffe055f..3ee6d1ac795 100644
--- a/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/complex/ComplexKeysShardingValue.java
+++ b/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/complex/ComplexKeysShardingValue.java
@@ -28,6 +28,8 @@ import java.util.Map;
/**
* Sharding value for complex keys.
+ *
+ * @param <T> type of sharding value
*/
@RequiredArgsConstructor
@Getter
diff --git a/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/hint/HintShardingValue.java b/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/hint/HintShardingValue.java
index 92d7c9c5ca1..15340bdf98d 100644
--- a/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/hint/HintShardingValue.java
+++ b/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/hint/HintShardingValue.java
@@ -26,6 +26,8 @@ import java.util.Collection;
/**
* Sharding value for hint.
+ *
+ * @param <T> type of sharding value
*/
@RequiredArgsConstructor
@Getter
diff --git a/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/standard/PreciseShardingValue.java b/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/standard/PreciseShardingValue.java
index 50524ff2ab0..c5b1d196de4 100644
--- a/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/standard/PreciseShardingValue.java
+++ b/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/standard/PreciseShardingValue.java
@@ -25,6 +25,8 @@ import org.apache.shardingsphere.sharding.api.sharding.ShardingValue;
/**
* Sharding value for precise.
+ *
+ * @param <T> type of sharding value
*/
@RequiredArgsConstructor
@Getter
diff --git a/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/standard/RangeShardingValue.java b/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/standard/RangeShardingValue.java
index 2eee3aa4781..6f04a5c73b9 100644
--- a/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/standard/RangeShardingValue.java
+++ b/features/sharding/api/src/main/java/org/apache/shardingsphere/sharding/api/sharding/standard/RangeShardingValue.java
@@ -26,6 +26,8 @@ import org.apache.shardingsphere.infra.datanode.DataNodeInfo;
/**
* Sharding value for range.
+ *
+ * @param <T> type of sharding value
*/
@RequiredArgsConstructor
@Getter
diff --git a/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/condition/value/ListShardingConditionValue.java b/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/condition/value/ListShardingConditionValue.java
index 522b626714d..76bcbcc2942 100644
--- a/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/condition/value/ListShardingConditionValue.java
+++ b/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/condition/value/ListShardingConditionValue.java
@@ -28,6 +28,8 @@ import java.util.stream.Collectors;
/**
* Sharding condition value for list values.
+ *
+ * @param <T> type of sharding condition value
*/
@RequiredArgsConstructor
@Getter
diff --git a/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/condition/value/RangeShardingConditionValue.java b/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/condition/value/RangeShardingConditionValue.java
index 65c4b2615ab..49aa00f6715 100644
--- a/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/condition/value/RangeShardingConditionValue.java
+++ b/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/condition/value/RangeShardingConditionValue.java
@@ -27,6 +27,8 @@ import java.util.List;
/**
* Sharding condition value for range.
+ *
+ * @param <T> type of sharding condition value
*/
@RequiredArgsConstructor
@Getter
diff --git a/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/validator/ddl/ShardingDDLStatementValidator.java b/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/validator/ddl/ShardingDDLStatementValidator.java
index 597a9c5524c..520330b7ba8 100644
--- a/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/validator/ddl/ShardingDDLStatementValidator.java
+++ b/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/validator/ddl/ShardingDDLStatementValidator.java
@@ -31,7 +31,9 @@ import org.apache.shardingsphere.sql.parser.sql.common.statement.ddl.DDLStatemen
import java.util.Collection;
/**
- * Sharding ddl statement validator.
+ * Sharding DDL statement validator.
+ *
+ * @param <T> type of SQL statement
*/
public abstract class ShardingDDLStatementValidator<T extends DDLStatement> implements ShardingStatementValidator<T> {
diff --git a/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/validator/dml/ShardingDMLStatementValidator.java b/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/validator/dml/ShardingDMLStatementValidator.java
index ac34b00d789..299d5047c26 100644
--- a/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/validator/dml/ShardingDMLStatementValidator.java
+++ b/features/sharding/core/src/main/java/org/apache/shardingsphere/sharding/route/engine/validator/dml/ShardingDMLStatementValidator.java
@@ -43,7 +43,9 @@ import java.util.List;
import java.util.Optional;
/**
- * Sharding dml statement validator.
+ * Sharding DML statement validator.
+ *
+ * @param <T> type of SQL statement
*/
public abstract class ShardingDMLStatementValidator<T extends SQLStatement> implements ShardingStatementValidator<T> {
diff --git a/features/sharding/plugin/cosid/src/main/java/org/apache/shardingsphere/sharding/cosid/algorithm/sharding/interval/AbstractCosIdIntervalShardingAlgorithm.java b/features/sharding/plugin/cosid/src/main/java/org/apache/shardingsphere/sharding/cosid/algorithm/sharding/interval/AbstractCosIdIntervalShardingAlgorithm.java
index 3fc4e1d39bc..c667c6391ee 100644
--- a/features/sharding/plugin/cosid/src/main/java/org/apache/shardingsphere/sharding/cosid/algorithm/sharding/interval/AbstractCosIdIntervalShardingAlgorithm.java
+++ b/features/sharding/plugin/cosid/src/main/java/org/apache/shardingsphere/sharding/cosid/algorithm/sharding/interval/AbstractCosIdIntervalShardingAlgorithm.java
@@ -37,6 +37,8 @@ import java.util.Properties;
/**
* Abstract interval range sharding algorithm with CosId.
+ *
+ * @param <T> type of sharding value
*/
public abstract class AbstractCosIdIntervalShardingAlgorithm<T extends Comparable<?>> implements StandardShardingAlgorithm<T> {
diff --git a/features/sharding/plugin/cosid/src/main/java/org/apache/shardingsphere/sharding/cosid/algorithm/sharding/mod/CosIdModShardingAlgorithm.java b/features/sharding/plugin/cosid/src/main/java/org/apache/shardingsphere/sharding/cosid/algorithm/sharding/mod/CosIdModShardingAlgorithm.java
index a52b1bb14dc..dd5a5a286b3 100644
--- a/features/sharding/plugin/cosid/src/main/java/org/apache/shardingsphere/sharding/cosid/algorithm/sharding/mod/CosIdModShardingAlgorithm.java
+++ b/features/sharding/plugin/cosid/src/main/java/org/apache/shardingsphere/sharding/cosid/algorithm/sharding/mod/CosIdModShardingAlgorithm.java
@@ -30,6 +30,8 @@ import java.util.Properties;
/**
* Modular sharding algorithm with CosId.
+ *
+ * @param <T> type of sharding value
*/
public final class CosIdModShardingAlgorithm<T extends Number & Comparable<T>> implements StandardShardingAlgorithm<T> {
diff --git a/infra/executor/src/main/java/org/apache/shardingsphere/infra/executor/audit/SQLAuditor.java b/infra/executor/src/main/java/org/apache/shardingsphere/infra/executor/audit/SQLAuditor.java
index 2921d03802c..709296a9889 100644
--- a/infra/executor/src/main/java/org/apache/shardingsphere/infra/executor/audit/SQLAuditor.java
+++ b/infra/executor/src/main/java/org/apache/shardingsphere/infra/executor/audit/SQLAuditor.java
@@ -29,6 +29,8 @@ import java.util.List;
/**
* SQL auditor.
+ *
+ * @param <T> type of rule
*/
@SingletonSPI
public interface SQLAuditor<T extends ShardingSphereRule> extends OrderedSPI<T> {
diff --git a/infra/util/src/main/java/org/apache/shardingsphere/infra/util/props/TypedProperties.java b/infra/util/src/main/java/org/apache/shardingsphere/infra/util/props/TypedProperties.java
index b11f9317f23..b07201dc259 100644
--- a/infra/util/src/main/java/org/apache/shardingsphere/infra/util/props/TypedProperties.java
+++ b/infra/util/src/main/java/org/apache/shardingsphere/infra/util/props/TypedProperties.java
@@ -29,6 +29,8 @@ import java.util.Properties;
/**
* Typed properties with a specified enum.
+ *
+ * @param <E> type of enum
*/
public abstract class TypedProperties<E extends Enum<?> & TypedPropertyKey> {
diff --git a/infra/util/src/main/java/org/apache/shardingsphere/infra/util/spi/ShardingSphereServiceLoader.java b/infra/util/src/main/java/org/apache/shardingsphere/infra/util/spi/ShardingSphereServiceLoader.java
index b7a546ef53f..f52278f429e 100644
--- a/infra/util/src/main/java/org/apache/shardingsphere/infra/util/spi/ShardingSphereServiceLoader.java
+++ b/infra/util/src/main/java/org/apache/shardingsphere/infra/util/spi/ShardingSphereServiceLoader.java
@@ -30,6 +30,8 @@ import java.util.concurrent.ConcurrentHashMap;
/**
* ShardingSphere service loader.
+ *
+ * @param <T> type of service
*/
public final class ShardingSphereServiceLoader<T> {
diff --git a/kernel/data-pipeline/api/src/main/java/org/apache/shardingsphere/data/pipeline/api/ingest/position/IngestPosition.java b/kernel/data-pipeline/api/src/main/java/org/apache/shardingsphere/data/pipeline/api/ingest/position/IngestPosition.java
index bb4518c57b9..bfe59754f60 100644
--- a/kernel/data-pipeline/api/src/main/java/org/apache/shardingsphere/data/pipeline/api/ingest/position/IngestPosition.java
+++ b/kernel/data-pipeline/api/src/main/java/org/apache/shardingsphere/data/pipeline/api/ingest/position/IngestPosition.java
@@ -19,6 +19,8 @@ package org.apache.shardingsphere.data.pipeline.api.ingest.position;
/**
* Ingest position.
+ *
+ * @param <T> type of position
*/
public interface IngestPosition<T> extends Comparable<T> {
}
diff --git a/kernel/data-pipeline/api/src/main/java/org/apache/shardingsphere/data/pipeline/spi/ingest/dumper/IncrementalDumperCreator.java b/kernel/data-pipeline/api/src/main/java/org/apache/shardingsphere/data/pipeline/spi/ingest/dumper/IncrementalDumperCreator.java
index cb28abf9f69..79bf3682195 100644
--- a/kernel/data-pipeline/api/src/main/java/org/apache/shardingsphere/data/pipeline/spi/ingest/dumper/IncrementalDumperCreator.java
+++ b/kernel/data-pipeline/api/src/main/java/org/apache/shardingsphere/data/pipeline/spi/ingest/dumper/IncrementalDumperCreator.java
@@ -27,9 +27,11 @@ import org.apache.shardingsphere.infra.util.spi.type.typed.TypedSPI;
/**
* Incremental dumper creator.
+ *
+ * @param <T> type of ingest position
*/
@SingletonSPI
-public interface IncrementalDumperCreator<P> extends TypedSPI {
+public interface IncrementalDumperCreator<T> extends TypedSPI {
/**
* Create incremental dumper.
@@ -40,5 +42,5 @@ public interface IncrementalDumperCreator<P> extends TypedSPI {
* @param metaDataLoader meta data loader
* @return incremental dumper
*/
- IncrementalDumper createIncrementalDumper(DumperConfiguration dumperConfig, IngestPosition<P> position, PipelineChannel channel, PipelineTableMetaDataLoader metaDataLoader);
+ IncrementalDumper createIncrementalDumper(DumperConfiguration dumperConfig, IngestPosition<T> position, PipelineChannel channel, PipelineTableMetaDataLoader metaDataLoader);
}
diff --git a/kernel/data-pipeline/core/src/main/java/org/apache/shardingsphere/data/pipeline/api/ingest/position/PrimaryKeyPosition.java b/kernel/data-pipeline/core/src/main/java/org/apache/shardingsphere/data/pipeline/api/ingest/position/PrimaryKeyPosition.java
index e690e1acad8..ed6d7092fde 100644
--- a/kernel/data-pipeline/core/src/main/java/org/apache/shardingsphere/data/pipeline/api/ingest/position/PrimaryKeyPosition.java
+++ b/kernel/data-pipeline/core/src/main/java/org/apache/shardingsphere/data/pipeline/api/ingest/position/PrimaryKeyPosition.java
@@ -19,6 +19,8 @@ package org.apache.shardingsphere.data.pipeline.api.ingest.position;
/**
* Primary key position.
+ *
+ * @param <T> type of value
*/
public abstract class PrimaryKeyPosition<T> {
diff --git a/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/EmptyRowEnumerator.java b/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/EmptyRowEnumerator.java
index 46e411dd575..be5c7a7acad 100644
--- a/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/EmptyRowEnumerator.java
+++ b/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/EmptyRowEnumerator.java
@@ -23,9 +23,12 @@ import java.lang.reflect.ParameterizedType;
/**
* Empty row enumerator.
+ *
+ * @param <T> type of row
*/
public final class EmptyRowEnumerator<T> implements Enumerator<T> {
+ @SuppressWarnings("unchecked")
@Override
public T current() {
ParameterizedType type = (ParameterizedType) getClass().getGenericSuperclass();
diff --git a/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/MemoryEnumerator.java b/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/MemoryEnumerator.java
index 209ae746b4a..643c49c2f94 100644
--- a/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/MemoryEnumerator.java
+++ b/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/MemoryEnumerator.java
@@ -25,6 +25,8 @@ import java.util.Iterator;
/**
* Memory enumerator.
+ *
+ * @param <T> type of row
*/
public final class MemoryEnumerator<T> implements Enumerator<T> {
diff --git a/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/SQLFederationRowEnumerator.java b/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/SQLFederationRowEnumerator.java
index ba538c19225..8e4cb6e89db 100644
--- a/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/SQLFederationRowEnumerator.java
+++ b/kernel/sql-federation/executor/core/src/main/java/org/apache/shardingsphere/sqlfederation/row/SQLFederationRowEnumerator.java
@@ -27,6 +27,8 @@ import java.util.Iterator;
/**
* SQL federation row enumerator.
+ *
+ * @param <T> type of row
*/
public final class SQLFederationRowEnumerator<T> implements Enumerator<T> {
diff --git a/kernel/sql-federation/optimizer/src/main/java/org/apache/shardingsphere/sqlfederation/optimizer/converter/statement/SQLStatementConverter.java b/kernel/sql-federation/optimizer/src/main/java/org/apache/shardingsphere/sqlfederation/optimizer/converter/statement/SQLStatementConverter.java
index 75008d3a0dd..1a28955badc 100644
--- a/kernel/sql-federation/optimizer/src/main/java/org/apache/shardingsphere/sqlfederation/optimizer/converter/statement/SQLStatementConverter.java
+++ b/kernel/sql-federation/optimizer/src/main/java/org/apache/shardingsphere/sqlfederation/optimizer/converter/statement/SQLStatementConverter.java
@@ -23,6 +23,7 @@ import org.apache.shardingsphere.sql.parser.sql.common.statement.SQLStatement;
/**
* SQL Statement converter.
*
+ * @param <S> type of SQL node
* @param <T> type of SQL statement
*/
public interface SQLStatementConverter<S extends SQLStatement, T extends SqlNode> {
diff --git a/kernel/traffic/core/src/main/java/org/apache/shardingsphere/traffic/executor/TrafficExecutorCallback.java b/kernel/traffic/core/src/main/java/org/apache/shardingsphere/traffic/executor/TrafficExecutorCallback.java
index f2bf4b7e789..bc6a5140d37 100644
--- a/kernel/traffic/core/src/main/java/org/apache/shardingsphere/traffic/executor/TrafficExecutorCallback.java
+++ b/kernel/traffic/core/src/main/java/org/apache/shardingsphere/traffic/executor/TrafficExecutorCallback.java
@@ -22,6 +22,8 @@ import java.sql.Statement;
/**
* Traffic executor callback.
+ *
+ * @param <T> type of return value
*/
public interface TrafficExecutorCallback<T> {
diff --git a/mode/type/cluster/repository/provider/consul/src/main/java/org/apache/shardingsphere/mode/repository/cluster/consul/props/ConsulPropertyKey.java b/mode/type/cluster/repository/provider/consul/src/main/java/org/apache/shardingsphere/mode/repository/cluster/consul/props/ConsulPropertyKey.java
index 2cfc100b326..7b4aa8f427d 100644
--- a/mode/type/cluster/repository/provider/consul/src/main/java/org/apache/shardingsphere/mode/repository/cluster/consul/props/ConsulPropertyKey.java
+++ b/mode/type/cluster/repository/provider/consul/src/main/java/org/apache/shardingsphere/mode/repository/cluster/consul/props/ConsulPropertyKey.java
@@ -34,7 +34,7 @@ public enum ConsulPropertyKey implements TypedPropertyKey {
TIME_TO_LIVE_SECONDS("timeToLiveSeconds", "30s", String.class),
/**
- *Block query time seconds.
+ * Block query time seconds.
*/
BLOCK_QUERY_TIME_TO_SECONDS("blockQueryTimeToSeconds", "60", long.class);
diff --git a/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/UpdatableRALBackendHandler.java b/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/UpdatableRALBackendHandler.java
index e3a449c0931..26057df4280 100644
--- a/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/UpdatableRALBackendHandler.java
+++ b/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/UpdatableRALBackendHandler.java
@@ -30,6 +30,8 @@ import java.sql.SQLException;
/**
* Updatable RAL backend handler.
+ *
+ * @param <T> type of SQL statement
*/
@RequiredArgsConstructor
public final class UpdatableRALBackendHandler<T extends UpdatableRALStatement> implements RALBackendHandler {
diff --git a/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/queryable/executor/ConnectionSessionRequiredQueryableRALExecutor.java b/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/queryable/executor/ConnectionSessionRequiredQueryableRALExecutor.java
index 69cdb2bae36..9d2e088986c 100644
--- a/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/queryable/executor/ConnectionSessionRequiredQueryableRALExecutor.java
+++ b/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/queryable/executor/ConnectionSessionRequiredQueryableRALExecutor.java
@@ -27,6 +27,8 @@ import java.util.Collection;
/**
* Connection session required queryable RAL executor.
+ *
+ * @param <T> type of SQL statement
*/
public interface ConnectionSessionRequiredQueryableRALExecutor<T extends QueryableRALStatement> extends QueryableRALExecutor<T> {
diff --git a/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/updatable/updater/ConnectionSessionRequiredRALUpdater.java b/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/updatable/updater/ConnectionSessionRequiredRALUpdater.java
index 23a17def2e3..3da6febd9fb 100644
--- a/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/updatable/updater/ConnectionSessionRequiredRALUpdater.java
+++ b/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/ral/updatable/updater/ConnectionSessionRequiredRALUpdater.java
@@ -25,6 +25,8 @@ import java.sql.SQLException;
/**
* Connection session required RAL updater.
+ *
+ * @param <T> type of SQL statement
*/
public interface ConnectionSessionRequiredRALUpdater<T extends SQLStatement> extends RALUpdater<T> {
diff --git a/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/rul/RULBackendHandler.java b/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/rul/RULBackendHandler.java
index fb50b830d90..8ed91678100 100644
--- a/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/rul/RULBackendHandler.java
+++ b/proxy/backend/core/src/main/java/org/apache/shardingsphere/proxy/backend/handler/distsql/rul/RULBackendHandler.java
@@ -24,11 +24,13 @@ import org.apache.shardingsphere.proxy.backend.session.ConnectionSession;
/**
* RUL backend handler.
+ *
+ * @param <T> type of SQL statement
*/
@Getter
-public abstract class RULBackendHandler<E extends RULStatement> implements DistSQLBackendHandler {
+public abstract class RULBackendHandler<T extends RULStatement> implements DistSQLBackendHandler {
- private E sqlStatement;
+ private T sqlStatement;
private ConnectionSession connectionSession;
@@ -39,7 +41,7 @@ public abstract class RULBackendHandler<E extends RULStatement> implements DistS
* @param connectionSession connection session
*/
public final void init(final RULStatement sqlStatement, final ConnectionSession connectionSession) {
- this.sqlStatement = (E) sqlStatement;
+ this.sqlStatement = (T) sqlStatement;
this.connectionSession = connectionSession;
}
}
diff --git a/proxy/frontend/core/src/main/java/org/apache/shardingsphere/proxy/frontend/authentication/AuthenticatorFactory.java b/proxy/frontend/core/src/main/java/org/apache/shardingsphere/proxy/frontend/authentication/AuthenticatorFactory.java
index af1c38bd0a0..620952d01f8 100644
--- a/proxy/frontend/core/src/main/java/org/apache/shardingsphere/proxy/frontend/authentication/AuthenticatorFactory.java
+++ b/proxy/frontend/core/src/main/java/org/apache/shardingsphere/proxy/frontend/authentication/AuthenticatorFactory.java
@@ -26,6 +26,8 @@ import java.util.Arrays;
/**
* Authenticator factory.
+ *
+ * @param <E> type of enum
*/
@RequiredArgsConstructor
public final class AuthenticatorFactory<E extends Enum<E> & AuthenticatorType> {
diff --git a/sql-parser/statement/src/main/java/org/apache/shardingsphere/sql/parser/sql/common/value/collection/CollectionValue.java b/sql-parser/statement/src/main/java/org/apache/shardingsphere/sql/parser/sql/common/value/collection/CollectionValue.java
index 8b7c15398c9..db0704f1ef1 100644
--- a/sql-parser/statement/src/main/java/org/apache/shardingsphere/sql/parser/sql/common/value/collection/CollectionValue.java
+++ b/sql-parser/statement/src/main/java/org/apache/shardingsphere/sql/parser/sql/common/value/collection/CollectionValue.java
@@ -25,6 +25,8 @@ import java.util.LinkedList;
/**
* Collection value.
+ *
+ * @param <T> type of collection value
*/
@Getter
public final class CollectionValue<T> implements ValueASTNode<Collection> {
diff --git a/src/resources/checkstyle.xml b/src/resources/checkstyle.xml
index c96132c7550..d03e5372427 100644
--- a/src/resources/checkstyle.xml
+++ b/src/resources/checkstyle.xml
@@ -41,98 +41,6 @@
</module>
<module name="TreeWalker">
- <!-- Naming Conventions -->
- <module name="AbbreviationAsWordInName">
- <property name="allowedAbbreviationLength" value="8" />
- </module>
- <module name="CatchParameterName" />
- <module name="ClassTypeParameterName" />
- <module name="ConstantName" />
- <module name="InterfaceTypeParameterName" />
- <module name="LambdaParameterName" />
- <module name="LocalFinalVariableName" />
- <module name="LocalVariableName" />
- <module name="MemberName" />
- <module name="MethodName" />
- <module name="MethodTypeParameterName" />
- <module name="PackageName">
- <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
- </module>
- <module name="ParameterName" />
- <module name="PatternVariableName" />
- <module name="RecordComponentName" />
- <module name="RecordTypeParameterName" />
- <module name="StaticVariableName" />
- <module name="TypeName" />
-
- <!-- Size Violations -->
- <module name="AnonInnerLength" />
- <module name="ExecutableStatementCount">
- <property name="max" value="50" />
- </module>
- <module name="LambdaBodyLength" />
- <module name="MethodCount" />
- <module name="MethodLength" />
- <module name="OuterTypeNumber" />
- <module name="ParameterNumber" />
- <module name="RecordComponentNumber" />
-
- <!-- Whitespace -->
- <module name="EmptyForInitializerPad" />
- <module name="EmptyForIteratorPad" />
- <module name="EmptyLineSeparator">
- <property name="allowMultipleEmptyLines" value="false" />
- <property name="allowMultipleEmptyLinesInsideClassMembers" value="false" />
- </module>
- <module name="GenericWhitespace" />
- <module name="MethodParamPad" />
- <module name="NoLineWrap" />
- <module name="NoWhitespaceAfter" />
- <module name="NoWhitespaceBefore" />
- <module name="NoWhitespaceBeforeCaseDefaultColon" />
- <module name="OperatorWrap" />
- <module name="ParenPad" />
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapDot" />
- <property name="tokens" value="DOT" />
- <property name="option" value="nl" />
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapComma" />
- <property name="tokens" value="COMMA" />
- <property name="option" value="EOL" />
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapEllipsis" />
- <property name="tokens" value="ELLIPSIS" />
- <property name="option" value="EOL" />
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapArrayDeclarator" />
- <property name="tokens" value="ARRAY_DECLARATOR" />
- <property name="option" value="EOL" />
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapMethodRef" />
- <property name="tokens" value="METHOD_REF" />
- <property name="option" value="nl" />
- </module>
- <module name="SingleSpaceSeparator">
- <property name="validateComments" value="true" />
- </module>
- <module name="TypecastParenPad" />
- <module name="WhitespaceAfter" />
- <module name="WhitespaceAround" />
-
- <!-- Imports -->
- <module name="AvoidStarImport" />
- <module name="AvoidStaticImport">
- <property name="excludes" value="org.junit.jupiter.api.Assertions.*,org.junit.jupiter.api.Assumptions.*,org.hamcrest.Matchers.*,org.hamcrest.CoreMatchers.*,org.hamcrest.MatcherAssert.*,org.mockito.Mockito.*,org.mockito.ArgumentMatchers.*" />
- </module>
- <module name="IllegalImport" />
- <module name="RedundantImport" />
- <module name="UnusedImports" />
-
<!-- Annotations -->
<module name="AnnotationLocation">
<property name="id" value="AnnotationLocationMostCases" />
@@ -150,9 +58,29 @@
<module name="SuppressWarnings" />
<module name="SuppressWarningsHolder" />
- <!-- Modifiers -->
- <module name="ModifierOrder" />
- <module name="RedundantModifier" />
+ <!-- Block Checks -->
+ <module name="AvoidNestedBlocks" />
+ <module name="EmptyBlock" />
+ <module name="EmptyCatchBlock">
+ <property name="exceptionVariableName" value="expected|ignore" />
+ </module>
+ <module name="LeftCurly" />
+ <module name="RightCurly" />
+ <module name="NeedBraces" />
+
+ <!-- Class Design -->
+ <module name="DesignForExtension" />
+ <module name="FinalClass" />
+ <!-- cannot recognize for lombok @NoArgsConstructor(access = AccessLevel.PRIVATE), just ignore -->
+ <!--<module name="HideUtilityClassConstructor" />-->
+ <module name="InnerTypeLast" />
+ <module name="InterfaceIsType" />
+ <module name="MutableException" />
+ <module name="OneTopLevelClass" />
+ <module name="ThrowsCount">
+ <property name="ignorePrivateMethods" value="false" />
+ </module>
+ <module name="VisibilityModifier" />
<!-- Coding -->
<module name="AvoidDoubleBraceInitialization" />
@@ -204,27 +132,53 @@
<module name="UnusedLocalVariable" />
<module name="VariableDeclarationUsageDistance" />
- <!-- Block Checks -->
- <module name="EmptyBlock" />
- <module name="EmptyCatchBlock">
- <property name="exceptionVariableName" value="expected|ignore" />
+ <!-- Imports -->
+ <module name="AvoidStarImport" />
+ <module name="AvoidStaticImport">
+ <property name="excludes" value="org.junit.jupiter.api.Assertions.*,org.junit.jupiter.api.Assumptions.*,org.hamcrest.Matchers.*,org.hamcrest.CoreMatchers.*,org.hamcrest.MatcherAssert.*,org.mockito.Mockito.*,org.mockito.ArgumentMatchers.*" />
</module>
- <module name="AvoidNestedBlocks" />
- <module name="NeedBraces" />
- <module name="LeftCurly" />
- <module name="RightCurly" />
+ <module name="IllegalImport" />
+ <module name="RedundantImport" />
+ <module name="UnusedImports" />
- <!-- Class Design -->
- <module name="DesignForExtension" />
- <module name="FinalClass" />
- <!-- cannot recognize for lombok @NoArgsConstructor(access = AccessLevel.PRIVATE), just ignore -->
- <!--<module name="HideUtilityClassConstructor" />-->
- <module name="OneTopLevelClass" />
- <module name="InterfaceIsType" />
- <module name="InnerTypeLast" />
- <module name="VisibilityModifier" />
- <module name="MutableException" />
- <module name="ThrowsCount" />
+ <!-- Javadoc Comments -->
+ <module name="AtclauseOrder">
+ <property name="tagOrder" value="@param, @return, @throws, @deprecated" />
+ </module>
+ <module name="InvalidJavadocPosition" />
+ <module name="JavadocBlockTagLocation" />
+ <module name="JavadocContentLocation" />
+ <module name="JavadocMethod">
+ <property name="allowedAnnotations" value="Override, Test, BeforeEach, AfterEach, BeforeAll, AfterAll, ParameterizedTest" />
+ <property name="validateThrows" value="true" />
+ <property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF" />
+ </module>
+ <module name="JavadocMissingLeadingAsterisk" />
+ <module name="JavadocMissingWhitespaceAfterAsterisk" />
+ <module name="JavadocParagraph">
+ <property name="violateExecutionOnNonTightHtml" value="true" />
+ <property name="allowNewlineParagraph" value="false" />
+ </module>
+ <module name="JavadocStyle" />
+ <module name="JavadocTagContinuationIndentation">
+ <property name="violateExecutionOnNonTightHtml" value="true" />
+ </module>
+ <module name="JavadocType" />
+ <module name="MissingJavadocMethod">
+ <property name="allowMissingPropertyJavadoc" value="true" />
+ <property name="tokens" value="METHOD_DEF" />
+ </module>
+ <module name="MissingJavadocPackage" />
+ <module name="NonEmptyAtclauseDescription">
+ <property name="violateExecutionOnNonTightHtml" value="true" />
+ </module>
+ <module name="SingleLineJavadoc">
+ <property name="violateExecutionOnNonTightHtml" value="true" />
+ <property name="ignoreInlineTags" value="false" />
+ </module>
+ <module name="SummaryJavadoc">
+ <property name="violateExecutionOnNonTightHtml" value="true" />
+ </module>
<!-- Metrics -->
<module name="BooleanExpressionComplexity" />
@@ -233,44 +187,114 @@
</module>
<module name="ClassFanOutComplexity" />
<module name="CyclomaticComplexity" />
- <module name="NPathComplexity" />
<module name="JavaNCSS" />
+ <module name="NPathComplexity" />
<!-- Miscellaneous -->
<module name="ArrayTypeStyle" />
- <module name="UpperEll" />
<module name="AvoidEscapedUnicodeCharacters" />
+ <module name="CommentsIndentation" />
<module name="DescendantToken" />
<module name="FinalParameters" />
- <module name="Indentation" />
+ <module name="Indentation">
+ <property name="arrayInitIndent" value="2" />
+ <property name="lineWrappingIndentation" value="8" />
+ </module>
+ <module name="NoCodeInFile" />
<module name="OuterTypeFilename" />
<module name="TodoComment" />
<module name="TrailingComment" />
<module name="UncommentedMain">
<property name="excludedClasses" value="\.Bootstrap" />
</module>
+ <module name="UpperEll" />
- <!-- Javadoc Comments -->
- <module name="AtclauseOrder">
- <property name="tagOrder" value="@param, @return, @throws, @deprecated" />
+ <!-- Modifiers -->
+ <module name="ModifierOrder" />
+ <module name="RedundantModifier" />
+
+ <!-- Naming Conventions -->
+ <module name="AbbreviationAsWordInName">
+ <property name="allowedAbbreviationLength" value="8" />
</module>
- <module name="InvalidJavadocPosition" />
- <module name="NonEmptyAtclauseDescription" />
- <module name="JavadocParagraph" />
- <module name="JavadocStyle" />
- <module name="JavadocTagContinuationIndentation" />
- <module name="SingleLineJavadoc" />
- <module name="SummaryJavadoc" />
- <!--
- <module name="JavadocType">
- <property name="scope" value="public" />
+ <module name="CatchParameterName" />
+ <module name="ClassTypeParameterName" />
+ <module name="ConstantName" />
+ <module name="InterfaceTypeParameterName" />
+ <module name="LambdaParameterName" />
+ <module name="LocalFinalVariableName" />
+ <module name="LocalVariableName" />
+ <module name="MemberName" />
+ <module name="MethodName" />
+ <module name="MethodTypeParameterName" />
+ <module name="PackageName">
+ <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
</module>
- -->
- <module name="JavadocMethod">
- <property name="allowedAnnotations" value="Override, Test, BeforeEach, AfterEach, BeforeAll, AfterAll, ParameterizedTest" />
- <property name="validateThrows" value="true" />
- <property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF" />
+ <module name="ParameterName" />
+ <module name="PatternVariableName" />
+ <module name="RecordComponentName" />
+ <module name="RecordTypeParameterName" />
+ <module name="StaticVariableName" />
+ <module name="TypeName" />
+
+ <!-- Size Violations -->
+ <module name="AnonInnerLength" />
+ <module name="ExecutableStatementCount">
+ <property name="max" value="50" />
+ </module>
+ <module name="LambdaBodyLength" />
+ <module name="MethodCount" />
+ <module name="MethodLength" />
+ <module name="OuterTypeNumber" />
+ <module name="ParameterNumber" />
+ <module name="RecordComponentNumber" />
+
+ <!-- Whitespace -->
+ <module name="EmptyForInitializerPad" />
+ <module name="EmptyForIteratorPad" />
+ <module name="EmptyLineSeparator">
+ <property name="allowMultipleEmptyLines" value="false" />
+ <property name="allowMultipleEmptyLinesInsideClassMembers" value="false" />
</module>
+ <module name="GenericWhitespace" />
+ <module name="MethodParamPad" />
+ <module name="NoLineWrap" />
+ <module name="NoWhitespaceAfter" />
+ <module name="NoWhitespaceBefore" />
+ <module name="NoWhitespaceBeforeCaseDefaultColon" />
+ <module name="OperatorWrap" />
+ <module name="ParenPad" />
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapDot" />
+ <property name="tokens" value="DOT" />
+ <property name="option" value="nl" />
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapComma" />
+ <property name="tokens" value="COMMA" />
+ <property name="option" value="EOL" />
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapEllipsis" />
+ <property name="tokens" value="ELLIPSIS" />
+ <property name="option" value="EOL" />
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapArrayDeclarator" />
+ <property name="tokens" value="ARRAY_DECLARATOR" />
+ <property name="option" value="EOL" />
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapMethodRef" />
+ <property name="tokens" value="METHOD_REF" />
+ <property name="option" value="nl" />
+ </module>
+ <module name="SingleSpaceSeparator">
+ <property name="validateComments" value="true" />
+ </module>
+ <module name="TypecastParenPad" />
+ <module name="WhitespaceAfter" />
+ <module name="WhitespaceAround" />
<!-- Filters -->
<module name="SuppressionCommentFilter" />
diff --git a/src/resources/checkstyle_ci.xml b/src/resources/checkstyle_ci.xml
index b3a662d5cd7..c2dd8e4f44b 100644
--- a/src/resources/checkstyle_ci.xml
+++ b/src/resources/checkstyle_ci.xml
@@ -34,100 +34,12 @@
<module name="Translation" />
<module name="UniqueProperties" />
<module name="SeverityMatchFilter" />
-
<module name="LineLength">
<property name="fileExtensions" value="java" />
<property name="max" value="200" />
</module>
<module name="TreeWalker">
- <!-- Naming Conventions -->
- <module name="AbbreviationAsWordInName">
- <property name="allowedAbbreviationLength" value="8" />
- </module>
- <module name="CatchParameterName" />
- <module name="ClassTypeParameterName" />
- <module name="ConstantName" />
- <module name="InterfaceTypeParameterName" />
- <module name="LambdaParameterName" />
- <module name="LocalFinalVariableName" />
- <module name="LocalVariableName" />
- <module name="MemberName" />
- <module name="MethodName" />
- <module name="MethodTypeParameterName" />
- <module name="PackageName">
- <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
- </module>
- <module name="ParameterName" />
- <module name="PatternVariableName" />
- <module name="RecordComponentName" />
- <module name="RecordTypeParameterName" />
- <module name="StaticVariableName" />
- <module name="TypeName" />
-
- <!-- Size Violations -->
- <module name="AnonInnerLength" />
- <module name="LambdaBodyLength" />
- <module name="MethodLength" />
- <module name="OuterTypeNumber" />
- <module name="RecordComponentNumber" />
-
- <!-- Whitespace -->
- <module name="EmptyForInitializerPad" />
- <module name="EmptyForIteratorPad" />
- <module name="EmptyLineSeparator">
- <property name="allowMultipleEmptyLines" value="false" />
- <property name="allowMultipleEmptyLinesInsideClassMembers" value="false" />
- </module>
- <module name="GenericWhitespace" />
- <module name="MethodParamPad" />
- <module name="NoLineWrap" />
- <module name="NoWhitespaceAfter" />
- <module name="NoWhitespaceBefore" />
- <module name="NoWhitespaceBeforeCaseDefaultColon" />
- <module name="OperatorWrap" />
- <module name="ParenPad" />
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapDot" />
- <property name="tokens" value="DOT" />
- <property name="option" value="nl" />
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapComma" />
- <property name="tokens" value="COMMA" />
- <property name="option" value="EOL" />
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapEllipsis" />
- <property name="tokens" value="ELLIPSIS" />
- <property name="option" value="EOL" />
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapArrayDeclarator" />
- <property name="tokens" value="ARRAY_DECLARATOR" />
- <property name="option" value="EOL" />
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapMethodRef" />
- <property name="tokens" value="METHOD_REF" />
- <property name="option" value="nl" />
- </module>
- <module name="SingleSpaceSeparator">
- <property name="validateComments" value="true" />
- </module>
- <module name="TypecastParenPad" />
- <module name="WhitespaceAfter" />
- <module name="WhitespaceAround" />
-
- <!-- Imports -->
- <module name="AvoidStarImport" />
- <module name="AvoidStaticImport">
- <property name="excludes" value="org.junit.jupiter.api.Assertions.*,org.junit.jupiter.api.Assumptions.*,org.hamcrest.Matchers.*,org.hamcrest.CoreMatchers.*,org.hamcrest.MatcherAssert.*,org.mockito.Mockito.*,org.mockito.ArgumentMatchers.*" />
- </module>
- <module name="IllegalImport" />
- <module name="RedundantImport" />
- <module name="UnusedImports" />
-
<!-- Annotations -->
<module name="AnnotationLocation">
<property name="id" value="AnnotationLocationMostCases" />
@@ -145,9 +57,28 @@
<module name="SuppressWarnings" />
<module name="SuppressWarningsHolder" />
- <!-- Modifiers -->
- <module name="ModifierOrder" />
- <module name="RedundantModifier" />
+ <!-- Block Checks -->
+ <module name="AvoidNestedBlocks" />
+ <module name="EmptyBlock" />
+ <module name="EmptyCatchBlock">
+ <property name="exceptionVariableName" value="expected|ignore" />
+ </module>
+ <module name="LeftCurly" />
+ <module name="RightCurly" />
+ <module name="NeedBraces" />
+
+ <!-- Class Design -->
+ <module name="FinalClass" />
+ <!-- cannot recognize for lombok @NoArgsConstructor(access = AccessLevel.PRIVATE), just ignore -->
+ <!--<module name="HideUtilityClassConstructor" />-->
+ <module name="InnerTypeLast" />
+ <module name="InterfaceIsType" />
+ <module name="MutableException" />
+ <module name="OneTopLevelClass" />
+ <module name="ThrowsCount">
+ <property name="ignorePrivateMethods" value="false" />
+ </module>
+ <module name="VisibilityModifier" />
<!-- Coding -->
<module name="AvoidDoubleBraceInitialization" />
@@ -196,61 +127,154 @@
<module name="UnusedLocalVariable" />
<module name="VariableDeclarationUsageDistance" />
- <!-- Block Checks -->
- <module name="EmptyBlock" />
- <module name="EmptyCatchBlock">
- <property name="exceptionVariableName" value="expected|ignore" />
+ <!-- Imports -->
+ <module name="AvoidStarImport" />
+ <module name="AvoidStaticImport">
+ <property name="excludes" value="org.junit.jupiter.api.Assertions.*,org.junit.jupiter.api.Assumptions.*,org.hamcrest.Matchers.*,org.hamcrest.CoreMatchers.*,org.hamcrest.MatcherAssert.*,org.mockito.Mockito.*,org.mockito.ArgumentMatchers.*" />
</module>
- <module name="AvoidNestedBlocks" />
- <module name="NeedBraces" />
- <module name="LeftCurly" />
- <module name="RightCurly" />
+ <module name="IllegalImport" />
+ <module name="RedundantImport" />
+ <module name="UnusedImports" />
- <!-- Class Design -->
- <module name="FinalClass" />
- <!-- cannot recognize for lombok @NoArgsConstructor(access = AccessLevel.PRIVATE), just ignore -->
- <!--<module name="HideUtilityClassConstructor" />-->
- <module name="OneTopLevelClass" />
- <module name="InterfaceIsType" />
- <module name="InnerTypeLast" />
- <module name="VisibilityModifier" />
- <module name="MutableException" />
- <module name="ThrowsCount" />
+ <!-- Javadoc Comments -->
+ <module name="AtclauseOrder">
+ <property name="tagOrder" value="@param, @return, @throws, @deprecated" />
+ </module>
+ <module name="InvalidJavadocPosition" />
+ <module name="JavadocBlockTagLocation" />
+ <module name="JavadocContentLocation" />
+ <module name="JavadocMethod">
+ <property name="allowedAnnotations" value="Override, Test, BeforeEach, AfterEach, BeforeAll, AfterAll, ParameterizedTest" />
+ <property name="validateThrows" value="true" />
+ <property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF" />
+ </module>
+ <module name="JavadocMissingLeadingAsterisk" />
+ <module name="JavadocMissingWhitespaceAfterAsterisk" />
+ <module name="JavadocParagraph">
+ <property name="violateExecutionOnNonTightHtml" value="true" />
+ <property name="allowNewlineParagraph" value="false" />
+ </module>
+ <module name="JavadocStyle" />
+ <module name="JavadocTagContinuationIndentation">
+ <property name="violateExecutionOnNonTightHtml" value="true" />
+ </module>
+ <module name="JavadocType" />
+ <module name="MissingJavadocMethod">
+ <property name="allowMissingPropertyJavadoc" value="true" />
+ <property name="tokens" value="METHOD_DEF" />
+ </module>
+ <module name="MissingJavadocPackage" />
+ <module name="NonEmptyAtclauseDescription">
+ <property name="violateExecutionOnNonTightHtml" value="true" />
+ </module>
+ <module name="SingleLineJavadoc">
+ <property name="violateExecutionOnNonTightHtml" value="true" />
+ <property name="ignoreInlineTags" value="false" />
+ </module>
+ <module name="SummaryJavadoc">
+ <property name="violateExecutionOnNonTightHtml" value="true" />
+ </module>
<!-- Miscellaneous -->
<module name="ArrayTypeStyle" />
- <module name="UpperEll" />
<module name="AvoidEscapedUnicodeCharacters" />
+ <module name="CommentsIndentation" />
<module name="DescendantToken" />
<module name="FinalParameters" />
<module name="Indentation">
<property name="arrayInitIndent" value="2" />
<property name="lineWrappingIndentation" value="8" />
</module>
+ <module name="NoCodeInFile" />
<module name="OuterTypeFilename" />
<module name="TodoComment" />
<module name="TrailingComment" />
<module name="UncommentedMain">
<property name="excludedClasses" value="\.Bootstrap" />
</module>
+ <module name="UpperEll" />
- <!-- Javadoc Comments -->
- <module name="AtclauseOrder">
- <property name="tagOrder" value="@param, @return, @throws, @deprecated" />
+ <!-- Modifiers -->
+ <module name="ModifierOrder" />
+ <module name="RedundantModifier" />
+
+ <!-- Naming Conventions -->
+ <module name="AbbreviationAsWordInName">
+ <property name="allowedAbbreviationLength" value="8" />
</module>
- <module name="InvalidJavadocPosition" />
- <module name="NonEmptyAtclauseDescription" />
- <module name="JavadocParagraph" />
- <module name="JavadocStyle" />
- <module name="JavadocTagContinuationIndentation" />
- <module name="SingleLineJavadoc" />
- <module name="SummaryJavadoc" />
+ <module name="CatchParameterName" />
+ <module name="ClassTypeParameterName" />
+ <module name="ConstantName" />
+ <module name="InterfaceTypeParameterName" />
+ <module name="LambdaParameterName" />
+ <module name="LocalFinalVariableName" />
+ <module name="LocalVariableName" />
+ <module name="MemberName" />
+ <module name="MethodName" />
+ <module name="MethodTypeParameterName" />
+ <module name="PackageName">
+ <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
+ </module>
+ <module name="ParameterName" />
+ <module name="PatternVariableName" />
+ <module name="RecordComponentName" />
+ <module name="RecordTypeParameterName" />
+ <module name="StaticVariableName" />
+ <module name="TypeName" />
- <module name="JavadocMethod">
- <property name="allowedAnnotations" value="Override, Test, BeforeEach, AfterEach, BeforeAll, AfterAll, ParameterizedTest" />
- <property name="validateThrows" value="true" />
- <property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF" />
+ <!-- Size Violations -->
+ <module name="AnonInnerLength" />
+ <module name="LambdaBodyLength" />
+ <module name="MethodLength" />
+ <module name="OuterTypeNumber" />
+ <module name="RecordComponentNumber" />
+
+ <!-- Whitespace -->
+ <module name="EmptyForInitializerPad" />
+ <module name="EmptyForIteratorPad" />
+ <module name="EmptyLineSeparator">
+ <property name="allowMultipleEmptyLines" value="false" />
+ <property name="allowMultipleEmptyLinesInsideClassMembers" value="false" />
+ </module>
+ <module name="GenericWhitespace" />
+ <module name="MethodParamPad" />
+ <module name="NoLineWrap" />
+ <module name="NoWhitespaceAfter" />
+ <module name="NoWhitespaceBefore" />
+ <module name="NoWhitespaceBeforeCaseDefaultColon" />
+ <module name="OperatorWrap" />
+ <module name="ParenPad" />
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapDot" />
+ <property name="tokens" value="DOT" />
+ <property name="option" value="nl" />
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapComma" />
+ <property name="tokens" value="COMMA" />
+ <property name="option" value="EOL" />
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapEllipsis" />
+ <property name="tokens" value="ELLIPSIS" />
+ <property name="option" value="EOL" />
+ </module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapArrayDeclarator" />
+ <property name="tokens" value="ARRAY_DECLARATOR" />
+ <property name="option" value="EOL" />
</module>
+ <module name="SeparatorWrap">
+ <property name="id" value="SeparatorWrapMethodRef" />
+ <property name="tokens" value="METHOD_REF" />
+ <property name="option" value="nl" />
+ </module>
+ <module name="SingleSpaceSeparator">
+ <property name="validateComments" value="true" />
+ </module>
+ <module name="TypecastParenPad" />
+ <module name="WhitespaceAfter" />
+ <module name="WhitespaceAround" />
<!-- Filters -->
<module name="SuppressionCommentFilter" />
diff --git a/test/e2e/agent/jdbc-project/src/main/java/org/apache/shardingsphere/test/e2e/agent/jdbc/project/vo/response/HttpResult.java b/test/e2e/agent/jdbc-project/src/main/java/org/apache/shardingsphere/test/e2e/agent/jdbc/project/vo/response/HttpResult.java
index 33df77b594c..56fc2cd5ab9 100644
--- a/test/e2e/agent/jdbc-project/src/main/java/org/apache/shardingsphere/test/e2e/agent/jdbc/project/vo/response/HttpResult.java
+++ b/test/e2e/agent/jdbc-project/src/main/java/org/apache/shardingsphere/test/e2e/agent/jdbc/project/vo/response/HttpResult.java
@@ -25,6 +25,8 @@ import java.io.Serializable;
/**
* Http result.
+ *
+ * @param <T> type of data
*/
@NoArgsConstructor
@Getter
diff --git a/test/e2e/agent/jdbc-project/src/main/java/org/apache/shardingsphere/test/e2e/agent/jdbc/project/vo/response/ResponseVo.java b/test/e2e/agent/jdbc-project/src/main/java/org/apache/shardingsphere/test/e2e/agent/jdbc/project/vo/response/ResponseVo.java
index 27f5f5760bb..2ffa482d612 100644
--- a/test/e2e/agent/jdbc-project/src/main/java/org/apache/shardingsphere/test/e2e/agent/jdbc/project/vo/response/ResponseVo.java
+++ b/test/e2e/agent/jdbc-project/src/main/java/org/apache/shardingsphere/test/e2e/agent/jdbc/project/vo/response/ResponseVo.java
@@ -21,7 +21,9 @@ import lombok.Getter;
import lombok.Setter;
/**
- * Response vo.
+ * Response VO.
+ *
+ * @param <T> type of data
*/
@Getter
@Setter
diff --git a/test/e2e/sql/src/test/java/org/apache/shardingsphere/test/e2e/engine/type/dml/BaseDMLE2EIT.java b/test/e2e/sql/src/test/java/org/apache/shardingsphere/test/e2e/engine/type/dml/BaseDMLE2EIT.java
index b589b1a30d0..a902b1a95fa 100644
--- a/test/e2e/sql/src/test/java/org/apache/shardingsphere/test/e2e/engine/type/dml/BaseDMLE2EIT.java
+++ b/test/e2e/sql/src/test/java/org/apache/shardingsphere/test/e2e/engine/type/dml/BaseDMLE2EIT.java
@@ -74,7 +74,7 @@ public abstract class BaseDMLE2EIT {
}
@AfterEach
- public final void tearDown() {
+ void tearDown() {
// TODO make sure test case can not be null
if (null != dataSetEnvironmentManager) {
dataSetEnvironmentManager.cleanData();
diff --git a/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/external/ExternalSQLParserIT.java b/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/external/ExternalSQLParserIT.java
index c03dd403ef2..eb9298d8e55 100644
--- a/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/external/ExternalSQLParserIT.java
+++ b/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/external/ExternalSQLParserIT.java
@@ -46,7 +46,7 @@ public abstract class ExternalSQLParserIT {
@ParameterizedTest(name = "{0} ({1}) -> {2}")
@EnabledIf("isEnabled")
@ArgumentsSource(TestCaseArgumentsProvider.class)
- public final void assertParseSQL(final String sqlCaseId, final String databaseType, final String sql, final String reportType) {
+ void assertParseSQL(final String sqlCaseId, final String databaseType, final String sql, final String reportType) {
boolean isSuccess = true;
SQLParseResultReporter resultReporter = TypedSPILoader.getService(SQLParseResultReporterCreator.class, reportType).create(databaseType);
try {
diff --git a/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/InternalSQLParserIT.java b/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/InternalSQLParserIT.java
index e9740ed0b55..6a13cc16427 100644
--- a/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/InternalSQLParserIT.java
+++ b/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/InternalSQLParserIT.java
@@ -52,7 +52,7 @@ public abstract class InternalSQLParserIT {
@ParameterizedTest(name = "{0} ({1}) -> {2}")
@ArgumentsSource(TestCaseArgumentsProvider.class)
- public final void assertSupportedSQL(final String sqlCaseId, final SQLCaseType sqlCaseType, final String databaseType, final String visitorType) {
+ void assertSupportedSQL(final String sqlCaseId, final SQLCaseType sqlCaseType, final String databaseType, final String visitorType) {
String sql = SQL_CASES.getSQL(sqlCaseId, sqlCaseType, SQL_PARSER_TEST_CASES.get(sqlCaseId).getParameters());
Object actual = parseSQLStatement("H2".equals(databaseType) ? "MySQL" : databaseType, visitorType, sql);
SQLParserTestCase expected = SQL_PARSER_TEST_CASES.get(sqlCaseId);
diff --git a/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/InternalUnsupportedSQLParserIT.java b/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/InternalUnsupportedSQLParserIT.java
index 0a1a0ffb500..4e974880309 100644
--- a/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/InternalUnsupportedSQLParserIT.java
+++ b/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/InternalUnsupportedSQLParserIT.java
@@ -44,7 +44,7 @@ public abstract class InternalUnsupportedSQLParserIT {
@ParameterizedTest(name = "{0} ({1}) -> {2}")
@ArgumentsSource(TestCaseArgumentsProvider.class)
- public final void assertUnsupportedSQL(final String sqlCaseId, final SQLCaseType sqlCaseType, final String databaseType) {
+ void assertUnsupportedSQL(final String sqlCaseId, final SQLCaseType sqlCaseType, final String databaseType) {
String sql = SQL_CASES.getSQL(sqlCaseId, sqlCaseType, Collections.emptyList());
CacheOption cacheOption = new CacheOption(128, 1024L);
assertThrows(SQLParsingException.class, () -> new SQLParserEngine("H2".equals(databaseType) ? "MySQL" : databaseType, cacheOption).parse(sql, false));
diff --git a/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/asserts/statement/dal/impl/SetParameterStatementAssert.java b/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/asserts/statement/dal/impl/SetParameterStatementAssert.java
index 72361627bbc..d6a0fa9bda2 100644
--- a/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/asserts/statement/dal/impl/SetParameterStatementAssert.java
+++ b/test/it/parser/src/main/java/org/apache/shardingsphere/test/it/sql/parser/internal/asserts/statement/dal/impl/SetParameterStatementAssert.java
@@ -51,7 +51,7 @@ public final class SetParameterStatementAssert {
}
}
- public static void assertVariable(final SQLCaseAssertContext assertContext, final VariableSegment actual, final ExpectedVariable expected) {
+ private static void assertVariable(final SQLCaseAssertContext assertContext, final VariableSegment actual, final ExpectedVariable expected) {
assertThat(assertContext.getText("variable assertion error: "), actual.getVariable(), is(expected.getName()));
assertThat(assertContext.getText("scope assertion error: "), actual.getScope(), is(expected.getScope()));
}