Merge pull request apache#1069 from damonxue/checkstyle_test_1

[apache#1005] - Expand checkstyle to all modules (root).
fpapon · Oct 5, 2023 · cf53ba0 · cf53ba0
2 parents 566353c + f15073b
commit cf53ba0
Show file tree

Hide file tree

Showing 708 changed files with 14,172 additions and 12,113 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -25,37 +25,37 @@ updates:
     open-pull-requests-limit: 50
     ignore:
       - dependency-name: "jakarta.platform:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.activation:jakarta.activation-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.annotation:jakarta.annotation-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.enterprise:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.xml.bind:jakarta.xml.bind-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.servlet.*:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.ws.rs:jakarta.ws.rs-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.validation:jakarta.validation-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.glassfish.web:jakarta.servlet.jsp.jstl"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.servlet.jsp.jstl:jakarta.servlet.jsp.jstl-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.glassfish.jaxb:jaxb-runtime"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.omnifaces:omnifaces"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
 
       - dependency-name: "org.springframework*:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "com.flowlogix:flowlogix-jee"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
 
       - dependency-name: "org.eclipse.jetty:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
 
   # Dependencies for Maven - on 1.12.x
   - package-ecosystem: 'maven'
@@ -66,34 +66,34 @@ updates:
     open-pull-requests-limit: 50
     ignore:
       - dependency-name: "jakarta.servlet.*:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "javax.servlet:javax.servlet-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.glassfish.web:jakarta.servlet.jsp.jstl"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.glassfish.jersey.*:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
 
       - dependency-name: "org.jasig.cas.client:*"
-        update-types: ["version-update:semver-minor"]
+        update-types: [ "version-update:semver-minor" ]
       - dependency-name: "org.slf4j:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.codehaus.groovy:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "ch.qos.logback:logback-classic"
-        update-types: ["version-update:semver-minor"]
+        update-types: [ "version-update:semver-minor" ]
       - dependency-name: "com.hazelcast:hazelcast"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.aspectj:*"
-        update-types: ["version-update:semver-patch"]
+        update-types: [ "version-update:semver-patch" ]
 
       - dependency-name: "org.springframework*:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
 
       - dependency-name: "org.eclipse.jetty:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "com.github.mjeanroy:junit-servers-jetty"
-        update-types: ["version-update:semver-minor"]
+        update-types: [ "version-update:semver-minor" ]
 
   # Dependencies for GitHub Actions
   - package-ecosystem: 'github-actions'

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -59,45 +59,45 @@ jobs:
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
+      - name: Checkout repository
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
 
-    - name: Cache local Maven repository
-      uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 #v3.3.2
-      with:
-        path: ~/.m2
-        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
-        restore-keys: ${{ runner.os }}-m2
+      - name: Cache local Maven repository
+        uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 #v3.3.2
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
 
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
+          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
 
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines.
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-    # - run: |
-    #     echo "Run, Build Application using script"
-    #     ./location_of_script_within_repo/buildscript.sh
+      # - run: |
+      #     echo "Run, Build Application using script"
+      #     ./location_of_script_within_repo/buildscript.sh
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
-      with:
-        category: "/language:${{matrix.language}}"
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
+        with:
+          category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -21,7 +21,7 @@ permissions:
   contents: read
 
 on:
-  workflow_dispatch: {}
+  workflow_dispatch: { }
   push:
     branches: [ main, '1.12.x', '1.11.x', '1.10.x' ]
   pull_request:

diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -24,7 +24,7 @@ permissions:
   pull-requests: write
 
 on:
-  workflow_dispatch: {}
+  workflow_dispatch: { }
   schedule:
     # every day 5min after midnight, UTC.
     - cron: "5 0 * * *"

diff --git a/cache/pom.xml b/cache/pom.xml
@@ -17,7 +17,8 @@
   ~ specific language governing permissions and limitations
   ~ under the License.
   -->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
 
     <parent>
         <groupId>org.apache.shiro</groupId>

diff --git a/cache/src/main/java/org/apache/shiro/cache/Cache.java b/cache/src/main/java/org/apache/shiro/cache/Cache.java
@@ -29,6 +29,8 @@
  * cache framework's cache instance (e.g. JCache, Ehcache, JCS, OSCache, JBossCache, TerraCotta, Coherence,
  * GigaSpaces, etc., etc.), allowing a Shiro user to configure any cache mechanism they choose.
  *
+ * @param <K> K
+ * @param <V> V
  * @since 0.2
  */
 public interface Cache<K, V> {
@@ -41,7 +43,7 @@ public interface Cache<K, V> {
      * @return the cached object or {@code null} if there is no entry for the specified {@code key}
      * @throws CacheException if there is a problem accessing the underlying cache system
      */
-    public V get(K key) throws CacheException;
+    V get(K key) throws CacheException;
 
     /**
      * Adds a Cache entry.
@@ -51,7 +53,7 @@ public interface Cache<K, V> {
      * @return the previous value associated with the given {@code key} or {@code null} if there was previous value
      * @throws CacheException if there is a problem accessing the underlying cache system
      */
-    public V put(K key, V value) throws CacheException;
+    V put(K key, V value) throws CacheException;
 
     /**
      * Remove the cache entry corresponding to the specified key.
@@ -60,33 +62,33 @@ public interface Cache<K, V> {
      * @return the previous value associated with the given {@code key} or {@code null} if there was previous value
      * @throws CacheException if there is a problem accessing the underlying cache system
      */
-    public V remove(K key) throws CacheException;
+    V remove(K key) throws CacheException;
 
     /**
      * Clear all entries from the cache.
      *
      * @throws CacheException if there is a problem accessing the underlying cache system
      */
-    public void clear() throws CacheException;
+    void clear() throws CacheException;
 
     /**
      * Returns the number of entries in the cache.
      *
      * @return the number of entries in the cache.
      */
-    public int size();
+    int size();
 
     /**
      * Returns a view of all the keys for entries contained in this cache.
      *
      * @return a view of all the keys for entries contained in this cache.
      */
-    public Set<K> keys();
+    Set<K> keys();
 
     /**
      * Returns a view of all of the values contained in this cache.
      *
      * @return a view of all of the values contained in this cache.
      */
-    public Collection<V> values();
+    Collection<V> values();
 }
diff --git a/cache/src/main/java/org/apache/shiro/cache/CacheException.java b/cache/src/main/java/org/apache/shiro/cache/CacheException.java
@@ -26,8 +26,7 @@
  *
  * @since 0.2
  */
-public class CacheException extends ShiroException
-{
+public class CacheException extends ShiroException {
 
     /**
      * Creates a new <code>CacheException</code>.

diff --git a/cache/src/main/java/org/apache/shiro/cache/CacheManager.java b/cache/src/main/java/org/apache/shiro/cache/CacheManager.java
@@ -38,5 +38,5 @@ public interface CacheManager {
      * @return the Cache with the given name
      * @throws CacheException if there is an error acquiring the Cache instance.
      */
-    public <K, V> Cache<K, V> getCache(String name) throws CacheException;
+    <K, V> Cache<K, V> getCache(String name) throws CacheException;
 }
diff --git a/cache/src/main/java/org/apache/shiro/cache/MapCache.java b/cache/src/main/java/org/apache/shiro/cache/MapCache.java
@@ -27,6 +27,8 @@
  * A <code>MapCache</code> is a {@link Cache Cache} implementation that uses a backing {@link Map} instance to store
  * and retrieve cached data.
  *
+ * @param <K> K
+ * @param <V> V
  * @since 1.0
  */
 public class MapCache<K, V> implements Cache<K, V> {

diff --git a/config/core/pom.xml b/config/core/pom.xml
@@ -17,7 +17,8 @@
   ~ specific language governing permissions and limitations
   ~ under the License.
   -->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
 
     <parent>
         <groupId>org.apache.shiro</groupId>

diff --git a/config/core/src/main/java/org/apache/shiro/config/ConfigurationException.java b/config/core/src/main/java/org/apache/shiro/config/ConfigurationException.java
@@ -26,8 +26,7 @@
  *
  * @since 0.9
  */
-public class ConfigurationException extends ShiroException
-{
+public class ConfigurationException extends ShiroException {
 
     /**
      * Creates a new ConfigurationException.