Checkstyle upgrade (helidon-io#3642)

* Upgrade checkstyle to support records.
fryp · Nov 15, 2021 · 9206bc0 · 9206bc0
1 parent 1f3fdf7
commit 9206bc0
Show file tree

Hide file tree

Showing 17 changed files with 272 additions and 6 deletions.
diff --git a/config/config/src/main/java/io/helidon/config/Config.java b/config/config/src/main/java/io/helidon/config/Config.java
@@ -922,6 +922,12 @@ interface Key extends Comparable<Key> {
         @Override
         String toString();
 
+        /**
+         * Create a child key to the current key.
+         *
+         * @param key child key (relative to current key)
+         * @return a new resolved key
+         */
         Key child(Key key);
 
         /**

diff --git a/config/config/src/main/java/io/helidon/config/spi/ChangeWatcher.java b/config/config/src/main/java/io/helidon/config/spi/ChangeWatcher.java
@@ -81,6 +81,15 @@ interface ChangeEvent<T> {
          */
         ChangeEventType type();
 
+        /**
+         * Create a new change event.
+         *
+         * @param target target of the change
+         * @param type event type
+         * @param instant time the event occurred
+         * @param <T> type of the target
+         * @return a new typed change event
+         */
         static <T> ChangeEvent<T> create(T target, ChangeEventType type, Instant instant) {
             return new ChangeEvent<>() {
                 @Override
@@ -105,6 +114,14 @@ public String toString() {
             };
         }
 
+        /**
+         * Create a new change event that occurred right now.
+         *
+         * @param target target of the change
+         * @param type event type
+         * @param <T> type of the target
+         * @return a new typed change event
+         */
         static <T> ChangeEvent<T> create(T target, ChangeEventType type) {
             return create(target, type, Instant.now());
         }

diff --git a/config/config/src/main/java/io/helidon/config/spi/ConfigContent.java b/config/config/src/main/java/io/helidon/config/spi/ConfigContent.java
@@ -63,6 +63,9 @@ static Builder builder() {
          */
         OverrideSource.OverrideData data();
 
+        /**
+         * Fluent API builder for {@link io.helidon.config.spi.ConfigContent}.
+         */
         class Builder extends ConfigContent.Builder<Builder> implements io.helidon.common.Builder<Builder, OverrideContent> {
             // override data
             private OverrideSource.OverrideData data;

diff --git a/config/config/src/main/java/io/helidon/config/spi/PollableSource.java b/config/config/src/main/java/io/helidon/config/spi/PollableSource.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020 Oracle and/or its affiliates.
+ * Copyright (c) 2020, 2021 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -52,8 +52,20 @@ public interface PollableSource<S> {
      * @see io.helidon.config.AbstractConfigSource
      */
     interface Builder<T extends Builder<T>> {
+        /**
+         * Configure the polling strategy to use.
+         *
+         * @param pollingStrategy polling strategy
+         * @return updated builder
+         */
         T pollingStrategy(PollingStrategy pollingStrategy);
 
+        /**
+         * Configure the polling strategy to use.
+         *
+         * @param pollingStrategy supplier of polling strategy (such as its builder)
+         * @return updated builder
+         */
         default T pollingStrategy(Supplier<? extends PollingStrategy> pollingStrategy) {
             return pollingStrategy(pollingStrategy.get());
         }

diff --git a/config/object-mapping/src/main/java/io/helidon/config/objectmapping/Value.java b/config/object-mapping/src/main/java/io/helidon/config/objectmapping/Value.java
@@ -237,6 +237,9 @@
      * Class that represents not-set default values.
      */
     interface None extends Supplier<Void> {
+        /**
+         * Value to use when a {@code null} value should be the default.
+         */
         String VALUE = "io.helidon.config:default=null";
 
         @Override

diff --git a/dbclient/jdbc/src/main/java/io/helidon/dbclient/jdbc/ConnectionPool.java b/dbclient/jdbc/src/main/java/io/helidon/dbclient/jdbc/ConnectionPool.java
@@ -157,6 +157,12 @@ private List<HikariCpExtension> extensions() {
                     .collect(Collectors.toList());
         }
 
+        /**
+         * Update builder from configuration.
+         *
+         * @param config configuration
+         * @return updated builder
+         */
         public Builder config(Config config) {
             Map<String, String> poolConfig = config.detach().asMap().get();
             poolConfig.forEach((key, value) -> {
@@ -182,21 +188,45 @@ public Builder config(Config config) {
             return this;
         }
 
+        /**
+         * Connection pool URL string.
+         *
+         * @param url connection pool string to use
+         * @return updated builder
+         */
         public Builder url(String url) {
             this.url = url;
             return this;
         }
 
+        /**
+         * Connection pool username.
+         *
+         * @param username username to use
+         * @return updated builder
+         */
         public Builder username(String username) {
             this.username = username;
             return this;
         }
 
+        /**
+         * Connection pool password.
+         *
+         * @param password password to use
+         * @return updated builder
+         */
         public Builder password(String password) {
             this.password = password;
             return this;
         }
 
+        /**
+         * Configure connection pool properties.
+         *
+         * @param properties properties to use
+         * @return updated builder
+         */
         public Builder properties(Properties properties) {
             this.properties = properties;
             return this;

diff --git a/etc/checkstyle.xml b/etc/checkstyle.xml
@@ -111,7 +111,7 @@
         <!-- Checks for Javadoc comments.                     -->
         <!-- See http://checkstyle.sf.net/config_javadoc.html -->
         <module name="JavadocMethod">
-            <property name="scope" value="protected"/>
+            <property name="accessModifiers" value="public, protected"/>
             <property name="validateThrows" value="false"/>
         </module>
         <module name="MissingJavadocMethod">

diff --git a/fault-tolerance/src/main/java/io/helidon/faulttolerance/Retry.java b/fault-tolerance/src/main/java/io/helidon/faulttolerance/Retry.java
@@ -370,6 +370,11 @@ private JitterRetryPolicy(Builder builder) {
             }
         }
 
+        /**
+         * A new fluent API builder to configure instances of {@link io.helidon.faulttolerance.Retry}.
+         *
+         * @return a new builder
+         */
         public static Builder builder() {
             return new Builder();
         }

diff --git a/grpc/server/src/main/java/io/helidon/grpc/server/GrpcServerConfiguration.java b/grpc/server/src/main/java/io/helidon/grpc/server/GrpcServerConfiguration.java
@@ -169,7 +169,13 @@ final class Builder implements io.helidon.common.Builder<Builder, GrpcServerConf
         private Builder() {
         }
 
-        public GrpcServerConfiguration.Builder config(Config config) {
+        /**
+         * Update the builder from configuration.
+         *
+         * @param config configuration instance
+         * @return updated builder
+         */
+        public Builder config(Config config) {
             if (config == null) {
                 return this;
             }
@@ -220,7 +226,8 @@ public Builder context(Context context) {
         }
 
         /**
-         * Sets an <a href="http://opentracing.io">opentracing.io</a> tracer. (Default is {@link GlobalTracer}.)
+         * Sets an <a href="http://opentracing.io">opentracing.io</a> tracer.
+         * (Default is {@link GlobalTracer}.)
          *
          * @param tracer a tracer to set
          * @return an updated builder
@@ -286,6 +293,11 @@ int port() {
             return port;
         }
 
+        /**
+         * Current Helidon {@link io.helidon.common.context.Context}.
+         *
+         * @return current context
+         */
         public Context context() {
             return context;
         }

diff --git a/grpc/server/src/main/java/module-info.java b/grpc/server/src/main/java/module-info.java
@@ -37,4 +37,5 @@
     requires java.logging;
 
     requires jakarta.inject;
+    requires io.opentracing.util;
 }
diff --git a/...tions/oci/telemetry/src/main/java/io/helidon/integrations/oci/telemetry/OciMetricsRx.java b/...tions/oci/telemetry/src/main/java/io/helidon/integrations/oci/telemetry/OciMetricsRx.java
@@ -127,16 +127,38 @@ public Builder config(Config config) {
             return this;
         }
 
+        /**
+         * Replace host prefix.
+         * Changing host prefix may be a breaking change. This API is designed to work with
+         * {@link #API_HOST_PREFIX}.
+         *
+         * @param prefix prefix to use
+         * @return updated builder
+         */
         public Builder hostPrefix(String prefix) {
             this.hostPrefix = prefix;
             return this;
         }
 
+        /**
+         * Replace endpoint to be invoked when contacting OCI.
+         *
+         * @param endpoint endpoint to use
+         * @return updated builder
+         */
         public Builder endpoint(String endpoint) {
             this.endpoint = endpoint;
             return this;
         }
 
+        /**
+         * Configure API version to use.
+         * API version is part of the request URI. Changing API version is potentially breaking,
+         *  as this API is designed to work with a specific version (see {@link #API_VERSION}).
+         *
+         * @param apiVersion version of the API to use
+         * @return updated builder
+         */
         public Builder apiVersion(String apiVersion) {
             this.apiVersion = apiVersion;
             return this;
@@ -153,6 +175,12 @@ public Builder updateRestApi(Consumer<OciRestApi.Builder> builderConsumer) {
             return this;
         }
 
+        /**
+         * Configure REST API to use.
+         *
+         * @param restApi OCI rest API
+         * @return updated builder
+         */
         public Builder restApi(OciRestApi restApi) {
             this.restApi = restApi;
             return this;