From 94d5625df9f7d4256d3b5683f604b18004bad08c Mon Sep 17 00:00:00 2001 From: Olivier Maury <Olivier.Maury@inrae.fr> Date: Wed, 26 Feb 2025 17:12:23 +0100 Subject: [PATCH] =?UTF-8?q?build:=20mettre=20=C3=A0=20jour=20sun=5Fchecks.?= =?UTF-8?q?xml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../VerboseCliOptionHandler.java | 2 +- config/sun_checks.xml | 132 +++++++++--------- core/config/checkstyle-suppressions.xml | 1 + .../core/climate/SoilCalculatorBuilder.java | 12 +- .../dao/Co2ConcentrationDaoHibernateTest.java | 2 +- 5 files changed, 77 insertions(+), 72 deletions(-) diff --git a/cli/src/main/java/fr/inrae/agroclim/season/cli/clioptionhandlers/VerboseCliOptionHandler.java b/cli/src/main/java/fr/inrae/agroclim/season/cli/clioptionhandlers/VerboseCliOptionHandler.java index be5b6697..9e0af134 100644 --- a/cli/src/main/java/fr/inrae/agroclim/season/cli/clioptionhandlers/VerboseCliOptionHandler.java +++ b/cli/src/main/java/fr/inrae/agroclim/season/cli/clioptionhandlers/VerboseCliOptionHandler.java @@ -11,7 +11,7 @@ import org.apache.logging.log4j.util.Strings; /** * Handler for the option "--verbose" of the command line interface. - * + * * @author Olivier Maury */ @Log4j2 diff --git a/config/sun_checks.xml b/config/sun_checks.xml index bfa657d6..e76901bd 100644 --- a/config/sun_checks.xml +++ b/config/sun_checks.xml @@ -1,33 +1,35 @@ <?xml version="1.0"?> <!DOCTYPE module PUBLIC - "-//Checkstyle//DTD Check Configuration 1.3//EN" + "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd"> <!-- This is a checkstyle configuration file derived from Sun coding conventions. For descriptions of what the following rules do, please see the checkstyle configuration page at http://checkstyle.sourceforge.net/config.html --> + <!-- Checkstyle configuration that checks the sun coding conventions from: - - the Java Language Specification at - http://java.sun.com/docs/books/jls/second_edition/html/index.html + - the Java Language Specification at + https://docs.oracle.com/javase/specs/jls/se11/html/index.html - - the Sun Code Conventions at http://java.sun.com/docs/codeconv/ + - the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html - - the Javadoc guidelines at - http://java.sun.com/j2se/javadoc/writingdoccomments/index.html + - the Javadoc guidelines at + https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html - - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html + - the JDK Api documentation https://docs.oracle.com/en/java/javase/11/ - - some best practices + - some best practices Checkstyle is very configurable. Be sure to read the documentation at - http://checkstyle.sf.net (or in your downloaded distribution). + https://checkstyle.org (or in your downloaded distribution). Most Checks are configurable, be sure to consult the documentation. To completely disable a check, just comment it out or delete it from the file. + To suppress certain violations please review suppression filters. Finally, it is worth reading the documentation. @@ -36,43 +38,49 @@ <!-- If you set the basedir property below, then all reported file names will be relative to the specified directory. See - http://checkstyle.sourceforge.net/5.x/config.html#Checker + https://checkstyle.org/config.html#Checker <property name="basedir" value="${basedir}"/> --> + <property name="severity" value="error"/> - <!-- - --> <property name="fileExtensions" value="java, xml"/> - <!-- Checks that a package-info.java file exists for each package. --> - <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage --> + <!-- https://checkstyle.org/filters/suppressionfilter.html --> + <module name="SuppressionFilter"> + <property name="file" + value="${basedir}/config/checkstyle-suppressions.xml" /> + <property name="optional" value="false"/> + </module> + + <!-- Checks that a package-info.java file exists for each package. --> + <!-- See https://checkstyle.org/checks/javadoc/javadocpackage.html#JavadocPackage --> <module name="JavadocPackage" /> - <!-- Checks whether files end with a new line. --> - <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> + <!-- Checks whether files end with a new line. --> + <!-- See https://checkstyle.org/checks/misc/newlineatendoffile.html --> <module name="NewlineAtEndOfFile" /> - <!-- Checks that property files contain the same keys. --> - <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> + <!-- Checks that property files contain the same keys. --> + <!-- See https://checkstyle.org/checks/misc/translation.html --> <module name="Translation" /> - <!-- Checks for Size Violations. --> - <!-- See http://checkstyle.sf.net/config_sizes.html --> + <!-- Checks for Size Violations. --> + <!-- See https://checkstyle.org/checks/sizes/index.html --> <module name="FileLength" /> - - <!-- Checks for whitespace --> - <!-- See http://checkstyle.sf.net/config_whitespace.html --> - <module name="FileTabCharacter" /> - - <!-- https://checkstyle.sourceforge.io/config_sizes.html#LineLength --> <module name="LineLength"> + <property name="fileExtensions" value="java"/> + <!-- Added to Sun convention: --> <property name="ignorePattern" value="^import " /> <property name="max" value="120" /> </module> - <!-- Miscellaneous other checks. --> - <!-- See http://checkstyle.sf.net/config_misc.html --> + <!-- Checks for whitespace --> + <!-- See https://checkstyle.org/checks/whitespace/index.html --> + <module name="FileTabCharacter" /> + + <!-- Miscellaneous other checks. --> + <!-- See https://checkstyle.org/checks/misc/index.html --> <module name="RegexpSingleline"> <property name="format" value="\s+$" /> <property name="minimum" value="0" /> @@ -80,35 +88,25 @@ <property name="message" value="Line has trailing spaces." /> </module> - <module name="SuppressionFilter"> - <property name="file" - value="${basedir}/config/checkstyle-suppressions.xml" /> - </module> - - <!-- Adding to Sun convention: --> - <module name="SuppressWarningsFilter" /> - <!-- <module name="SuppressionCommentFilter"> <property name="offCommentFormat" - value="CHECKSTYLE.OFF\: ([\w\|]+)" /> <property name="onCommentFormat" value="CHECKSTYLE.ON\: - ([\w\|]+)" /> <property name="checkFormat" value="$1" /> </module> --> - - <!-- Checks for Headers --> - <!-- See http://checkstyle.sf.net/config_header.html --> + <!-- Checks for Headers --> + <!-- See https://checkstyle.org/checks/header/index.html --> <!-- <module name="Header"> --> <!-- <property name="headerFile" value="${checkstyle.header.file}"/> --> <!-- <property name="fileExtensions" value="java"/> --> <!-- </module> --> <module name="TreeWalker"> - <!-- Checks for Javadoc comments. --> - <!-- See http://checkstyle.sf.net/config_javadoc.html --> + <!-- Checks for Javadoc comments. --> + <!-- See https://checkstyle.org/checks/javadoc/index.html --> + <module name="InvalidJavadocPosition"/> <module name="JavadocMethod" /> <module name="JavadocType" /> <module name="JavadocVariable" /> <module name="JavadocStyle" /> + <module name="MissingJavadocMethod"/> - - <!-- Checks for Naming Conventions. --> - <!-- See http://checkstyle.sf.net/config_naming.html --> + <!-- Checks for Naming Conventions. --> + <!-- See https://checkstyle.org/checks/naming/index.html --> <module name="ConstantName" /> <module name="LocalFinalVariableName" /> <module name="LocalVariableName" /> @@ -119,24 +117,23 @@ <module name="StaticVariableName" /> <module name="TypeName" /> - - <!-- Checks for imports --> - <!-- See http://checkstyle.sf.net/config_import.html --> + <!-- Checks for imports --> + <!-- See https://checkstyle.org/checks/imports/index.html --> <module name="AvoidStarImport" /> <module name="IllegalImport" /> <!-- defaults to sun.* packages --> <module name="RedundantImport" /> <module name="UnusedImports" /> - <!-- Checks for Size Violations. --> - <!-- See http://checkstyle.sf.net/config_sizes.html --> + <!-- Checks for Size Violations. --> + <!-- See https://checkstyle.org/checks/sizes/index.html --> <module name="MethodLength" /> <module name="ParameterNumber"> - <property name="max" value="9"/> + <property name="max" value="9"/> </module> - <!-- Checks for whitespace --> - <!-- See http://checkstyle.sf.net/config_whitespace.html --> + <!-- Checks for whitespace --> + <!-- See https://checkstyle.org/checks/whitespace/index.html --> <module name="EmptyForIteratorPad" /> <module name="GenericWhitespace" /> <module name="MethodParamPad" /> @@ -148,24 +145,21 @@ <module name="WhitespaceAfter" /> <module name="WhitespaceAround" /> - - <!-- Modifier Checks --> - <!-- See http://checkstyle.sf.net/config_modifiers.html --> + <!-- Modifier Checks --> + <!-- See https://checkstyle.org/checks/modifier/index.html --> <module name="ModifierOrder" /> <module name="RedundantModifier" /> - - <!-- Checks for blocks. You know, those {}'s --> - <!-- See http://checkstyle.sf.net/config_blocks.html --> + <!-- Checks for blocks. You know, those {}'s --> + <!-- See https://checkstyle.org/checks/blocks/index.html --> <module name="AvoidNestedBlocks" /> <module name="EmptyBlock" /> <module name="LeftCurly" /> <module name="NeedBraces" /> <module name="RightCurly" /> - - <!-- Checks for common coding problems --> - <!-- See http://checkstyle.sf.net/config_coding.html --> + <!-- Checks for common coding problems --> + <!-- See https://checkstyle.org/checks/coding/index.html --> <module name="AvoidInlineConditionals" /> <module name="EmptyStatement" /> <module name="EqualsHashCode" /> @@ -174,26 +168,26 @@ <module name="InnerAssignment" /> <module name="MagicNumber" /> <module name="MissingSwitchDefault" /> + <module name="MultipleVariableDeclarations"/> <module name="SimplifyBooleanExpression" /> <module name="SimplifyBooleanReturn" /> - <!-- Checks for class design --> - <!-- See http://checkstyle.sf.net/config_design.html --> + <!-- Checks for class design --> + <!-- See https://checkstyle.org/checks/design/index.html --> <module name="DesignForExtension" /> <module name="FinalClass" /> <module name="HideUtilityClassConstructor" /> <module name="InterfaceIsType" /> <module name="VisibilityModifier" /> - - <!-- Miscellaneous other checks. --> - <!-- See http://checkstyle.sf.net/config_misc.html --> + <!-- Miscellaneous other checks. --> + <!-- See https://checkstyle.org/checks/misc/index.html --> <module name="ArrayTypeStyle" /> <module name="FinalParameters" /> <module name="TodoComment" /> <module name="UpperEll" /> - <!-- Adding to Sun convention: --> + <!-- Added to Sun convention: --> <module name="SuppressWarningsHolder" /> </module> </module> diff --git a/core/config/checkstyle-suppressions.xml b/core/config/checkstyle-suppressions.xml index fb588341..9df13bb5 100644 --- a/core/config/checkstyle-suppressions.xml +++ b/core/config/checkstyle-suppressions.xml @@ -4,6 +4,7 @@ "https://checkstyle.org/dtds/suppressions_1_2.dtd"> <suppressions> <suppress checks="JavadocPackage|MagicNumber" files="[/\\]src[/\\]test[/\\]" /> + <suppress checks="MagicNumber" files="SimulationEvaluation.java" /> <suppress checks="ParameterNumberCheck" files="SimulationLauncher.java" /> <suppress checks="ParameterNumberCheck" files="SimulationService.java" /> <suppress checks="MethodLengthCheck" files="PhenologyCalculatorBuilder.java" /> diff --git a/core/src/main/java/fr/inrae/agroclim/season/core/climate/SoilCalculatorBuilder.java b/core/src/main/java/fr/inrae/agroclim/season/core/climate/SoilCalculatorBuilder.java index 9e509377..a30b6c44 100644 --- a/core/src/main/java/fr/inrae/agroclim/season/core/climate/SoilCalculatorBuilder.java +++ b/core/src/main/java/fr/inrae/agroclim/season/core/climate/SoilCalculatorBuilder.java @@ -38,7 +38,17 @@ public final class SoilCalculatorBuilder { /** * Cultural coeff for pheno in Soil water balance. */ - private Double kcIni, kcLate, kcMid; + private Double kcIni; + + /** + * Cultural coeff for pheno in Soil water balance. + */ + private Double kcLate; + + /** + * Cultural coeff for pheno in Soil water balance. + */ + private Double kcMid; /** * Average fraction of Total Available Soil Water (TAW) that can be depleted diff --git a/core/src/test/java/fr/inrae/agroclim/season/core/dao/Co2ConcentrationDaoHibernateTest.java b/core/src/test/java/fr/inrae/agroclim/season/core/dao/Co2ConcentrationDaoHibernateTest.java index 5189d335..c0471ade 100644 --- a/core/src/test/java/fr/inrae/agroclim/season/core/dao/Co2ConcentrationDaoHibernateTest.java +++ b/core/src/test/java/fr/inrae/agroclim/season/core/dao/Co2ConcentrationDaoHibernateTest.java @@ -43,7 +43,7 @@ class Co2ConcentrationDaoHibernateTest { * @param year year * @return if the list contains value for a year */ - private static boolean containsYear(List<Co2Concentration> concentrations, Integer year) { + private static boolean containsYear(final List<Co2Concentration> concentrations, final Integer year) { return concentrations.stream().anyMatch(c -> c.getYear().equals(year)); } -- GitLab