diff --git a/config/sun_checks.xml b/config/sun_checks.xml index 5c5481e5b9c3fb1f427e7c72c9b7f8d6ee921676..762bf178cfbd75eef1113df4b4d62ca19f44aef5 100644 --- a/config/sun_checks.xml +++ b/config/sun_checks.xml @@ -1,183 +1,200 @@ <?xml version="1.0"?> <!DOCTYPE module PUBLIC - "-//Checkstyle//DTD Check 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//DTD Check 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 + http://java.sun.com/docs/books/jls/second_edition/html/index.html + - the Sun Code Conventions at http://java.sun.com/docs/codeconv/ + - the Javadoc guidelines at - http://java.sun.com/j2se/javadoc/writingdoccomments/index.html + http://java.sun.com/j2se/javadoc/writingdoccomments/index.html + - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html - - 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). + http://checkstyle.sf.net (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. + Finally, it is worth reading the documentation. ---> +--> <module name="Checker"> - <!-- - 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 - - <property name="basedir" value="${basedir}"/> - --> - - <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 --> - <module name="JavadocPackage" /> - - <!-- Checks whether files end with a new line. --> - <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> - <module name="NewlineAtEndOfFile" /> - - <!-- Checks that property files contain the same keys. --> - <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> - <module name="Translation" /> - - <!-- Checks for Size Violations. --> - <!-- See http://checkstyle.sf.net/config_sizes.html --> - <module name="FileLength" /> - - <!-- Checks for whitespace --> - <!-- See http://checkstyle.sf.net/config_whitespace.html --> - <module name="FileTabCharacter"> - <property name="fileExtensions" value="java" /> - </module> - - <!-- https://checkstyle.sourceforge.io/config_sizes.html#LineLength --> - <module name="LineLength"> - <property name="ignorePattern" value="^import " /> - <property name="max" value="120" /> - </module> + <!-- + 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 + + <property name="basedir" value="${basedir}"/> + --> + + <!-- + --> + <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 --> + <module name="JavadocPackage" /> + + <!-- Checks whether files end with a new line. --> + <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> + <module name="NewlineAtEndOfFile" /> + + <!-- Checks that property files contain the same keys. --> + <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> + <module name="Translation" /> + + <!-- Checks for Size Violations. --> + <!-- See http://checkstyle.sf.net/config_sizes.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="ignorePattern" value="^import " /> + <property name="max" value="120" /> + </module> - <!-- Miscellaneous other checks. --> - <!-- See http://checkstyle.sf.net/config_misc.html --> - <module name="RegexpSingleline"> - <property name="format" value="\s+$" /> - <property name="minimum" value="0" /> - <property name="maximum" value="0" /> - <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="TreeWalker"> - - <!-- Checks for Javadoc comments. --> - <!-- See http://checkstyle.sf.net/config_javadoc.html --> - <module name="JavadocMethod" /> - <module name="JavadocType" /> - <module name="JavadocVariable" /> - <module name="JavadocStyle" /> - - - <!-- Checks for Naming Conventions. --> - <!-- See http://checkstyle.sf.net/config_naming.html --> - <module name="ConstantName" /> - <module name="LocalFinalVariableName" /> - <module name="LocalVariableName" /> - <module name="MemberName" /> - <module name="MethodName" /> - <module name="PackageName" /> - <module name="ParameterName" /> - <module name="StaticVariableName" /> - <module name="TypeName" /> - - - <!-- Checks for imports --> - <!-- See http://checkstyle.sf.net/config_import.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 --> - <module name="MethodLength" /> - <module name="ParameterNumber"> - <property name="max" value="9"/> - </module> - - <!-- Checks for whitespace --> - <!-- See http://checkstyle.sf.net/config_whitespace.html --> - <module name="EmptyForIteratorPad" /> - <module name="GenericWhitespace" /> - <module name="MethodParamPad" /> - <module name="NoWhitespaceAfter" /> - <module name="NoWhitespaceBefore" /> - <module name="OperatorWrap" /> - <module name="ParenPad" /> - <module name="TypecastParenPad" /> - <module name="WhitespaceAfter" /> - <module name="WhitespaceAround" /> - - - <!-- Modifier Checks --> - <!-- See http://checkstyle.sf.net/config_modifiers.html --> - <module name="ModifierOrder" /> - <module name="RedundantModifier" /> - - - <!-- Checks for blocks. You know, those {}'s --> - <!-- See http://checkstyle.sf.net/config_blocks.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 --> - <module name="AvoidInlineConditionals" /> - <module name="EmptyStatement" /> - <module name="EqualsHashCode" /> - <module name="HiddenField" /> - <module name="IllegalInstantiation" /> - <module name="InnerAssignment" /> - <module name="MagicNumber" /> - <module name="MissingSwitchDefault" /> - <module name="SimplifyBooleanExpression" /> - <module name="SimplifyBooleanReturn" /> - - <!-- Checks for class design --> - <!-- See http://checkstyle.sf.net/config_design.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 --> - <module name="ArrayTypeStyle" /> - <module name="FinalParameters" /> - <module name="TodoComment" /> - <module name="UpperEll" /> - - <!-- Adding to Sun convention: --> - <module name="SuppressWarningsHolder" /> - </module> + <!-- Miscellaneous other checks. --> + <!-- See http://checkstyle.sf.net/config_misc.html --> + <module name="RegexpSingleline"> + <property name="format" value="\s+$" /> + <property name="minimum" value="0" /> + <property name="maximum" value="0" /> + <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 --> + <!-- <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 --> + <module name="JavadocMethod" /> + <module name="JavadocType" /> + <module name="JavadocVariable" /> + <module name="JavadocStyle" /> + + + <!-- Checks for Naming Conventions. --> + <!-- See http://checkstyle.sf.net/config_naming.html --> + <module name="ConstantName" /> + <module name="LocalFinalVariableName" /> + <module name="LocalVariableName" /> + <module name="MemberName" /> + <module name="MethodName" /> + <module name="PackageName" /> + <module name="ParameterName" /> + <module name="StaticVariableName" /> + <module name="TypeName" /> + + + <!-- Checks for imports --> + <!-- See http://checkstyle.sf.net/config_import.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 --> + <module name="MethodLength" /> + <module name="ParameterNumber"> + <property name="max" value="9"/> + </module> + + <!-- Checks for whitespace --> + <!-- See http://checkstyle.sf.net/config_whitespace.html --> + <module name="EmptyForIteratorPad" /> + <module name="GenericWhitespace" /> + <module name="MethodParamPad" /> + <module name="NoWhitespaceAfter" /> + <module name="NoWhitespaceBefore" /> + <module name="OperatorWrap" /> + <module name="ParenPad" /> + <module name="TypecastParenPad" /> + <module name="WhitespaceAfter" /> + <module name="WhitespaceAround" /> + + + <!-- Modifier Checks --> + <!-- See http://checkstyle.sf.net/config_modifiers.html --> + <module name="ModifierOrder" /> + <module name="RedundantModifier" /> + + + <!-- Checks for blocks. You know, those {}'s --> + <!-- See http://checkstyle.sf.net/config_blocks.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 --> + <module name="AvoidInlineConditionals" /> + <module name="EmptyStatement" /> + <module name="EqualsHashCode" /> + <module name="HiddenField" /> + <module name="IllegalInstantiation" /> + <module name="InnerAssignment" /> + <module name="MagicNumber" /> + <module name="MissingSwitchDefault" /> + <module name="SimplifyBooleanExpression" /> + <module name="SimplifyBooleanReturn" /> + + <!-- Checks for class design --> + <!-- See http://checkstyle.sf.net/config_design.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 --> + <module name="ArrayTypeStyle" /> + <module name="FinalParameters" /> + <module name="TodoComment" /> + <module name="UpperEll" /> + + <!-- Adding to Sun convention: --> + <module name="SuppressWarningsHolder" /> + </module> </module> diff --git a/sava-example/src/main/java/fr/agroclim/sava/sample/ExampleMetricsServlet.java b/sava-example/src/main/java/fr/agroclim/sava/sample/ExampleMetricsServlet.java index 18c9f327e56d5c10a6aafd443514fbf5c2a2b2cb..52b2821d2979547c18371f2316848dd3b42408b6 100644 --- a/sava-example/src/main/java/fr/agroclim/sava/sample/ExampleMetricsServlet.java +++ b/sava-example/src/main/java/fr/agroclim/sava/sample/ExampleMetricsServlet.java @@ -19,7 +19,7 @@ import lombok.extern.log4j.Log4j2; */ @Log4j2 @WebServlet("/metrics") -public class ExampleMetricsServlet extends MetricsBasicAuthServlet { +public final class ExampleMetricsServlet extends MetricsBasicAuthServlet { /** * UID. diff --git a/sava-example/src/main/java/fr/agroclim/sava/sample/PongServlet.java b/sava-example/src/main/java/fr/agroclim/sava/sample/PongServlet.java index 8600d9e280a960fe5ad0c8dcda85dc2210fd74a4..9bcecd88431981b17faaf11e273ad572168f1792 100644 --- a/sava-example/src/main/java/fr/agroclim/sava/sample/PongServlet.java +++ b/sava-example/src/main/java/fr/agroclim/sava/sample/PongServlet.java @@ -27,7 +27,8 @@ public class PongServlet extends HttpServlet { * Get a pong for any ping. */ @Override - protected void doGet(final HttpServletRequest req, final HttpServletResponse resp) throws ServletException, IOException { + protected void doGet(final HttpServletRequest req, final HttpServletResponse resp) + throws ServletException, IOException { LOGGER.info("ping"); resp.getWriter().append("pong"); resp.setContentType("text/html; charset=UTF-8"); diff --git a/sava-example/src/main/java/fr/agroclim/sava/sample/package-info.java b/sava-example/src/main/java/fr/agroclim/sava/sample/package-info.java index 9959029e38e873e927092800f6f88c6efbab277a..30e8437e52cf7388bf4e9c5483c358b5ca4b165c 100644 --- a/sava-example/src/main/java/fr/agroclim/sava/sample/package-info.java +++ b/sava-example/src/main/java/fr/agroclim/sava/sample/package-info.java @@ -1 +1,4 @@ -package fr.agroclim.sava.sample; \ No newline at end of file +/** + * This package contains sample servlet for the SAVA library. + */ +package fr.agroclim.sava.sample;