Checkstyle now checks class javadocs.

Related fixes to all classes that failed the validation.

Signed-off-by: Tomas Langer <[email protected]>

common/http/src/main/java/io/helidon/common/http/MediaType.java

@@ -489,16 +489,16 @@ public double qualityFactor() {
     // fixme: Bidirectional wildcard compatibility
     @Override
     public boolean test(MediaType other) {
-        return other != null && // return false if other is null, else
-                (
-                        type.equals(AcceptPredicate.WILDCARD_VALUE)
-                                || other.type.equals(AcceptPredicate.WILDCARD_VALUE)
-                                || (
-                                type.equalsIgnoreCase(other.type)
-                                        && (
-                                        subtype.equals(AcceptPredicate.WILDCARD_VALUE) || other.subtype
-                                                .equals(AcceptPredicate.WILDCARD_VALUE)))
-                                || (type.equalsIgnoreCase(other.type) && this.subtype.equalsIgnoreCase(other.subtype)));
+        return other != null // return false if other is null, else
+                && (
+                type.equals(AcceptPredicate.WILDCARD_VALUE)
+                        || other.type.equals(AcceptPredicate.WILDCARD_VALUE)
+                        || (
+                        type.equalsIgnoreCase(other.type)
+                                && (
+                                subtype.equals(AcceptPredicate.WILDCARD_VALUE) || other.subtype
+                                        .equals(AcceptPredicate.WILDCARD_VALUE)))
+                        || (type.equalsIgnoreCase(other.type) && this.subtype.equalsIgnoreCase(other.subtype)));
     }
 
     /**

common/key-util/src/main/java/io/helidon/common/pki/PemReader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 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.
@@ -51,19 +51,19 @@ final class PemReader {
     private static final Logger LOGGER = Logger.getLogger(PemReader.class.getName());
 
     private static final Pattern CERT_PATTERN = Pattern.compile(
-            "-+BEGIN\\s+.*CERTIFICATE[^-]*-+(?:\\s|\\r|\\n)+" + // Header
-                    "([a-z0-9+/=\\r\\n]+)" +                    // Base64 text
-                    "-+END\\s+.*CERTIFICATE[^-]*-+",            // Footer
+            "-+BEGIN\\s+.*CERTIFICATE[^-]*-+(?:\\s|\\r|\\n)+" // Header
+                    + "([a-z0-9+/=\\r\\n]+)"                        // Base64 text
+                    + "-+END\\s+.*CERTIFICATE[^-]*-+",              // Footer
             Pattern.CASE_INSENSITIVE);
     private static final Pattern KEY_PATTERN = Pattern.compile(
-            "-+BEGIN\\s+.*PRIVATE\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+" + // Header
-                    "([a-z0-9+/=\\r\\n]+)" +                       // Base64 text
-                    "-+END\\s+.*PRIVATE\\s+KEY[^-]*-+",            // Footer
+            "-+BEGIN\\s+.*PRIVATE\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+" // Header
+                    + "([a-z0-9+/=\\r\\n]+)"                           // Base64 text
+                    + "-+END\\s+.*PRIVATE\\s+KEY[^-]*-+",              // Footer
             Pattern.CASE_INSENSITIVE);
     private static final Pattern PUBLIC_KEY_PATTERN = Pattern.compile(
-            "-+BEGIN\\s+.*PUBLIC\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+" + // Header
-                    "([a-z0-9+/=\\r\\n\\s]+)" +                       // Base64 text
-                    "-+END\\s+.*PUBLIC\\s+KEY[^-]*-+",            // Footer
+            "-+BEGIN\\s+.*PUBLIC\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+"  // Header
+                    + "([a-z0-9+/=\\r\\n\\s]+)"                        // Base64 text
+                    + "-+END\\s+.*PUBLIC\\s+KEY[^-]*-+",               // Footer
             Pattern.CASE_INSENSITIVE);
 
     private PemReader() {

common/reactive/src/main/java/io/helidon/common/reactive/IoMulti.java

@@ -12,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 
 package io.helidon.common.reactive;
@@ -428,6 +427,9 @@ public Multi<ByteBuffer> build() {
         }
     }
 
+    /**
+     * Fluent API builder for {@link io.helidon.common.reactive.OutputStreamMulti}.
+     */
     final class OutputStreamMultiBuilder implements Builder<OutputStreamMulti> {
 
         private final OutputStreamMulti streamMulti = new OutputStreamMulti();

config/config-mp/src/main/java/io/helidon/config/mp/MpConfigImpl.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.
@@ -44,6 +44,9 @@
 import org.eclipse.microprofile.config.spi.ConfigSource;
 import org.eclipse.microprofile.config.spi.Converter;
 
+/**
+ * Implementation of the basic MicroProfile {@link org.eclipse.microprofile.config.Config} API.
+ */
 public class MpConfigImpl implements Config {
     private static final Logger LOGGER = Logger.getLogger(MpConfigImpl.class.getName());
     // for references resolving

etc/checkstyle.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-    Copyright (c) 2016, 2020 Oracle and/or its affiliates.
+    Copyright (c) 2016, 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.
@@ -120,6 +120,9 @@
         <module name="JavadocType">
             <property name="scope" value="protected"/>
         </module>
+        <module name="MissingJavadocType">
+            <property name="scope" value="protected"/>
+        </module>
         <module name="JavadocVariable">
             <property name="scope" value="protected"/>
         </module>

examples/integrations/neo4j/neo4j-mp/src/main/java/io/helidon/examples/integrations/neo4j/mp/Neo4jResource.java

@@ -28,6 +28,9 @@
 import io.helidon.examples.integrations.neo4j.mp.domain.Movie;
 import io.helidon.examples.integrations.neo4j.mp.domain.MovieRepository;
 
+/**
+ * REST endpoint for movies.
+ */
 @Path("/movies")
 @RequestScoped
 public class Neo4jResource {

examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/SendingService.java

@@ -1,6 +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.
@@ -13,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 
 package io.helidon.examples.messaging.se;
@@ -29,7 +27,7 @@
 
 import org.apache.activemq.jndi.ActiveMQInitialContextFactory;
 
-public class SendingService implements Service {
+class SendingService implements Service {
 
     private final Emitter<String> emitter;
     private final Messaging messaging;

examples/messaging/jms-websocket-se/src/main/java/io/helidon/examples/messaging/se/WebSocketEndpoint.java

@@ -1,6 +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.
@@ -13,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 
 package io.helidon.examples.messaging.se;
@@ -38,6 +36,9 @@
 
 import org.apache.activemq.jndi.ActiveMQInitialContextFactory;
 
+/**
+ * WebSocket endpoint.
+ */
 public class WebSocketEndpoint extends Endpoint {
 
     private static final Logger LOGGER = Logger.getLogger(WebSocketEndpoint.class.getName());

examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/Main.java

@@ -1,4 +1,3 @@
-
 /*
  * Copyright (c) 2020, 2021 Oracle and/or its affiliates.
  *
@@ -13,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 
 package io.helidon.examples.messaging.se;

examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/SendingService.java

@@ -1,6 +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.
@@ -13,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 
 package io.helidon.examples.messaging.se;
@@ -28,7 +26,7 @@
 
 import org.apache.kafka.common.serialization.StringSerializer;
 
-public class SendingService implements Service {
+class SendingService implements Service {
 
     private final Emitter<String> emitter;
     private final Messaging messaging;

examples/messaging/kafka-websocket-se/src/main/java/io/helidon/examples/messaging/se/WebSocketEndpoint.java

@@ -1,6 +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.
@@ -13,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 
 package io.helidon.examples.messaging.se;
@@ -38,6 +36,9 @@
 
 import org.apache.kafka.common.serialization.StringDeserializer;
 
+/**
+ * Web socket endpoint.
+ */
 public class WebSocketEndpoint extends Endpoint {
 
     private static final Logger LOGGER = Logger.getLogger(WebSocketEndpoint.class.getName());

examples/microprofile/multipart/src/main/java/io/helidon/examples/microprofile/multipart/FileService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 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.
@@ -41,6 +41,9 @@
 import org.glassfish.jersey.media.multipart.BodyPartEntity;
 import org.glassfish.jersey.media.multipart.MultiPart;
 
+/**
+ * File service.
+ */
 @Path("/api")
 @ApplicationScoped
 public class FileService {

examples/webserver/basics/src/main/java/io/helidon/webserver/examples/basics/NameReader.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.
@@ -25,6 +25,9 @@
 import io.helidon.media.common.MessageBodyReader;
 import io.helidon.media.common.MessageBodyReaderContext;
 
+/**
+ * Reader for the custom media type.
+ */
 public class NameReader implements MessageBodyReader<Name> {
 
     private static final MediaType TYPE = MediaType.parse("application/name");

messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsBytesMessage.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.
@@ -26,6 +26,9 @@
 
 import io.helidon.messaging.MessagingException;
 
+/**
+ * A JMS Bytes message representation.
+ */
 public class JmsBytesMessage extends AbstractJmsMessage<byte[]> {
 
     private final javax.jms.BytesMessage msg;

messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsTextMessage.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.
@@ -22,6 +22,9 @@
 
 import io.helidon.messaging.MessagingException;
 
+/**
+ * A JMS Text message representation.
+ */
 public class JmsTextMessage extends AbstractJmsMessage<String> {
 
     private final javax.jms.TextMessage msg;

messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaProducerMessage.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.
@@ -25,6 +25,12 @@
 import org.apache.kafka.common.header.Headers;
 import org.apache.kafka.common.header.internals.RecordHeaders;
 
+/**
+ * Kafka specific Micro Profile Reactive Messaging Producer Message.
+ *
+ * @param <K> the type of Kafka record key
+ * @param <V> the type of Kafka record value
+ */
 public class KafkaProducerMessage<K, V> implements KafkaMessage<K, V> {
 
     private final Headers headers;

messaging/messaging/src/main/java/io/helidon/messaging/Messaging.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.
@@ -12,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 
 package io.helidon.messaging;
@@ -63,6 +62,9 @@ static Builder builder() {
         return new Builder();
     }
 
+    /**
+     * Fluent API builder for {@link io.helidon.messaging.Messaging}.
+     */
     final class Builder implements io.helidon.common.Builder<Messaging> {
 
         private final MessagingImpl messaging;

metrics/trace-exemplar/src/main/java/io/helidon/metrics/exemplartrace/TraceExemplarService.java

@@ -12,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 package io.helidon.metrics.exemplartrace;
 
@@ -21,6 +20,9 @@
 
 import io.opentracing.SpanContext;
 
+/**
+ * Service provider for {@link io.helidon.metrics.ExemplarService}.
+ */
 public class TraceExemplarService implements ExemplarService {
     @Override
     public String label() {

microprofile/jwt-auth/src/main/java/io/helidon/microprofile/jwt/auth/JwtAuthProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2020 Oracle and/or its affiliates.
+ * Copyright (c) 2018, 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.
@@ -497,9 +497,9 @@ public static class Builder implements io.helidon.common.Builder<JwtAuthProvider
         private static final String CONFIG_PUBLIC_KEY_PATH = "mp.jwt.verify.publickey.location";
         private static final String JSON_START_MARK = "{";
         private static final Pattern PUBLIC_KEY_PATTERN = Pattern.compile(
-                "-+BEGIN\\s+.*PUBLIC\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+" + // Header
-                        "([a-z0-9+/=\\r\\n\\s]+)" +                       // Base64 text
-                        "-+END\\s+.*PUBLIC\\s+KEY[^-]*-+",            // Footer
+                "-+BEGIN\\s+.*PUBLIC\\s+KEY[^-]*-+(?:\\s|\\r|\\n)+" // Header
+                        + "([a-z0-9+/=\\r\\n\\s]+)"                       // Base64 text
+                        + "-+END\\s+.*PUBLIC\\s+KEY[^-]*-+",              // Footer
                 Pattern.CASE_INSENSITIVE);
 
         private String expectedIssuer;