NIFI-9618 Upgraded Checkstyle to 9.2.1

- Corrected several missing return statements - Increased Maven heap size to 3 GB for ci-workflow This closes apache#5700 Signed-off-by: David Handermann <[email protected]>
davyam · Jan 22, 2022 · e224350 · e224350
1 parent 3d05844
commit e224350
Show file tree

Hide file tree

Showing 15 changed files with 27 additions and 39 deletions.
diff --git a/.github/workflows/ci-workflow.yml b/.github/workflows/ci-workflow.yml
@@ -19,7 +19,7 @@ on: [push, pull_request]
 
 env:
   DEFAULT_MAVEN_OPTS: >-
-    -Xmx2g
+    -Xmx3g
     -XX:ReservedCodeCacheSize=1g
     -XX:+UseG1GC
     -Dorg.slf4j.simpleLogger.defaultLogLevel=WARN

diff --git a/nifi-bootstrap/src/main/java/org/apache/nifi/bootstrap/util/SecureNiFiConfigUtil.java b/nifi-bootstrap/src/main/java/org/apache/nifi/bootstrap/util/SecureNiFiConfigUtil.java
@@ -69,7 +69,7 @@ private static boolean fileExists(String filename) {
      * This would indicate that the user intends to auto-generate a keystore and truststore, rather than
      * using their existing kestore and truststore.
      * @param nifiProperties The nifi properties
-     * @return
+     * @return HTTPS Security Configured status
      */
     private static boolean isHttpsSecurityConfiguredWithEmptyPasswords(final Properties nifiProperties) {
         if (StringUtils.isEmpty(nifiProperties.getProperty(NiFiProperties.WEB_HTTPS_PORT, StringUtils.EMPTY))) {

diff --git a/...-utils/src/main/java/org/apache/nifi/vault/hashicorp/config/HashiCorpVaultProperties.java b/...-utils/src/main/java/org/apache/nifi/vault/hashicorp/config/HashiCorpVaultProperties.java
@@ -113,7 +113,7 @@ public static class HashiCorpVaultPropertiesBuilder {
          * Set the Vault URI (e.g., http://localhost:8200).  If using https protocol, the KeyStore and TrustStore
          * properties are expected to also be set.
          * @param uri Vault's URI
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setUri(String uri) {
             this.uri = uri;
@@ -123,7 +123,7 @@ public HashiCorpVaultPropertiesBuilder setUri(String uri) {
         /**
          * Sets the path to the keyStore.
          * @param keyStore Path to the keyStore
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setKeyStore(String keyStore) {
             this.keyStore = keyStore;
@@ -133,7 +133,7 @@ public HashiCorpVaultPropertiesBuilder setKeyStore(String keyStore) {
         /**
          * Sets keyStore type (e.g., JKS, PKCS12).
          * @param keyStoreType KeyStore type
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setKeyStoreType(String keyStoreType) {
             this.keyStoreType = keyStoreType;
@@ -143,7 +143,7 @@ public HashiCorpVaultPropertiesBuilder setKeyStoreType(String keyStoreType) {
         /**
          * Sets the keyStore password.
          * @param keyStorePassword KeyStore password
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setKeyStorePassword(String keyStorePassword) {
             this.keyStorePassword = keyStorePassword;
@@ -153,7 +153,7 @@ public HashiCorpVaultPropertiesBuilder setKeyStorePassword(String keyStorePasswo
         /**
          * Sets the path to the trustStore.
          * @param trustStore Path to the trustStore
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setTrustStore(String trustStore) {
             this.trustStore = trustStore;
@@ -163,7 +163,7 @@ public HashiCorpVaultPropertiesBuilder setTrustStore(String trustStore) {
         /**
          * Sets the trustStore type (e.g., JKS, PKCS12).
          * @param trustStoreType TrustStore type
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setTrustStoreType(String trustStoreType) {
             this.trustStoreType = trustStoreType;
@@ -173,7 +173,7 @@ public HashiCorpVaultPropertiesBuilder setTrustStoreType(String trustStoreType)
         /**
          * Sets the trustStore passsword.
          * @param trustStorePassword TrustStore password
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setTrustStorePassword(String trustStorePassword) {
             this.trustStorePassword = trustStorePassword;
@@ -188,7 +188,7 @@ public HashiCorpVaultPropertiesBuilder setTrustStorePassword(String trustStorePa
          *     https://docs.spring.io/spring-vault/docs/2.3.1/reference/html/#vault.core.environment-vault-configuration</a>
          * @param authPropertiesFilename The filename of a properties file containing Spring Vault authentication
          *                               properties
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setAuthPropertiesFilename(String authPropertiesFilename) {
             this.authPropertiesFilename = authPropertiesFilename;
@@ -198,7 +198,7 @@ public HashiCorpVaultPropertiesBuilder setAuthPropertiesFilename(String authProp
         /**
          * Sets an optional comma-separated list of enabled TLS cipher suites.
          * @param enabledTlsCipherSuites Enabled TLS cipher suites (only these will be enabled)
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setEnabledTlsCipherSuites(String enabledTlsCipherSuites) {
             this.enabledTlsCipherSuites = enabledTlsCipherSuites;
@@ -208,7 +208,7 @@ public HashiCorpVaultPropertiesBuilder setEnabledTlsCipherSuites(String enabledT
         /**
          * Sets an optional comma-separated list of enabled TLS protocols.
          * @param enabledTlsProtocols Enabled TLS protocols (only these will be enabled)
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setEnabledTlsProtocols(String enabledTlsProtocols) {
             this.enabledTlsProtocols = enabledTlsProtocols;
@@ -218,7 +218,7 @@ public HashiCorpVaultPropertiesBuilder setEnabledTlsProtocols(String enabledTlsP
         /**
          * Sets the connection timeout for the HTTP client, using the standard NiFi duration format (e.g., 5 secs)
          * @param connectionTimeout Connection timeout (default is 5 secs)
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setConnectionTimeout(String connectionTimeout) {
             this.connectionTimeout = connectionTimeout;
@@ -228,7 +228,7 @@ public HashiCorpVaultPropertiesBuilder setConnectionTimeout(String connectionTim
         /**
          * Sets the read timeout for the HTTP client, using the standard NiFi duration format (e.g., 15 secs).
          * @param readTimeout Read timeout (default is 15 secs)
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultPropertiesBuilder setReadTimeout(String readTimeout) {
             this.readTimeout = readTimeout;
@@ -237,7 +237,7 @@ public HashiCorpVaultPropertiesBuilder setReadTimeout(String readTimeout) {
 
         /**
          * Build the VaultProperties.
-         * @return
+         * @return Builder
          */
         public HashiCorpVaultProperties build() {
             return new HashiCorpVaultProperties(uri, keyStore, keyStoreType, keyStorePassword, trustStore, trustStoreType,

diff --git a/...ls/src/main/java/org/apache/nifi/vault/hashicorp/config/HashiCorpVaultPropertySource.java b/...ls/src/main/java/org/apache/nifi/vault/hashicorp/config/HashiCorpVaultPropertySource.java
@@ -46,7 +46,7 @@ public Object getProperty(final String key) {
     /**
      * Converts key names from format test-value to testValue
      * @param springPropertyKey A Spring Vault property key
-     * @return
+     * @return Property Key
      */
     private String getPropertyKey(String springPropertyKey) {
         final Matcher m = DASH_LETTER_PATTERN.matcher(springPropertyKey);

diff --git a/nifi-mock/src/main/java/org/apache/nifi/util/TestRunners.java b/nifi-mock/src/main/java/org/apache/nifi/util/TestRunners.java
@@ -35,7 +35,7 @@ public static TestRunner newTestRunner(final Processor processor) {
      * Returns a {@code TestRunner} for the given {@code Processor} which uses the given {@code KerberosContext}.
      * @param processor the {@code Processor} under test
      * @param kerberosContext the {@code KerberosContext} used during the test
-     * @return
+     * @return a {@code TestRunner}
      */
     public static TestRunner newTestRunner(final Processor processor, KerberosContext kerberosContext) {
         return newTestRunner(processor,processor.getClass().getName(), kerberosContext);

diff --git a/...umulo-processors/src/main/java/org/apache/nifi/accumulo/processors/PutAccumuloRecord.java b/...umulo-processors/src/main/java/org/apache/nifi/accumulo/processors/PutAccumuloRecord.java
@@ -432,7 +432,7 @@ public void onTrigger(ProcessContext processContext, ProcessSession processSessi
      * @param columnQualifier column qualifier from which to extract the visibility or to execute an expression against
      * @param flowFile flow file being written
      * @param context process context
-     * @return
+     * @return Visibility
      */
     public static String produceVisibility(String columnFamily, String columnQualifier, FlowFile flowFile, ProcessContext context) {
         if (org.apache.commons.lang3.StringUtils.isNotEmpty(columnFamily)) {

diff --git a/...le/nifi-easyrules-service/src/main/java/org/apache/nifi/rules/engine/EasyRulesEngine.java b/...le/nifi-easyrules-service/src/main/java/org/apache/nifi/rules/engine/EasyRulesEngine.java
@@ -63,7 +63,7 @@ public EasyRulesEngine(String rulesFileFormat, boolean ignoreConditionErrors, bo
      * Return the list of actions what should be executed for a given set of facts
      *
      * @param facts a Map of key and facts values, as objects, that should be evaluated by the rules engine
-     * @return
+     * @return List of Actions
      */
     @Override
     public List<Action> fireRules(Map<String, Object> facts) {
@@ -81,7 +81,7 @@ public List<Action> fireRules(Map<String, Object> facts) {
      * Return a Map with Rule as a key and Boolean as a value indicating that the rule's conditions were met
      *
      * @param facts Map of keys and values contains facts to evaluate against rules
-     * @return
+     * @return Map of Rules
      */
     @Override
     public Map<Rule, Boolean> checkRules(Map<String, Object> facts) {

diff --git a/...easyrules-service/src/main/java/org/apache/nifi/rules/engine/EasyRulesEngineProvider.java b/...easyrules-service/src/main/java/org/apache/nifi/rules/engine/EasyRulesEngineProvider.java
@@ -27,7 +27,7 @@ public class EasyRulesEngineProvider extends AbstractEasyRulesEngineController i
 
     /**
      * Returns a rules engine instance
-     * @return
+     * @return Rules Engine
      */
     @Override
     public RulesEngine getRulesEngine() {

diff --git a/...-easyrules-service/src/main/java/org/apache/nifi/rules/engine/EasyRulesEngineService.java b/...-easyrules-service/src/main/java/org/apache/nifi/rules/engine/EasyRulesEngineService.java
@@ -57,7 +57,7 @@ public void onEnabled(final ConfigurationContext context) throws InitializationE
     /**
      * Return the list of actions what should be executed for a given set of facts
      * @param facts a Map of key and facts values, as objects, that should be evaluated by the rules engine
-     * @return
+     * @return List of Actions
      */
     @Override
     public List<Action> fireRules(Map<String, Object> facts) {

diff --git a/...cessor-utils/src/main/java/org/apache/nifi/processor/util/list/AbstractListProcessor.java b/...cessor-utils/src/main/java/org/apache/nifi/processor/util/list/AbstractListProcessor.java
@@ -969,7 +969,7 @@ private int createFlowFilesForEntities(final ProcessContext context, final Proce
      * If TARGET_SYSTEM_TIMESTAMP_PRECISION is supported as a valid Processor property,
      * then PRECISION_AUTO_DETECT will be the default value when not specified by a user.
      *
-     * @return
+     * @return Default Time Precision
      */
     protected String getDefaultTimePrecision() {
         return TARGET_SYSTEM_TIMESTAMP_PRECISION.getDefaultValue();

diff --git a/...main/java/org/apache/nifi/controller/status/analytics/StatusAnalyticsModelMapFactory.java b/...main/java/org/apache/nifi/controller/status/analytics/StatusAnalyticsModelMapFactory.java
@@ -54,7 +54,7 @@ public StatusAnalyticsModelMapFactory(ExtensionManager extensionManager, NiFiPro
 
     /**
      * Return mapping of models and extraction functions for connection status analytics prediction instances
-     * @return
+     * @return Connection Status Model Map
      */
     public Map<String, Tuple<StatusAnalyticsModel, StatusMetricExtractFunction>> getConnectionStatusModelMap(){
         Map<String, Tuple<StatusAnalyticsModel, StatusMetricExtractFunction>> modelMap = new HashMap<>();

diff --git a/...ework/nifi-web/nifi-jetty/src/main/java/org/apache/nifi/web/server/HostHeaderHandler.java b/...ework/nifi-web/nifi-jetty/src/main/java/org/apache/nifi/web/server/HostHeaderHandler.java
@@ -351,7 +351,7 @@ static List<String> extractIPsFromNetworkInterfaces(NiFiProperties niFiPropertie
      *
      * @param networkInterfaces the map of properties to bindings
      *                          ({@code ["nifi.web.http.network.interface.first":"eth0"]})
-     * @return
+     * @return Not Defined status
      */
     static boolean isNotDefined(Map<String, String> networkInterfaces) {
         return networkInterfaces == null || networkInterfaces.isEmpty() || networkInterfaces.values().stream().filter(value -> !Strings.isNullOrEmpty(value)).collect(Collectors.toList()).isEmpty();

diff --git a/...-bundle/nifi-hdfs-processors/src/main/java/org/apache/nifi/processors/hadoop/PutHDFS.java b/...-bundle/nifi-hdfs-processors/src/main/java/org/apache/nifi/processors/hadoop/PutHDFS.java
@@ -550,7 +550,7 @@ protected String getGroup(final ProcessContext context, final FlowFile flowFile)
      * Returns an optional with the first throwable in the causal chain that is assignable to the provided cause type,
      * and satisfies the provided cause predicate, {@link Optional#empty()} otherwise.
      * @param t The throwable to inspect for the cause.
-     * @return
+     * @return Throwable Cause
      */
     private <T extends Throwable> Optional<T> findCause(Throwable t, Class<T> expectedCauseType, Predicate<T> causePredicate) {
         Stream<Throwable> causalChain = Throwables.getCausalChain(t).stream();

diff --git a/nifi-registry/pom.xml b/nifi-registry/pom.xml
@@ -328,18 +328,6 @@
                         <additionalJOption>-J-Xmx512m</additionalJOption>
                     </configuration>
                 </plugin>
-                <plugin>
-                    <groupId>org.apache.maven.plugins</groupId>
-                    <artifactId>maven-checkstyle-plugin</artifactId>
-                    <version>3.1.1</version>
-                    <dependencies>
-                        <dependency>
-                            <groupId>com.puppycrawl.tools</groupId>
-                            <artifactId>checkstyle</artifactId>
-                            <version>8.31</version>
-                        </dependency>
-                    </dependencies>
-                </plugin>
             </plugins>
         </pluginManagement>
 

diff --git a/pom.xml b/pom.xml
@@ -711,7 +711,7 @@
                         <dependency>
                             <groupId>com.puppycrawl.tools</groupId>
                             <artifactId>checkstyle</artifactId>
-                            <version>8.29</version>
+                            <version>9.2.1</version>
                         </dependency>
                     </dependencies>
                 </plugin>