From cd74045453edb33d099e3e127abe5412faa9c8f3 Mon Sep 17 00:00:00 2001
From: Olivier Maury <Olivier.Maury@inrae.fr>
Date: Wed, 26 Feb 2025 17:05:16 +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
---
config/sun_checks.xml | 137 +++++++++---------
.../www/client/presenter/SurveyPresenter.java | 7 +
.../www/client/ui/map/ControlSuppliers.java | 5 +
.../www/client/ui/map/TileSuppliers.java | 6 +
.../www/client/ui/map/ToolTip.java | 6 +
.../www/server/dao/DaoHibernate.java | 14 +-
6 files changed, 95 insertions(+), 80 deletions(-)
diff --git a/config/sun_checks.xml b/config/sun_checks.xml
index 762bf17..e76901b 100644
--- a/config/sun_checks.xml
+++ b/config/sun_checks.xml
@@ -1,9 +1,9 @@
<?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
+<!-- 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 -->
@@ -11,24 +11,25 @@
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.
@@ -37,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" />
@@ -81,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" />
@@ -120,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" />
@@ -149,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" />
@@ -175,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/www-client/src/main/java/fr/agrometinfo/www/client/presenter/SurveyPresenter.java b/www-client/src/main/java/fr/agrometinfo/www/client/presenter/SurveyPresenter.java
index 2675138..eed8f1a 100644
--- a/www-client/src/main/java/fr/agrometinfo/www/client/presenter/SurveyPresenter.java
+++ b/www-client/src/main/java/fr/agrometinfo/www/client/presenter/SurveyPresenter.java
@@ -66,6 +66,13 @@ public final class SurveyPresenter implements Presenter {
*/
private final SurveyView view = new SurveyView();
+ /**
+ * Send user responses to the server.
+ *
+ * @param responsesRef list of response references.
+ * @param otherTextMap map of other text responses.
+ * @param email user email.
+ */
public void insertUserResponses(final List<Long> responsesRef, final Map<Long, String> otherTextMap,
final String email) {
// processing of predefined responses
diff --git a/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/ControlSuppliers.java b/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/ControlSuppliers.java
index d580216..0522938 100644
--- a/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/ControlSuppliers.java
+++ b/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/ControlSuppliers.java
@@ -78,6 +78,11 @@ public abstract class ControlSuppliers {
});
}-*/;
+ /**
+ * Create a zoom control.
+ *
+ * @return Zoom control
+ */
public static Zoom createZoom() {
final var options = new ZoomOptions();
options.setZoomInTipLabel(CSTS.mapZoomIn());
diff --git a/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/TileSuppliers.java b/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/TileSuppliers.java
index 8df9877..17f5570 100644
--- a/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/TileSuppliers.java
+++ b/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/TileSuppliers.java
@@ -195,6 +195,9 @@ public abstract class TileSuppliers {
return createIgnWmtsLayer(wmts);
}
+ /**
+ * @return base layer with IGN hydrography map
+ */
public static Base createIgnHydrography() {
final var wmts = new IgnWmtsLayer();
wmts.setLayer("HYDROGRAPHY.BCAE.LATEST");
@@ -216,6 +219,9 @@ public abstract class TileSuppliers {
return createIgnWmtsLayer(wmts);
}
+ /**
+ * @return base layer with IGN shadows (mountains) for France
+ */
public static Base createIgnShadowsFrance() {
final var wmts = new IgnWmtsLayer();
wmts.setLayer("ELEVATION.ELEVATIONGRIDCOVERAGE.SHADOW");
diff --git a/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/ToolTip.java b/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/ToolTip.java
index bb3c1b8..f252b0a 100644
--- a/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/ToolTip.java
+++ b/www-client/src/main/java/fr/agrometinfo/www/client/ui/map/ToolTip.java
@@ -56,10 +56,16 @@ public final class ToolTip {
olMap.addOverlay(overlay);
}
+ /**
+ * Disable tooltip.
+ */
public void disable() {
enabled = false;
}
+ /**
+ * Enable tooltip.
+ */
public void enable() {
enabled = true;
}
diff --git a/www-server/src/main/java/fr/agrometinfo/www/server/dao/DaoHibernate.java b/www-server/src/main/java/fr/agrometinfo/www/server/dao/DaoHibernate.java
index 3f2acc5..e27ba33 100644
--- a/www-server/src/main/java/fr/agrometinfo/www/server/dao/DaoHibernate.java
+++ b/www-server/src/main/java/fr/agrometinfo/www/server/dao/DaoHibernate.java
@@ -318,14 +318,12 @@ class DaoHibernate<T> {
*/
public BigDecimal getSchemaSize(final String schema) {
if (isPostgreSQLDriver()) {
- try (ScopedEntityManager em = getScopedEntityManager()) {
- final String sql = """
- SELECT
- SUM(pg_total_relation_size(CONCAT(quote_ident(schemaname), '.', quote_ident(tablename))))
- FROM pg_catalog.pg_tables WHERE schemaname=?1
- """;
- return findFirstScalar(sql, Map.of(1, schema));
- }
+ final String sql = """
+ SELECT
+ SUM(pg_total_relation_size(CONCAT(quote_ident(schemaname), '.', quote_ident(tablename))))
+ FROM pg_catalog.pg_tables WHERE schemaname=?1
+ """;
+ return findFirstScalar(sql, Map.of(1, schema));
} else {
throw new UnsupportedOperationException("Database driver not handled! " + getDriver());
}
--
GitLab