[sling-org-apache-sling-commons-clam] 09/25: [checkstyle] (javadoc) MissingJavadocMethod

[ol...@apache.org]

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

olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-clam.git

commit c7a0b0bfdc66b055da713879e71c88fbb76c00ff
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Wed Sep 8 21:14:17 2021 +0200

    [checkstyle] (javadoc) MissingJavadocMethod
---
 checkstyle-suppressions.xml                        | 23 +++++++++++++
 pom.xml                                            |  2 ++
 .../org/apache/sling/commons/clam/ScanResult.java  | 38 ++++++++++++++++++++++
 3 files changed, 63 insertions(+)

diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
new file mode 100644
index 0000000..12cdfea
--- /dev/null
+++ b/checkstyle-suppressions.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, 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.
+-->
+<!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+<suppressions>
+  <suppress checks="MissingJavadocMethod" files=".*\/internal\/.*\.java"/>
+</suppressions>
diff --git a/pom.xml b/pom.xml
index d135dea..5343bb1 100644
--- a/pom.xml
+++ b/pom.xml
@@ -100,6 +100,8 @@
         </dependencies>
         <configuration>
           <configLocation>checks.xml</configLocation>
+          <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
+          <suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExpression>
         </configuration>
         <executions>
           <execution>
diff --git a/src/main/java/org/apache/sling/commons/clam/ScanResult.java b/src/main/java/org/apache/sling/commons/clam/ScanResult.java
index 1483717..55ee901 100644
--- a/src/main/java/org/apache/sling/commons/clam/ScanResult.java
+++ b/src/main/java/org/apache/sling/commons/clam/ScanResult.java
@@ -37,6 +37,14 @@ public class ScanResult {
 
     private final long size;
 
+    /**
+     * Creates a new <code>ScanResult</code> with the given initial parameters.
+     *
+     * @param status  The parsed status from Clam
+     * @param message The message from Clam
+     * @param started The start time of the scan
+     * @param size    The number of bytes sent to Clam for scanning
+     */
     public ScanResult(@NotNull final Status status, @NotNull final String message, long started, long size) {
         this.status = status;
         this.message = message;
@@ -44,26 +52,56 @@ public class ScanResult {
         this.size = size;
     }
 
+    /**
+     * Returns the timestamp of the scan result.
+     *
+     * @return The time in milliseconds the scan result was created
+     */
     public long getTimestamp() {
         return timestamp;
     }
 
+    /**
+     * Returns the parsed status from Clam.
+     *
+     * @return The parsed status from Clam
+     */
     public @NotNull Status getStatus() {
         return status;
     }
 
+    /**
+     * Returns the message from Clam.
+     *
+     * @return The message from Clam
+     */
     public @NotNull String getMessage() {
         return message;
     }
 
+    /**
+     * Returns the start time of the scan.
+     *
+     * @return The time in milliseconds the scan was started
+     */
     public long getStarted() {
         return started;
     }
 
+    /**
+     * Returns the size of data sent to Clam for scanning.
+     *
+     * @return The number of bytes sent to Clam
+     */
     public long getSize() {
         return size;
     }
 
+    /**
+     * Returns <code>true</code> when scanning was successful and no malware was found by Clam in sent data.
+     *
+     * @return <code>true</code> if status is <code>OK</code>, otherwise <code>false</code>
+     */
     public boolean isOk() {
         return Status.OK.equals(status);
     }