Update checkstyle to version 10.3.2 including needed checkstyle fixes.

effective-webwork · Aug 12, 2022 · 348b3dd · 348b3dd
1 parent a4049a9
commit 348b3dd
Show file tree

Hide file tree

Showing 15 changed files with 30 additions and 28 deletions.
diff --git a/Kitodo-DataEditor/src/main/java/org/kitodo/dataeditor/ruleset/xml/EditingElement.java b/Kitodo-DataEditor/src/main/java/org/kitodo/dataeditor/ruleset/xml/EditingElement.java
@@ -39,7 +39,7 @@ class EditingElement {
      *
      * @param name
      *            name of the acquisition stage
-     * @return
+     * @return an optional object of type AcquisitionStage
      */
     Optional<AcquisitionStage> getAcquisitionStage(String name) {
         return acquisitionStages.parallelStream().filter(acquisitionStage -> name.equals(acquisitionStage.getName()))

diff --git a/Kitodo-DataFormat/src/main/java/org/kitodo/dataformat/access/DivXmlElementAccess.java b/Kitodo-DataFormat/src/main/java/org/kitodo/dataformat/access/DivXmlElementAccess.java
@@ -198,7 +198,7 @@ static final MdSec amdSecTypeOf(Mets mets, MdSecType mdSec) {
      * @param mdSec
      *            metadata section to be read
      *
-     * @return
+     * @return a collection of type Metadata
      */
     static final Collection<Metadata> readMetadata(MdSecType mdSecType, MdSec mdSec) {
         Collection<Metadata> metadata = new HashSet<>();

diff --git a/Kitodo-DataFormat/src/main/java/org/kitodo/dataformat/access/MetsXmlElementAccess.java b/Kitodo-DataFormat/src/main/java/org/kitodo/dataformat/access/MetsXmlElementAccess.java
@@ -339,7 +339,7 @@ private static XMLGregorianCalendar convertDate(GregorianCalendar gregorianCalen
      * @param mediaFilesToIDFiles
      *            In this map, for each physical division, the corresponding XML file
      *            element is added, so that it can be used for linking later.
-     * @return
+     * @return an object of type FileSec
      */
     private FileSec generateFileSec(Map<URI, FileType> mediaFilesToIDFiles) {
         FileSec fileSec = new FileSec();

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Batch.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Batch.java
@@ -60,7 +60,7 @@ public class Batch extends BaseIndexedBean {
      */
     @ManyToMany(cascade = CascadeType.PERSIST)
     @JoinTable(name = "batch_x_process", joinColumns = {
-            @JoinColumn(name = "batch_id", foreignKey = @ForeignKey(name = "FK_batch_x_process_batch_id")) }, inverseJoinColumns = {
+        @JoinColumn(name = "batch_id", foreignKey = @ForeignKey(name = "FK_batch_x_process_batch_id")) }, inverseJoinColumns = {
             @JoinColumn(name = "process_id", foreignKey = @ForeignKey(name = "FK_batch_x_process_process_id")) })
     private List<Process> processes;
 

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Folder.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Folder.java
@@ -258,11 +258,11 @@ public String getMimeType() {
      * Returns the path pattern, containing the path to the folder relative to
      * the process directory, and maybe an extra file name pattern.
      *
+     * @return path with optional filename pattern
+     *
      * @deprecated This getter is here to be used by Hibernate and JSF to access the
      *             field value, but should not be used for other purpose, unless you
      *             know what you are doing. Use {@link #getRelativePath()}.
-     *
-     * @return path with optional filename pattern
      */
     @Deprecated
     public String getPath() {

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/ImportConfiguration.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/ImportConfiguration.java
@@ -134,11 +134,11 @@ public class ImportConfiguration extends BaseBean {
     @ManyToMany(cascade = CascadeType.PERSIST)
     @OrderColumn(name = "sorting")
     @JoinTable(name = "importconfiguration_x_mappingfile", joinColumns = {
-            @JoinColumn(name = "importconfiguration_id",
-                    foreignKey = @ForeignKey(name = "FK_importconfiguration_x_mappingfile_importconfiguration_id")) },
+        @JoinColumn(name = "importconfiguration_id",
+                foreignKey = @ForeignKey(name = "FK_importconfiguration_x_mappingfile_importconfiguration_id")) },
             inverseJoinColumns = {
-                    @JoinColumn(name = "mappingfile_id",
-                            foreignKey = @ForeignKey(name = "FK_importconfiguration_x_mappingfile_mappingfile_id")) })
+                @JoinColumn(name = "mappingfile_id",
+                    foreignKey = @ForeignKey(name = "FK_importconfiguration_x_mappingfile_mappingfile_id")) })
     private List<MappingFile> mappingFiles;
 
     @ManyToOne

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Process.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Process.java
@@ -90,21 +90,21 @@ public class Process extends BaseTemplateBean {
 
     @ManyToMany(cascade = CascadeType.ALL)
     @JoinTable(name = "process_x_property", joinColumns = {
-            @JoinColumn(name = "process_id", foreignKey = @ForeignKey(name = "FK_process_x_property_process_id")) }, inverseJoinColumns = {
+        @JoinColumn(name = "process_id", foreignKey = @ForeignKey(name = "FK_process_x_property_process_id")) }, inverseJoinColumns = {
             @JoinColumn(name = "property_id", foreignKey = @ForeignKey(name = "FK_process_x_property_property_id")) })
     private List<Property> properties;
 
     @ManyToMany(cascade = CascadeType.ALL)
     @JoinTable(name = "template_x_property", joinColumns = {
-            @JoinColumn(name = "process_id", foreignKey = @ForeignKey(name = "FK_template_x_property_process_id")) }, inverseJoinColumns = {
+        @JoinColumn(name = "process_id", foreignKey = @ForeignKey(name = "FK_template_x_property_process_id")) }, inverseJoinColumns = {
             @JoinColumn(name = "property_id", foreignKey = @ForeignKey(name = "FK_template_x_property_property_id")) })
     private List<Property> templates;
 
     @ManyToMany(cascade = CascadeType.ALL)
     @JoinTable(name = "workpiece_x_property", joinColumns = {
-            @JoinColumn(name = "process_id", foreignKey = @ForeignKey(name = "FK_workpiece_x_property_process_id")) },
-                inverseJoinColumns = {
-            @JoinColumn(name = "property_id", foreignKey = @ForeignKey(name = "FK_workpiece_x_property_property_id")) })
+        @JoinColumn(name = "process_id", foreignKey = @ForeignKey(name = "FK_workpiece_x_property_process_id")) },
+            inverseJoinColumns = {
+                @JoinColumn(name = "property_id", foreignKey = @ForeignKey(name = "FK_workpiece_x_property_property_id")) })
     private List<Property> workpieces;
 
     @ManyToMany(mappedBy = "processes")

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Task.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Task.java
@@ -142,8 +142,8 @@ public class Task extends BaseIndexedBean {
      */
     @ManyToMany(cascade = CascadeType.PERSIST)
     @JoinTable(name = "task_x_role", joinColumns = {
-            @JoinColumn(name = "task_id", foreignKey = @ForeignKey(name = "FK_task_x_role_task_id")) }, inverseJoinColumns = {
-                    @JoinColumn(name = "role_id", foreignKey = @ForeignKey(name = "FK_task_x_user_role_id")) })
+        @JoinColumn(name = "task_id", foreignKey = @ForeignKey(name = "FK_task_x_role_task_id")) }, inverseJoinColumns = {
+            @JoinColumn(name = "role_id", foreignKey = @ForeignKey(name = "FK_task_x_user_role_id")) })
     private List<Role> roles;
 
     @Transient

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Template.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Template.java
@@ -60,9 +60,9 @@ public class Template extends BaseTemplateBean {
 
     @ManyToMany(cascade = CascadeType.PERSIST)
     @JoinTable(name = "project_x_template", joinColumns = {
-            @JoinColumn(name = "template_id", foreignKey = @ForeignKey(name = "FK_project_x_template_template_id")) },
+        @JoinColumn(name = "template_id", foreignKey = @ForeignKey(name = "FK_project_x_template_template_id")) },
             inverseJoinColumns = {
-                    @JoinColumn(name = "project_id", foreignKey = @ForeignKey(name = "FK_project_x_template_project_id")) })
+                @JoinColumn(name = "project_id", foreignKey = @ForeignKey(name = "FK_project_x_template_project_id")) })
     private List<Project> projects;
 
     /**

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/User.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/User.java
@@ -80,23 +80,23 @@ public class User extends BaseBean {
 
     @ManyToMany(cascade = CascadeType.PERSIST)
     @JoinTable(name = "user_x_role", joinColumns = {@JoinColumn(name = "user_id",
-        foreignKey = @ForeignKey(name = "FK_user_x_role_user_id")) }, inverseJoinColumns = {@JoinColumn(name = "role_id",
-            foreignKey = @ForeignKey(name = "FK_user_x_role_role_id")) })
+            foreignKey = @ForeignKey(name = "FK_user_x_role_user_id")) }, inverseJoinColumns = {@JoinColumn(name = "role_id",
+                    foreignKey = @ForeignKey(name = "FK_user_x_role_role_id")) })
     private List<Role> roles;
 
     @OneToMany(mappedBy = "processingUser", cascade = CascadeType.PERSIST)
     private List<Task> processingTasks;
 
     @ManyToMany(cascade = CascadeType.PERSIST)
     @JoinTable(name = "project_x_user", joinColumns = {@JoinColumn(name = "user_id",
-        foreignKey = @ForeignKey(name = "FK_project_x_user_user_id")) }, inverseJoinColumns = {@JoinColumn(name = "project_id",
-            foreignKey = @ForeignKey(name = "FK_project_x_user_project_id")) })
+            foreignKey = @ForeignKey(name = "FK_project_x_user_user_id")) }, inverseJoinColumns = {@JoinColumn(name = "project_id",
+                    foreignKey = @ForeignKey(name = "FK_project_x_user_project_id")) })
     private List<Project> projects;
 
     @ManyToMany(cascade = CascadeType.PERSIST)
     @JoinTable(name = "client_x_user", joinColumns = {@JoinColumn(name = "user_id",
             foreignKey = @ForeignKey(name = "FK_client_x_user_user_id")) }, inverseJoinColumns = {
-            @JoinColumn(name = "client_id", foreignKey = @ForeignKey(name = "FK_client_x_user_client_id")) })
+                @JoinColumn(name = "client_id", foreignKey = @ForeignKey(name = "FK_client_x_user_client_id")) })
     private List<Client> clients;
 
     @OneToMany(mappedBy = "user", cascade = CascadeType.PERSIST, orphanRemoval = true)

diff --git a/Kitodo/src/main/java/org/kitodo/production/helper/metadata/pagination/PaginatorMode.java b/Kitodo/src/main/java/org/kitodo/production/helper/metadata/pagination/PaginatorMode.java
@@ -111,6 +111,7 @@ String format(String value, String next, boolean fictitious, String separator) {
      */
     private static final Map<Integer, PaginatorMode> codeMap = new HashMap<>(
             (int) Math.ceil(values().length / .75));
+
     static {
         for (PaginatorMode member : PaginatorMode.values()) {
             codeMap.put(member.code, member);

diff --git a/Kitodo/src/main/java/org/kitodo/production/helper/metadata/pagination/PaginatorType.java b/Kitodo/src/main/java/org/kitodo/production/helper/metadata/pagination/PaginatorType.java
@@ -94,6 +94,7 @@ public String format(PaginatorMode mode, String value, boolean fictitious, Strin
      */
     private static final Map<Integer, PaginatorType> codeMap = new HashMap<>(
             (int) Math.ceil(values().length / .75));
+
     static {
         for (PaginatorType member : PaginatorType.values()) {
             codeMap.put(member.code, member);

diff --git a/Kitodo/src/main/java/org/kitodo/production/servletfilter/EncodingFilter.java b/Kitodo/src/main/java/org/kitodo/production/servletfilter/EncodingFilter.java
@@ -25,7 +25,7 @@
 import javax.servlet.annotation.WebInitParam;
 
 @WebFilter(filterName = "EncodingFilter", urlPatterns = "/*", initParams = {
-        @WebInitParam(name = "requestEncoding", value = "UTF-8") })
+    @WebInitParam(name = "requestEncoding", value = "UTF-8") })
 public class EncodingFilter implements Filter {
 
     private String encoding;

diff --git a/config/checkstyle.xml b/config/checkstyle.xml
@@ -252,7 +252,7 @@
         </module>
 
         <module name="JavadocMethod">
-            <property name="scope" value="public"/>
+            <property name="accessModifiers" value="public"/>
             <property name="allowMissingParamTags" value="true"/>
             <property name="allowMissingReturnTag" value="true"/>
             <property name="allowedAnnotations" value="Override, Test"/>

diff --git a/pom.xml b/pom.xml
@@ -905,12 +905,12 @@ from system library in Java 11+ -->
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-checkstyle-plugin</artifactId>
-                        <version>3.1.0</version>
+                        <version>3.1.2</version>
                         <dependencies>
                             <dependency>
                                 <groupId>com.puppycrawl.tools</groupId>
                                 <artifactId>checkstyle</artifactId>
-                                <version>8.29</version>
+                                <version>10.3.2</version>
                             </dependency>
                         </dependencies>
                         <executions>