Updated checkstyle to 10.17.0 (#538)

Co-authored-by: Alexander Dümont <[email protected]>
SAP · Aug 14, 2024 · 8730805 · 8730805
1 parent e5d1143
commit 8730805
Show file tree

Hide file tree

Showing 6 changed files with 73 additions and 4 deletions.
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -33,8 +33,6 @@ updates:
       - dependency-name: 'com.github.ekryd.sortpom:sortpom-maven-plugin'
       # used by deprecated code only, not worth updating for now
       - dependency-name: 'org.apache.axis2:*'
-      # updating currently doesn't work as our rules are not compatible with the latest version
-      - dependency-name: 'com.puppycrawl.tools:checkstyle'
 
   # archetype updates
   # Dependabot seems to be unable to handle those, so this is disabled for now

diff --git a/...orm-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/ThreadContextDecorator.java b/...orm-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/ThreadContextDecorator.java
@@ -19,7 +19,13 @@ public interface ThreadContextDecorator
      */
     class DefaultPriorities
     {
+        /**
+         * The priority for the security context decorator.
+         */
         public static final int SCP_CF_SECURITY_CONTEXT_DECORATOR = -1;
+        /**
+         * The priority for the custom decorator.
+         */
         public static final int CUSTOM_DECORATOR = 0;
     }
 

diff --git a/...form-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/ThreadContextListener.java b/...form-core/src/main/java/com/sap/cloud/sdk/cloudplatform/thread/ThreadContextListener.java
@@ -17,12 +17,33 @@ public interface ThreadContextListener extends Comparable<ThreadContextListener>
      */
     class DefaultPriorities
     {
+        /**
+         * The default priority for the RequestHeaderThreadContextListener
+         */
         public static final int REQUEST_HEADER_LISTENER = -7;
+        /**
+         * The default priority for the AuthTokenThreadContextListener
+         */
         public static final int AUTH_TOKEN_LISTENER = -6;
+        /**
+         * The default priority for the SecurityContextThreadContextDecorator
+         */
         public static final int SCP_CF_SECURITY_CONTEXT_DECORATOR = -5;
+        /**
+         * The default priority for the BasicAuthenticationThreadContextListener
+         */
         public static final int BASIC_AUTH_LISTENER = -4;
+        /**
+         * The default priority for the PrincipalThreadContextListener
+         */
         public static final int PRINCIPAL_LISTENER = -3;
+        /**
+         * The default priority for the TenantThreadContextListener
+         */
         public static final int TENANT_LISTENER = -2;
+        /**
+         * The default priority for custom listeners
+         */
         public static final int CUSTOM_LISTENER = 0;
     }
 

diff --git a/codestyle/checkstyle.xml b/codestyle/checkstyle.xml
@@ -46,7 +46,7 @@
 			<property name="severity" value="info"/>
 		</module>
 		<module name="JavadocMethod">
-			<property name="scope" value="protected"/>
+			<property name="accessModifiers" value="protected"/>
 			<property name="allowedAnnotations" value="Override"/>
 			<property name="severity" value="info"/>
 		</module>

diff --git a/...4/odata-v4-core/src/main/java/com/sap/cloud/sdk/datamodel/odatav4/core/BoundFunction.java b/...4/odata-v4-core/src/main/java/com/sap/cloud/sdk/datamodel/odatav4/core/BoundFunction.java
@@ -149,13 +149,33 @@ public SingleToSingleEntity(
             super(src, target, name, args);
         }
 
+        /**
+         * Class representing a composable bound function
+         *
+         * @param <BindingT>
+         *            The type the function is bound to.
+         * @param <ResultT>
+         *            The type this function returns.
+         */
         public static final class Composable<BindingT, ResultT extends VdmEntity<ResultT>>
             extends
             SingleToSingleEntity<BindingT, ResultT>
             implements
             BoundFunction.Composable<BindingT, ResultT>
         {
 
+            /**
+             * Create an instance of a bound function.
+             *
+             * @param src
+             *            The type this function is bound to.
+             * @param target
+             *            The type this function returns.
+             * @param name
+             *            The fully qualified name
+             * @param args
+             *            Key-value-pairs of function arguments names and their values
+             */
             public Composable(
                 @Nonnull final Class<BindingT> src,
                 @Nonnull final Class<ResultT> target,
@@ -271,6 +291,14 @@ public SingleToCollectionEntity(
             super(src, target, name, args);
         }
 
+        /**
+         * Class representing a composable bound function
+         *
+         * @param <BindingT>
+         *            The type the function is bound to.
+         * @param <ResultT>
+         *            The type this function returns.
+         */
         public static final class Composable<BindingT, ResultT extends VdmEntity<ResultT>>
             extends
             SingleToCollectionEntity<BindingT, ResultT>
@@ -401,6 +429,14 @@ public CollectionToSingleEntity(
             super(src, target, name, args);
         }
 
+        /**
+         * Class representing a composable bound function
+         *
+         * @param <BindingT>
+         *            The type the function is bound to.
+         * @param <ResultT>
+         *            The type this function returns.
+         */
         public static final class Composable<BindingT, ResultT extends VdmEntity<ResultT>>
             extends
             CollectionToSingleEntity<BindingT, ResultT>
@@ -534,6 +570,14 @@ public CollectionToCollectionEntity(
             super(src, target, name, args);
         }
 
+        /**
+         * Class representing a composable bound function
+         *
+         * @param <BindingT>
+         *            The type the function is bound to.
+         * @param <ResultT>
+         *            The type this function returns.
+         */
         public static final class Composable<BindingT, ResultT extends VdmEntity<ResultT>>
             extends
             CollectionToCollectionEntity<BindingT, ResultT>

diff --git a/pom.xml b/pom.xml
@@ -119,7 +119,7 @@
 		<jakarta-activation.version>2.1.0</jakarta-activation.version>
 		<qdox.version>2.1.0</qdox.version>
 		<wiremock.version>3.9.1</wiremock.version>
-		<checkstyle.version>8.41</checkstyle.version>
+		<checkstyle.version>10.17.0</checkstyle.version>
 		<byte-buddy.version>1.14.18</byte-buddy.version>
 		<jsr305.optional>true</jsr305.optional>
 	</properties>