Whenever using a log level, one should check if the loglevel is actually enabled, or otherwise skip the associate String creation and manipulation. An alternative to checking the log level are substituting parameters, formatters or lazy logging with lambdas. The available alternatives depend on the actual logging framework. GuardLogStatement (Priority: 2, Ruleset: Best Practices) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_bestpractices.html#guardlogstatement

Whenever using a log level, one should check if the loglevel is actually enabled, or otherwise skip the associate String creation and manipulation. An alternative to checking the log level are substituting parameters, formatters or lazy logging with lambdas. The available alternatives depend on the actual logging framework. GuardLogStatement (Priority: 2, Ruleset: Best Practices) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_bestpractices.html#guardlogstatement

Whenever using a log level, one should check if the loglevel is actually enabled, or otherwise skip the associate String creation and manipulation. An alternative to checking the log level are substituting parameters, formatters or lazy logging with lambdas. The available alternatives depend on the actual logging framework. GuardLogStatement (Priority: 2, Ruleset: Best Practices) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_bestpractices.html#guardlogstatement

Whenever using a log level, one should check if the loglevel is actually enabled, or otherwise skip the associate String creation and manipulation. An alternative to checking the log level are substituting parameters, formatters or lazy logging with lambdas. The available alternatives depend on the actual logging framework. GuardLogStatement (Priority: 2, Ruleset: Best Practices) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_bestpractices.html#guardlogstatement

Whenever using a log level, one should check if the loglevel is actually enabled, or otherwise skip the associate String creation and manipulation. An alternative to checking the log level are substituting parameters, formatters or lazy logging with lambdas. The available alternatives depend on the actual logging framework. GuardLogStatement (Priority: 2, Ruleset: Best Practices) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_bestpractices.html#guardlogstatement

For any method that returns an collection (such as an array, Collection or Map), it is better to return an empty one rather than a null reference. This removes the need for null checking all results and avoids inadvertent NullPointerExceptions. See Effective Java, 3rd Edition, Item 54: Return empty collections or arrays instead of null ReturnEmptyCollectionRatherThanNull (Priority: 1, Ruleset: Error Prone) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_errorprone.html#returnemptycollectionratherthannull

Configurable naming conventions for field declarations. This rule reports variable declarations which do not match the regex that applies to their specific kind ---e.g. constants (static final), enum constant, final field. Each regex can be configured through properties. By default this rule uses the standard Java naming convention (Camel case), and uses the ALL_UPPER convention for constants and enum constants. FieldNamingConventions (Priority: 1, Ruleset: Code Style) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_codestyle.html#fieldnamingconventions

Whenever using a log level, one should check if the loglevel is actually enabled, or otherwise skip the associate String creation and manipulation. An alternative to checking the log level are substituting parameters, formatters or lazy logging with lambdas. The available alternatives depend on the actual logging framework. GuardLogStatement (Priority: 2, Ruleset: Best Practices) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_bestpractices.html#guardlogstatement

Whenever using a log level, one should check if the loglevel is actually enabled, or otherwise skip the associate String creation and manipulation. An alternative to checking the log level are substituting parameters, formatters or lazy logging with lambdas. The available alternatives depend on the actual logging framework. GuardLogStatement (Priority: 2, Ruleset: Best Practices) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_bestpractices.html#guardlogstatement

Whenever using a log level, one should check if the loglevel is actually enabled, or otherwise skip the associate String creation and manipulation. An alternative to checking the log level are substituting parameters, formatters or lazy logging with lambdas. The available alternatives depend on the actual logging framework. GuardLogStatement (Priority: 2, Ruleset: Best Practices) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_bestpractices.html#guardlogstatement

The following actions uses Node.js version which is deprecated and will be forced to run on node20: actions/checkout@v3, actions/setup-java@v3, pmd/pmd-github-action@v1, github/codeql-action/upload-sarif@v2. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/

For classes that only have static methods, consider making them utility classes. Note that this doesn't apply to abstract classes, since their subclasses may well include non-static methods. Also, if you want this class to be a utility class, remember to add a private constructor to prevent instantiation. (Note, that this use was known before PMD 5.1.0 as UseSingleton). UseUtilityClass (Priority: 3, Ruleset: Design) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_design.html#useutilityclass

Reports method and constructor parameters that can be made final because they are never reassigned within the body of the method. This rule ignores unused parameters so as not to overlap with the rule {% rule java/bestpractices/UnusedFormalParameter %}. It will also ignore the parameters of abstract methods. MethodArgumentCouldBeFinal (Priority: 3, Ruleset: Code Style) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_codestyle.html#methodargumentcouldbefinal

To avoid mistakes if we want that an Annotation, Class, Enum, Method, Constructor or Field have a default access modifier we must add a comment at the beginning of its declaration. By default, the comment must be `/* default */` or `/* package */`, if you want another, you have to provide a regular expression. This rule ignores by default all cases that have a `@VisibleForTesting` annotation or any JUnit5/TestNG annotation. Use the property "ignoredAnnotations" to customize the recognized annotations. CommentDefaultAccessModifier (Priority: 3, Ruleset: Code Style) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_codestyle.html#commentdefaultaccessmodifier

Reports method and constructor parameters that can be made final because they are never reassigned within the body of the method. This rule ignores unused parameters so as not to overlap with the rule {% rule java/bestpractices/UnusedFormalParameter %}. It will also ignore the parameters of abstract methods. MethodArgumentCouldBeFinal (Priority: 3, Ruleset: Code Style) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_codestyle.html#methodargumentcouldbefinal

Reports method and constructor parameters that can be made final because they are never reassigned within the body of the method. This rule ignores unused parameters so as not to overlap with the rule {% rule java/bestpractices/UnusedFormalParameter %}. It will also ignore the parameters of abstract methods. MethodArgumentCouldBeFinal (Priority: 3, Ruleset: Code Style) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_codestyle.html#methodargumentcouldbefinal

Reports method and constructor parameters that can be made final because they are never reassigned within the body of the method. This rule ignores unused parameters so as not to overlap with the rule {% rule java/bestpractices/UnusedFormalParameter %}. It will also ignore the parameters of abstract methods. MethodArgumentCouldBeFinal (Priority: 3, Ruleset: Code Style) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_codestyle.html#methodargumentcouldbefinal

Reports method and constructor parameters that can be made final because they are never reassigned within the body of the method. This rule ignores unused parameters so as not to overlap with the rule {% rule java/bestpractices/UnusedFormalParameter %}. It will also ignore the parameters of abstract methods. MethodArgumentCouldBeFinal (Priority: 3, Ruleset: Code Style) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_codestyle.html#methodargumentcouldbefinal

A local variable assigned only once can be declared final. LocalVariableCouldBeFinal (Priority: 3, Ruleset: Code Style) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_codestyle.html#localvariablecouldbefinal

A local variable assigned only once can be declared final. LocalVariableCouldBeFinal (Priority: 3, Ruleset: Code Style) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_codestyle.html#localvariablecouldbefinal

A local variable assigned only once can be declared final. LocalVariableCouldBeFinal (Priority: 3, Ruleset: Code Style) https://docs.pmd-code.org/pmd-doc-7.4.0/pmd_rules_java_codestyle.html#localvariablecouldbefinal

CodeQL Action v2 will be deprecated on December 5th, 2024. Please update all occurrences of the CodeQL Action in your workflow files to v3. For more information, see https://github.blog/changelog/2024-01-12-code-scanning-deprecation-of-codeql-action-v2/