fix: missing JavaDoc checkstyle warnings (#123)

.pipeline/config.yml

@@ -21,7 +21,7 @@ stages:
     checkstyle:
       high: '14'# Open tasks (to do or fix me)
       normal: '0'
-      low: '214'
+      low: '0'
     findbugs: #SpotBugs
       high: '0'
       normal: '0'

cloudplatform/cloudplatform-connectivity-scp-cf/src/main/java/com/sap/cloud/sdk/cloudplatform/exception/NoServiceBindingException.java

@@ -16,16 +16,36 @@ public class NoServiceBindingException extends CloudPlatformException
 {
     private static final long serialVersionUID = -2801123460779872810L;
 
+    /**
+     * Initializes a new {@link NoServiceBindingException} instance.
+     *
+     * @param message
+     *            The exception message.
+     */
     public NoServiceBindingException( @Nullable final String message )
     {
         super(message);
     }
 
+    /**
+     * Initializes a new {@link NoServiceBindingException} instance.
+     *
+     * @param cause
+     *            The exception cause.
+     */
     public NoServiceBindingException( @Nullable final Throwable cause )
     {
         super(cause);
     }
 
+    /**
+     * Initializes a new {@link NoServiceBindingException} instance.
+     *
+     * @param message
+     *            The exception message.
+     * @param cause
+     *            The exception cause.
+     */
     public NoServiceBindingException( @Nullable final String message, @Nullable final Throwable cause )
     {
         super(message, cause);

cloudplatform/cloudplatform-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/Property.java

@@ -97,6 +97,8 @@ public static <T> Property<T> ofConfidential( @Nonnull final T confidentialValue
      *
      * @param valueTry
      *            A {@link Try} value.
+     * @param <T>
+     *            The generic value type.
      * @return A new property value wrapped in {@link Try}.
      */
     @Nonnull
@@ -110,6 +112,8 @@ public static <T> Property<T> ofTry( @Nonnull final Try<T> valueTry )
      *
      * @param confidentialValueTry
      *            A confidential {@link Try} value.
+     * @param <T>
+     *            The generic value type.
      * @return A new confidential property value wrapped in {@link Try}.
      */
     @Nonnull

cloudplatform/cloudplatform-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/ThreadContextAccessor.java

@@ -60,6 +60,13 @@ public static void setThreadContextFacade( @Nullable final ThreadContextFacade t
         }
     }
 
+    /**
+     * Returns the current {@link ThreadContext}.
+     *
+     * @return The current {@link ThreadContext}.
+     * @throws ThreadContextAccessException
+     *             If the current {@link ThreadContext} cannot be accessed.
+     */
     @Nonnull
     public static ThreadContext getCurrentContext()
         throws ThreadContextAccessException

cloudplatform/cloudplatform-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/ThreadContextDecorator.java

@@ -14,6 +14,9 @@
  */
 public interface ThreadContextDecorator
 {
+    /**
+     * Defines the default priorities for decorators. Smaller priorities are applied first.
+     */
     class DefaultPriorities
     {
         public static final int SCP_CF_SECURITY_CONTEXT_DECORATOR = -1;

cloudplatform/cloudplatform-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/ThreadContextDecoratorChain.java

@@ -8,6 +8,9 @@
 
 import javax.annotation.Nonnull;
 
+/**
+ * Chain of {@link ThreadContextDecorator}s.
+ */
 public interface ThreadContextDecoratorChain
 {
     /**

cloudplatform/cloudplatform-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/ThreadContextListenerChain.java

@@ -9,6 +9,9 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
+/**
+ * Chain of {@link ThreadContextListener}s.
+ */
 public interface ThreadContextListenerChain
 {
     /**

cloudplatform/cloudplatform-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/exception/ThreadContextAccessException.java

@@ -16,16 +16,36 @@ public class ThreadContextAccessException extends RuntimeException
 {
     private static final long serialVersionUID = -3333880351273201038L;
 
+    /**
+     * Initializes a new {@link ThreadContextAccessException} instance.
+     *
+     * @param message
+     *            The exception message.
+     */
     public ThreadContextAccessException( @Nullable final String message )
     {
         super(message);
     }
 
+    /**
+     * Initializes a new {@link ThreadContextAccessException} instance.
+     *
+     * @param cause
+     *            The exception cause.
+     */
     public ThreadContextAccessException( @Nullable final Throwable cause )
     {
         super(cause);
     }
 
+    /**
+     * Initializes a new {@link ThreadContextAccessException} instance.
+     *
+     * @param message
+     *            The exception message.
+     * @param cause
+     *            The exception cause.
+     */
     public ThreadContextAccessException( @Nullable final String message, @Nullable final Throwable cause )
     {
         super(message, cause);

cloudplatform/cloudplatform-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/exception/ThreadContextExecutionException.java

@@ -16,16 +16,36 @@ public class ThreadContextExecutionException extends RuntimeException
 {
     private static final long serialVersionUID = -2247289423654592408L;
 
+    /**
+     * Initializes a new {@link ThreadContextExecutionException} instance.
+     *
+     * @param message
+     *            The exception message.
+     */
     public ThreadContextExecutionException( @Nullable final String message )
     {
         super(message);
     }
 
+    /**
+     * Initializes a new {@link ThreadContextExecutionException} instance.
+     *
+     * @param cause
+     *            The exception cause.
+     */
     public ThreadContextExecutionException( @Nullable final Throwable cause )
     {
         super(cause);
     }
 
+    /**
+     * Initializes a new {@link ThreadContextExecutionException} instance.
+     *
+     * @param message
+     *            The exception message.
+     * @param cause
+     *            The exception cause.
+     */
     public ThreadContextExecutionException( @Nullable final String message, @Nullable final Throwable cause )
     {
         super(message, cause);

cloudplatform/cloudplatform-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/exception/ThreadContextPropertyException.java

@@ -16,16 +16,36 @@ public class ThreadContextPropertyException extends RuntimeException
 {
     private static final long serialVersionUID = -4099758265561452522L;
 
+    /**
+     * Initializes a new {@link ThreadContextPropertyException} instance.
+     *
+     * @param message
+     *            The exception message.
+     */
     public ThreadContextPropertyException( @Nullable final String message )
     {
         super(message);
     }
 
+    /**
+     * Initializes a new {@link ThreadContextPropertyException} instance.
+     *
+     * @param cause
+     *            The exception cause.
+     */
     public ThreadContextPropertyException( @Nullable final Throwable cause )
     {
         super(cause);
     }
 
+    /**
+     * Initializes a new {@link ThreadContextPropertyException} instance.
+     *
+     * @param message
+     *            The exception message.
+     * @param cause
+     *            The exception cause.
+     */
     public ThreadContextPropertyException( @Nullable final String message, @Nullable final Throwable cause )
     {
         super(message, cause);

cloudplatform/connectivity-oauth/src/main/java/com/sap/cloud/sdk/cloudplatform/connectivity/DefaultOAuth2PropertySupplier.java

@@ -160,6 +160,7 @@ CredentialType getCredentialType()
      *            The type of the entry to obtain.
      * @param path
      *            The path to the entry to obtain.
+     * @return The entry from the credentials block of the service binding.
      * @throws DestinationAccessException
      *             If the property was not found or could not be converted to the requested type.
      * @see #getCredential(Class, String...) for a variant that doesn't throw
@@ -183,6 +184,7 @@ protected <T> T getCredentialOrThrow( @Nonnull final Class<T> resultType, @Nonnu
      *            The type of the entry to obtain.
      * @param path
      *            The path to the entry to obtain.
+     * @return The entry from the credentials block of the service binding.
      * @see #getCredentialOrThrow(Class, String...)
      */
     @Nonnull
@@ -201,6 +203,7 @@ protected <T> Option<T> getCredential( @Nonnull final Class<T> resultType, @Nonn
      *            The type of the entry to obtain.
      * @param path
      *            The path to the entry to obtain.
+     * @return The oauth property from the credentials block of the service binding.
      * @throws DestinationAccessException
      *             If the property was not found or could not be converted to the requested type.
      * @see #getOAuthCredential(Class, String...) (Class, String...) for a variant that doesn't throw
@@ -228,6 +231,7 @@ protected <T> T getOAuthCredentialOrThrow( @Nonnull final Class<T> resultType, @
      *            The type of the entry to obtain.
      * @param path
      *            The path to the entry to obtain.
+     * @return The oauth property from the credentials block of the service binding.
      * @see #getOAuthCredential(Class, String...)
      */
     @Nonnull

cloudplatform/tenant/src/main/java/com/sap/cloud/sdk/cloudplatform/tenant/DefaultTenant.java

@@ -38,6 +38,9 @@ public class DefaultTenant implements TenantWithSubdomain
 
     /**
      * Creates a {@link DefaultTenant} without subdomain.
+     *
+     * @param tenantId
+     *            The identifier of the tenant.
      */
     public DefaultTenant( @Nonnull final String tenantId )
     {

datamodel/fluent-result/src/main/java/com/sap/cloud/sdk/result/DefaultCollectedResultCollection.java

@@ -285,6 +285,11 @@ public Set<BigDecimal> asBigDecimalSet()
         return collectSetFromObject(new BigDecimalExtractor());
     }
 
+    /**
+     * Returns an iterator over the elements of this collection.
+     *
+     * @return An iterator over the elements of this collection.
+     */
     @Nonnull
     public Iterator<ResultElement> iterator()
     {

datamodel/fluent-result/src/main/java/com/sap/cloud/sdk/result/GsonResultElementFactory.java

@@ -27,18 +27,39 @@ public class GsonResultElementFactory implements ResultElementFactory<JsonElemen
     @Nonnull
     protected final GsonBuilder gsonBuilder;
 
+    /**
+     * Returns a {@link ResultPrimitive} from the given {@code resultElement}.
+     *
+     * @param resultElement
+     *            The {@code JsonElement} to be converted.
+     * @return The {@code ResultPrimitive} instance.
+     */
     @Nonnull
     protected ResultPrimitive newPrimitive( @Nonnull final JsonElement resultElement )
     {
         return new GsonResultPrimitive(resultElement.getAsJsonPrimitive());
     }
 
+    /**
+     * Returns a {@link ResultObject} from the given {@code resultElement}.
+     *
+     * @param resultElement
+     *            The {@code JsonElement} to be converted.
+     * @return The {@code ResultObject} instance.
+     */
     @Nonnull
     protected ResultObject newObject( @Nonnull final JsonElement resultElement )
     {
         return new GsonResultObject(resultElement.getAsJsonObject(), this);
     }
 
+    /**
+     * Returns a {@link ResultCollection} from the given {@code resultElement}.
+     *
+     * @param resultElement
+     *            The {@code JsonElement} to be converted.
+     * @return The {@code ResultCollection} instance.
+     */
     @Nonnull
     protected ResultCollection newCollection( @Nonnull final JsonElement resultElement )
     {

datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/ODataLiteralSerializer.java

@@ -17,18 +17,48 @@
  */
 public interface ODataLiteralSerializer
 {
+    /**
+     * Returns a function to convert a given {@link Number} into a {@link String} that conforms with the protocol
+     * specification.
+     *
+     * @return A serializer for {@link Number}s.
+     */
     @Nonnull
     Function<Number, String> getNumberSerializer();
 
+    /**
+     * Returns a function to convert a given {@link UUID} into a {@link String} that conforms with the protocol
+     * specification.
+     *
+     * @return A serializer for {@link UUID}s.
+     */
     @Nonnull
     Function<UUID, String> getUUIDSerializer();
 
+    /**
+     * Returns a function to convert a given {@link OffsetDateTime} into a {@link String} that conforms with the
+     * protocol specification.
+     *
+     * @return A serializer for {@link OffsetDateTime}s.
+     */
     @Nonnull
     Function<OffsetDateTime, String> getDateTimeOffsetSerializer();
 
+    /**
+     * Returns a function to convert a given {@link LocalTime} into a {@link String} that conforms with the protocol
+     * specification.
+     *
+     * @return A serializer for {@link LocalTime}s.
+     */
     @Nonnull
     Function<LocalTime, String> getTimeOfDaySerializer();
 
+    /**
+     * Returns a function to convert a given {@link LocalDateTime} into a {@link String} that conforms with the protocol
+     * specification.
+     *
+     * @return A serializer for {@link LocalDateTime}s.
+     */
     @Nonnull
     Function<LocalDateTime, String> getDateTimeSerializer();
 }

datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/exception/ODataException.java

@@ -28,6 +28,7 @@
  * When deserialization process failed for the OData response object.</li>
  * <li><strong>{@link ODataServiceErrorException}</strong><br>
  * If the response contains an OData error in the payload.</li>
+ * </ul>
  */
 @EqualsAndHashCode( callSuper = true )
 @Getter