[pulsar] branch master updated: Enable CheckStyle Plugin in pulsar-config-validation (#13676)

[shoothzj]

This is an automated email from the ASF dual-hosted git repository.

shoothzj pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new adcf554  Enable CheckStyle Plugin in pulsar-config-validation (#13676)
adcf554 is described below

commit adcf55477496e5539570e16646459c9a9a345f00
Author: fu-turer <futu...@outlook.com>
AuthorDate: Tue Jan 11 20:46:40 2022 +0800

    Enable CheckStyle Plugin in pulsar-config-validation (#13676)
    
    ### Motivation
    
    currently, the `pulsar-config-validation` module is not protected by the 
`checkstyle-plugin`.
    
    ### Modifications
    
    - Enable CheckStyle Plugin
    - Fix checkstyle violations
---
 pulsar-config-validation/pom.xml                            | 13 +++++++++++++
 .../apache/pulsar/config/validation/ConfigValidation.java   |  7 ++++---
 .../pulsar/config/validation/ConfigValidationUtils.java     |  2 +-
 .../org/apache/pulsar/config/validation/ValidatorImpls.java |  5 ++---
 4 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/pulsar-config-validation/pom.xml b/pulsar-config-validation/pom.xml
index ac175ff..800a073 100644
--- a/pulsar-config-validation/pom.xml
+++ b/pulsar-config-validation/pom.xml
@@ -47,6 +47,19 @@
                 <artifactId>spotbugs-maven-plugin</artifactId>
                 <version>${spotbugs-maven-plugin.version}</version>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>checkstyle</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>
\ No newline at end of file
diff --git 
a/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ConfigValidation.java
 
b/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ConfigValidation.java
index 58feca3..e53bb11 100644
--- 
a/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ConfigValidation.java
+++ 
b/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ConfigValidation.java
@@ -34,7 +34,7 @@ public class ConfigValidation {
     private static final Class DEFAULT_ANNOTATION_CLASS = 
ConfigValidationAnnotations.class;
 
     /**
-     * Validate the config object with annotations from annotationClass
+     * Validate the config object with annotations from annotationClass.
      * @param config config object
      * @param annotationClass class with annotations to use
      */
@@ -53,7 +53,7 @@ public class ConfigValidation {
     }
 
     /**
-     * Validate the config object with default annotation class
+     * Validate the config object with default annotation class.
      * @param config config object
      */
     public static void validateConfig(Object config) {
@@ -68,7 +68,8 @@ public class ConfigValidation {
         processAnnotations(field.getAnnotations(), field.getName(), value, 
annotationClass);
     }
 
-    private static void processAnnotations(Annotation[] annotations, String 
fieldName, Object value, Class annotationClass) {
+    private static void processAnnotations(Annotation[] annotations, String 
fieldName, Object value,
+                                           Class annotationClass) {
         try {
             for (Annotation annotation : annotations) {
                 String type = annotation.annotationType().getName();
diff --git 
a/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ConfigValidationUtils.java
 
b/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ConfigValidationUtils.java
index 2b5b7da..ac17c65 100644
--- 
a/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ConfigValidationUtils.java
+++ 
b/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ConfigValidationUtils.java
@@ -160,7 +160,7 @@ public class ConfigValidationUtils {
     /**
      * Declares a method for validating configuration values that is nestable.
      */
-    public static abstract class NestableFieldValidator implements 
FieldValidator {
+    public abstract static class NestableFieldValidator implements 
FieldValidator {
         @Override
         public void validateField(String name, Object field) throws 
IllegalArgumentException {
             validateField(null, name, field);
diff --git 
a/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ValidatorImpls.java
 
b/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ValidatorImpls.java
index 1cf5300..d8f256c 100644
--- 
a/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ValidatorImpls.java
+++ 
b/pulsar-config-validation/src/main/java/org/apache/pulsar/config/validation/ValidatorImpls.java
@@ -18,13 +18,12 @@
  */
 package org.apache.pulsar.config.validation;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import java.lang.reflect.InvocationTargetException;
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.Map;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * System defined Validator Annotations.