Merge pull request 'Release v25.08' (!382) from release_25.08 into master

Author: rsehr

checkstyle-suppressions.xml

@@ -4,6 +4,19 @@
         "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">
 
 <suppressions>
-    <suppress checks="LineLength" files="FilterHelper.java"/>
-    <suppress checks="LineLength" files="H2Production.java"/>
+    <!-- disable check for automatically generated code -->
+    <suppress
+        files="EDTFValidator.java"
+        checks=".*" />
+    <suppress
+        files="ExtendedDateTimeFormat.*.java"
+        checks=".*" />
+    <suppress
+        files="MD4.java"
+        checks=".*" />        
+    
+    <!-- disable check for junit tests -->    
+    <suppress
+        files=".*Test.java"
+        checks=".*" />        
 </suppressions>

pom.xml

@@ -4,11 +4,16 @@
   <parent>
     <groupId>io.goobi.workflow</groupId>
     <artifactId>workflow-base</artifactId>
-    <version>25.07</version>
+    <version>25.08</version>
     <relativePath/>
   </parent>
   <artifactId>workflow-core</artifactId>
   <packaging>war</packaging>
+  <properties>
+    <!-- Checkstyle -->
+    <checkstyle.max.violations>1800</checkstyle.max.violations>
+    <skipCheckstyle>false</skipCheckstyle>
+  </properties>
   <repositories>
     <repository>
       <id>intranda-public</id>
@@ -28,9 +33,44 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
+        <version>3.6.0</version>
+        <inherited>true</inherited>
+        <dependencies>
+          <dependency>
+            <groupId>com.puppycrawl.tools</groupId>
+            <artifactId>checkstyle</artifactId>
+            <version>10.21.1</version>
+          </dependency>
+          <dependency>
+            <groupId>io.goobi.workflow</groupId>
+            <artifactId>workflow-maven-config</artifactId>
+            <version>25.08</version>
+          </dependency>
+        </dependencies>
+        <!-- TODO: Check where and how to execute checkstyle -->
         <configuration>
+          <configLocation>checkstyle.xml</configLocation>
           <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
         </configuration>
+        <executions>
+          <execution>
+            <id>checkstyle-check</id>
+            <phase>verify</phase>
+            <configuration>
+              <skip>${skipCheckstyle}</skip>
+              <failOnViolation>true</failOnViolation>
+              <failsOnError>false</failsOnError>
+              <logViolationsToConsole>true</logViolationsToConsole>
+              <maxAllowedViolations>${checkstyle.max.violations}</maxAllowedViolations>
+              <violationSeverity>warning</violationSeverity>
+              <configLocation>checkstyle.xml</configLocation>
+              <inputEncoding>UTF-8</inputEncoding>
+            </configuration>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
+        </executions>
       </plugin>
       <plugin>
         <groupId>com.github.eirslett</groupId>

src/main/java/de/sub/goobi/beans/property/IGoobiProperty.java

@@ -31,43 +31,43 @@
 
 public interface IGoobiProperty {
 
-    public Integer getId();
+    Integer getId();
 
-    public void setId(Integer id);
+    void setId(Integer id);
 
-    public String getTitel();
+    String getTitel();
 
-    public void setTitel(String titel);
+    void setTitel(String titel);
 
-    public String getWert();
+    String getWert();
 
-    public void setWert(String wert);
+    void setWert(String wert);
 
-    public void setCreationDate(Date creation);
+    void setCreationDate(Date creation);
 
-    public Date getCreationDate();
+    Date getCreationDate();
 
     /**
-     * set datentyp to specific value from {@link PropertyType}
+     * set datentyp to specific value from {@link PropertyType}.
      * 
      * @param inType as {@link PropertyType}
      */
-    public void setType(PropertyType inType);
+    void setType(PropertyType inType);
 
     /**
-     * get datentyp as {@link PropertyType}
+     * get datentyp as {@link PropertyType}.
      * 
      * @return current datentyp
      */
-    public PropertyType getType();
+    PropertyType getType();
 
-    public void setContainer(String name);
+    void setContainer(String name);
 
-    public String getContainer();
+    String getContainer();
 
-    public String getNormalizedTitle();
+    String getNormalizedTitle();
 
-    public String getNormalizedValue();
+    String getNormalizedValue();
 
-    public String getNormalizedDate();
+    String getNormalizedDate();
 }

src/main/java/de/sub/goobi/config/ConfigExportValidation.java

@@ -35,7 +35,7 @@
  */
 
 @Log4j2
-public class ConfigExportValidation {
+public final class ConfigExportValidation {
 
     private ConfigExportValidation() {
     }

src/main/java/de/sub/goobi/config/ConfigNormdata.java

@@ -30,7 +30,7 @@
 import lombok.extern.log4j.Log4j2;
 
 @Log4j2
-public class ConfigNormdata {
+public final class ConfigNormdata {
 
     private ConfigNormdata() {
     }

src/main/java/de/sub/goobi/config/ConfigPlugins.java

@@ -37,26 +37,30 @@
 import lombok.extern.log4j.Log4j2;
 
 @Log4j2
-public class ConfigPlugins {
+public final class ConfigPlugins {
 
     private ConfigPlugins() {
 
     }
 
     /**
-     * pass back the right configuration file by giving the plugin class
+     * pass back the right configuration file by giving the plugin class.
      *
      * @deprecated use getPluginConfig(String pluginname) for this instead
+     * @param inPlugin plugin object
+     * @return XMLConfiguration
      */
     @Deprecated(since = "3.0", forRemoval = false)
     public static XMLConfiguration getPluginConfig(IPlugin inPlugin) {
         return getPluginConfig(inPlugin.getClass().getSimpleName());
     }
 
     /**
-     * pass back the right configuration by giving the internal plugin name
+     * pass back the right configuration by giving the internal plugin name.
      * 
      * @param pluginname Name of the plugin to use for finding the right configuration file in the config folder
+     * 
+     * @return XMLConfiguration
      */
     public static XMLConfiguration getPluginConfig(String pluginname) {
         String file = "plugin_" + pluginname + ".xml";
@@ -80,6 +84,8 @@ public static XMLConfiguration getPluginConfig(String pluginname) {
      * 
      * @param pluginname Name of the plugin to use for finding the right configuration file in the config folder
      * @param step Step to be used to detect the right sub-configuration
+     * 
+     * @return SubnodeConfiguration
      */
     public static SubnodeConfiguration getProjectAndStepConfig(String pluginname, Step step) {
 

src/main/java/de/sub/goobi/config/ConfigProjects.java

@@ -114,7 +114,7 @@ public ConfigProjects(String projectTitle, String configPfad) throws IOException
         // if not, try to load 'default' project
         if (projectNameInFile == null) {
             for (String name : projectNames) {
-                if (name.equalsIgnoreCase("default")) {
+                if ("default".equalsIgnoreCase(name)) {
                     projectNameInFile = name;
                     break;
                 }
@@ -149,7 +149,7 @@ public String getParamString(String inParameter) {
             this.config.setListDelimiter('&');
             String rueckgabe = this.config.getString(inParameter);
             return cleanXmlFormatedString(rueckgabe);
-        } catch (RuntimeException e) {
+        } catch (NoSuchElementException e) {
             log.error(e);
             return null;
         }
@@ -178,6 +178,7 @@ private String cleanXmlFormatedString(String inString) {
      * default value from the second parameter is returned.
      *
      * @param inParameter The name of the parameter that should be searched
+     * @param inDefaultIfNull default value to use
      * @return The value that is configured for the parameter or the default value in case of no fitting parameter
      */
     public String getParamString(String inParameter, String inDefaultIfNull) {
@@ -186,7 +187,7 @@ public String getParamString(String inParameter, String inDefaultIfNull) {
             String myParam = inParameter;
             String rueckgabe = this.config.getString(myParam, inDefaultIfNull);
             return cleanXmlFormatedString(rueckgabe);
-        } catch (RuntimeException e) {
+        } catch (NoSuchElementException e) {
             return inDefaultIfNull;
         }
     }
@@ -201,7 +202,7 @@ public String getParamString(String inParameter, String inDefaultIfNull) {
     public boolean getParamBoolean(String inParameter) {
         try {
             return this.config.getBoolean(inParameter);
-        } catch (RuntimeException e) {
+        } catch (NoSuchElementException e) {
             return false;
         }
     }
@@ -215,7 +216,7 @@ public boolean getParamBoolean(String inParameter) {
     public long getParamLong(String inParameter) {
         try {
             return this.config.getLong(inParameter);
-        } catch (RuntimeException e) {
+        } catch (NoSuchElementException e) {
             log.error(e);
             return 0;
         }
@@ -231,7 +232,7 @@ public long getParamLong(String inParameter) {
     public List<String> getParamList(String inParameter) {
         try {
             return Arrays.asList(this.config.getStringArray(inParameter));
-        } catch (RuntimeException e) {
+        } catch (NoSuchElementException e) {
             log.error(e);
             return new ArrayList<>();
         }
@@ -247,7 +248,7 @@ public List<String> getParamList(String inParameter) {
     public List<HierarchicalConfiguration> getList(String inParameter) {
         try {
             return config.configurationsAt(inParameter);
-        } catch (RuntimeException e) {
+        } catch (NoSuchElementException e) {
             log.error(e);
             return new ArrayList<>();
         }