4.0.0 edu.hm.hafner codingstyle 6.5.0 jar Java coding style Provides all necessary resources for a Java project to enforce the coding style that I am using in my lectures about software development at Munich University of Applied Sciences and in all of my open-source projects. It configures several static analysis tools for Maven and IntelliJ. Moreover, it provides some sample classes that already use this style guide. These classes can be used as such but are not required in this project. These classes also use some additional libraries that are included using the Maven dependency mechanism. If the sample classes are deleted then the dependencies can be safely deleted, too. https://cs.hm.edu/~hafner MIT license All source code is copyrighted by Ullrich Hafner and licensed under the MIT license. Creative Commons Attribution 4.0 International License All documents are licensed under a Creative Commons Attribution 4.0 International License uhafner Ullrich Hafner ullrich.hafner@hm.edu https://cs.hm.edu/~hafner Munich University of Applied Sciences https://www.hm.edu/en/index.en.html scm:git:https://github.com/uhafner/codingstyle.git scm:git:git@github.com:uhafner/codingstyle.git v6.5.0 https://github.com/uhafner/codingstyle UTF-8 ${source.encoding} 21 21 ${project.groupId}.codingstyle false 4.9.8 3.20.0 2.21.0 1.18.5 2.0.17 4.4.1 6.0.3 5.22.0 3.27.7 1.4.1 3.1.3 3.20.0 3.1.3 3.4.0 3.15.0 3.12.0 3.4.0 3.4.0 3.5.5 3.5.5 3.5.0 3.28.0 7.22.0 7.22.0-metrics 3.6.0 13.3.0 4.9.8.2 1.14.0 0.8.14 1.22.1 1.2.3 1.1.0 2.48.0 0.13.1 0.15.1 0.28.4 0.5.1 0.10.0 3.2.8 3.3.1 2.2.0 3.6.2 3.10.0 4.0.3 4.0.0 9.0.2 12.2.0 6.30.0 3.28.0 2.28.0 3.28.0 1.15.0 net.bytebuddy byte-buddy ${byte-buddy.version} org.junit junit-bom ${junit.version} pom import org.mockito mockito-bom ${mockito.version} pom import com.github.spotbugs spotbugs-annotations ${spotbugs.version} com.google.errorprone error_prone_annotations ${error-prone.version} org.apache.commons commons-lang3 ${commons.lang.version} commons-io commons-io ${commons.io.version} nl.jqno.equalsverifier equalsverifier ${equalsverifier.version} test org.junit.jupiter junit-jupiter test org.mockito mockito-core test org.assertj assertj-core ${assertj.version} test com.tngtech.archunit archunit-junit5 ${archunit.version} test org.slf4j slf4j-api org.junit.platform junit-platform-engine org.slf4j slf4j-simple ${slf4j.version} test true etc false src/main/resources com.github.ekryd.sortpom sortpom-maven-plugin ${sortpom-maven-plugin.version} false true false groupId,artifactId true groupId,artifactId com.github.ferstl depgraph-maven-plugin ${depgraph-maven-plugin.version} com.github.spotbugs spotbugs-maven-plugin ${spotbugs-maven-plugin.version} io.github.git-commit-id git-commit-id-maven-plugin ${git-commit-id-maven-plugin.version} true ${project.build.outputDirectory}/git.properties ^git.build.(time|version)$ ^git.commit.id.(abbrev|full)$ full org.apache.maven.plugins maven-checkstyle-plugin ${maven-checkstyle-plugin.version} org.apache.maven.plugins maven-compiler-plugin ${maven-compiler-plugin.version} org.apache.maven.plugins maven-dependency-plugin ${maven-dependency-plugin.version} org.apache.maven.plugins maven-enforcer-plugin ${maven-enforcer-plugin.version} org.apache.maven.plugins maven-failsafe-plugin ${maven-failsafe-plugin.version} org.apache.maven.plugins maven-gpg-plugin ${maven-gpg-plugin.version} org.apache.maven.plugins maven-jar-plugin ${maven-jar-plugin.version} org.apache.maven.plugins maven-javadoc-plugin ${maven-javadoc-plugin.version} ${java.version} all,-missing true org.apache.maven.plugins maven-pmd-plugin ${maven-pmd-plugin.version} org.apache.maven.plugins maven-release-plugin ${maven-release-plugin.version} true false release deploy v@{project.version} org.apache.maven.plugins maven-resources-plugin ${maven-resources-plugin.version} ${source.encoding} org.apache.maven.plugins maven-source-plugin ${maven-source-plugin.version} org.assertj assertj-assertions-generator-maven-plugin ${assertj-assertions-generator-maven-plugin.version} org.jacoco jacoco-maven-plugin ${jacoco-maven-plugin.version} org.openrewrite.maven rewrite-maven-plugin ${rewrite-maven-plugin.version} **/docker/** org.openrewrite.maven.BestPractices org.openrewrite.maven.RemoveRedundantDependencyVersions org.openrewrite.staticanalysis.AddSerialAnnotationToSerialVersionUID org.openrewrite.staticanalysis.CodeCleanup org.openrewrite.staticanalysis.CommonStaticAnalysis org.openrewrite.staticanalysis.MissingOverrideAnnotation org.openrewrite.staticanalysis.RemoveExtraSemicolons org.openrewrite.java.migrate.UpgradeToJava21 org.openrewrite.java.migrate.util.JavaUtilAPIs org.openrewrite.java.migrate.util.SequencedCollection org.openrewrite.java.migrate.lang.StringRulesRecipes org.openrewrite.java.migrate.lang.var.UseVarForObject org.openrewrite.java.migrate.net.JavaNetAPIs org.openrewrite.java.format.BlankLines org.openrewrite.java.format.EmptyNewlineAtEndOfFile org.openrewrite.java.format.RemoveTrailingWhitespace org.openrewrite.java.testing.assertj.SimplifyChainedAssertJAssertions org.openrewrite.recipe rewrite-testing-frameworks ${rewrite-testing-frameworks.version} org.openrewrite.recipe rewrite-static-analysis ${rewrite-static-analysis.version} org.openrewrite.recipe rewrite-migrate-java ${rewrite-migrate-java.version} org.openrewrite.recipe rewrite-recommendations ${rewrite-recommendations.version} org.owasp dependency-check-maven ${dependency-check-maven.version} org.pitest pitest-maven ${pitest-maven-plugin.version} XML,HTML *ITest *equals *hashCode *toString +FCSV(csvFile[etc/pitmute.csv]) +FANNOT org.pitest pitest-junit5-plugin ${pitest-junit5-plugin.version} edu.hm.hafner pitmute ${pitmute.version} org.revapi revapi-maven-plugin ${revapi-maven-plugin.version} org.sonatype.central central-publishing-maven-plugin ${central-publishing-maven-plugin.version} true central true org.apache.maven.plugins maven-surefire-plugin ${maven-surefire-plugin.version} false **/*ITest.* @{argLine} -Djava.util.logging.config.file=logging.properties -javaagent:${org.mockito:mockito-core:jar} test default-test test **/archunit/** test architecture-test test **/archunit/** ${project.build.directory}/archunit-reports com.github.spotbugs spotbugs-maven-plugin true Low Low Max false true etc/spotbugs-exclusion-filter.xml true com.h3xstream.findsecbugs findsecbugs-plugin ${findsecbugs-plugin.version} com.github.spotbugs spotbugs ${spotbugs.version} run-spotbugs check verify io.github.git-commit-id git-commit-id-maven-plugin get-the-git-infos revision initialize org.apache.maven.plugins maven-checkstyle-plugin false true warning com.puppycrawl.tools checkstyle ${checkstyle.version} run-checkstyle-java check verify **/module-info.java false etc/checkstyle-java-configuration.xml ${project.build.directory}/checkstyle-java/checkstyle-result.xml run-checkstyle-tests check verify **/*Assert*.java,**/*_jmh*,**/module-info.java true etc/checkstyle-tests-configuration.xml ${project.build.directory}/checkstyle-tests/checkstyle-result.xml org.apache.maven.plugins maven-compiler-plugin ${java.version} com.google.errorprone error_prone_core ${error-prone.version} com.uber.nullaway nullaway ${nullaway.version} org.mockito mockito-errorprone ${mockito.version} -J-Duser.country=US -J-Duser.language=en -Xlint:all -Xlint:-exports -Xlint:-missing-explicit-ctor -Xlint:-requires-transitive-automatic -Xlint:-requires-automatic --should-stop=ifError=FLOW -J--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED -J--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED -J--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED -J--add-exports=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED -J--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED -J--add-exports=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED -J--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED -J--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED -J--add-opens=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED -J--add-opens=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED -Xplugin:ErrorProne -XepExcludedPaths:.*/generated-test-sources/.* -XepIgnoreUnknownCheckNames -XepDisableWarningsInGeneratedCode -XepAllErrorsAsWarnings -Xep:NullAway:WARN -XepOpt:NullAway:AnnotatedPackages=edu.hm.hafner -Xep:SuppressWarningsWithoutExplanation:OFF -Xep:PreferredInterfaceType:OFF -Xep:YodaCondition:OFF -Xep:ReturnMissingNullable:OFF -Xep:CannotMockFinalMethod:OFF -Xep:Java8ApiChecker:OFF -Xep:ImmutableMemberCollection:OFF -Xep:PreferJavaTimeOverload:OFF -Xep:EqualsGetClass:OFF -Xep:AndroidJdkLibsChecker:OFF -Xep:Java7ApiChecker:OFF -Xep:Var:OFF -Xep:PrivateConstructorForUtilityClass:OFF -Xep:MethodCanBeStatic:OFF -Xep:WildcardImport:OFF -Xep:ThrowsUncheckedException:OFF -Xep:UnusedMethod:OFF -Xep:BooleanParameter:OFF -Xep:UnnecessaryFinal:OFF -Xep:NullableDereference:OFF -XDcompilePolicy=simple -XDaddTypeAnnotationsToSymbol=true true true org.apache.maven.plugins maven-dependency-plugin properties org.apache.maven.plugins maven-enforcer-plugin enforce-java enforce [21,22),[25,26) Java LTS 21 or 25 is required to build this project. org.apache.maven.plugins maven-failsafe-plugin **/*ITest.* false @{argLine} -Djava.util.logging.config.file=logging.properties -javaagent:${org.mockito:mockito-core:jar} integration-test verify org.apache.maven.plugins maven-jar-plugin Ullrich Hafner ${project.scm.url} ${module.name} test-jar **/assertj/* **/ResourceTest* **/SerializableTest* **/ArchitectureRules$* **/ArchitectureRules.* config jar package config **/checkstyle*-configuration.xml **/pmd*-configuration.xml **/spotbugs-exclusion-filter.xml org.apache.maven.plugins maven-javadoc-plugin attach-javadocs jar org.apache.maven.plugins maven-pmd-plugin false ${java.version} true edu.hm.hafner pmd-core ${pmd.metrics.version} edu.hm.hafner pmd-java ${pmd.metrics.version} net.sourceforge.pmd pmd-javascript ${pmd.version} run-pmd-java pmd check cpd verify ${project.build.directory}/pmd-java etc/pmd-java-configuration.xml false 50 true ${pmd.skip} run-pmd-metrics pmd verify ${project.build.directory}/metrics /category/java/metric.xml net.sourceforge.pmd.renderers.MetricsRenderer false ${pmd.skip} run-pmd-tests pmd check cpd verify ${project.build.directory}/pmd-tests etc/pmd-tests-configuration.xml true 100 true src/main/java ${project.build.directory}/generated-test-sources/test-annotations ${project.build.directory}/generated-test-sources/assertj-assertions ${pmd.skip} org.apache.maven.plugins maven-release-plugin org.apache.maven.plugins maven-resources-plugin org.apache.maven.plugins maven-source-plugin attach-sources jar org.assertj assertj-assertions-generator-maven-plugin true true false false false true ${project.basedir}/etc/assertj-templates/ assertions_entry_point_class_template.txt assertions_entry_point_method_template.txt soft_assertions_entry_point_class_template.txt soft_assertions_entry_point_method_template.txt has_assertion_template.txt assertion_class_template.txt has_assertion_template_for_real_number_wrapper.txt edu.hm.hafner.util edu.hm.hafner.util.assertions .*Test .*Condition .*LineRangeList generate-assertions org.jacoco jacoco-maven-plugin prepare-agent process-test-classes report report verify org.revapi revapi-maven-plugin [-0-9.]* true true true manually-vetted revapi.versions ok true true java.annotation.removed @edu.umd.cs.findbugs.annotations.SuppressFBWarnings.* SpotBugs Annotations are not relevant in API true true java.annotation.* @edu.hm.hafner.util.SuppressMutation.* PitMute Annotations are not relevant in API true true java.annotation.* edu.hm.hafner.util.SuppressMutation.* PitMute Annotations are not relevant in API true false documented Allowed by the rules of semantic versioning. NON_BREAKING documented

${project.build.directory}/revapi-result.json

true false true org.revapi revapi-java ${revapi-java.version} org.revapi revapi-reporter-json ${revapi-reporter-json-version} run-revapi check verify org.sonatype.central central-publishing-maven-plugin skip true true true true true true true true ci true false false false true false pit org.pitest pitest-maven test mutationCoverage owasp org.owasp dependency-check-maven JSON NVD_API_KEY ullrich.hafner@gmail.com ${env.OSS_INDEX_TOKEN} check depgraph com.github.ferstl depgraph-maven-plugin puml compile true true true true dependency-graph ${project.basedir}/doc graph verify release org.apache.maven.plugins maven-gpg-plugin sign-artifacts sign verify