Base

• BOM
• Parent
• Spring Boot-Parent
• Checkstyle

Modules

• Core
• Modules
• Services

Architecture

• Introduction and Goals
• Constraints
• Context and Scope
• Solution Strategy
• Building Block View
• Runtime View
• Deployment View
• Crosscutting Concepts
• Architecture Decisions
• Quality
• Risks and Technical Debt
• Glossary

Project Documentation

• Project Information
• Project Reports
  • Checkstyle
  • Source Xref
  • Test Source Xref
  • CPD
  • PMD
  • JaCoCo
  • dependency-check
  • Surefire
  • SpotBugs

Links

• Kaiserpfalz EDV-Servie
• Paladins Inn
• Roland T. Lichti

Checkstyle Results

The following document contains the results of Checkstyle 9.3 with kaiserpfalz/checkstyle.xml ruleset.

Summary

Files	Info	Warnings	Errors
18	0	0	95

Files

File	I	W	E
de/kaiserpfalzedv/services/dnb/client/DnbLookupClientConfig.java	0	0	8
de/kaiserpfalzedv/services/dnb/client/Marc21Decoder.java	0	0	3
de/kaiserpfalzedv/services/dnb/marcxml/LibraryLookupMarc21MappingException.java	0	0	2
de/kaiserpfalzedv/services/dnb/marcxml/MarcConverter.java	0	0	8
de/kaiserpfalzedv/services/dnb/marcxml/model/ControlField.java	0	0	4
de/kaiserpfalzedv/services/dnb/marcxml/model/DataField.java	0	0	5
de/kaiserpfalzedv/services/dnb/marcxml/model/Marc21Record.java	0	0	5
de/kaiserpfalzedv/services/dnb/marcxml/model/Record.java	0	0	6
de/kaiserpfalzedv/services/dnb/marcxml/model/RecordData.java	0	0	2
de/kaiserpfalzedv/services/dnb/marcxml/model/SearchRetrieveRequest.java	0	0	8
de/kaiserpfalzedv/services/dnb/marcxml/model/SearchRetrieveResponse.java	0	0	7
de/kaiserpfalzedv/services/dnb/marcxml/model/SubField.java	0	0	4
de/kaiserpfalzedv/services/dnb/marcxml/package-info.java	0	0	1
de/kaiserpfalzedv/services/dnb/model/Book.java	0	0	27
de/kaiserpfalzedv/services/dnb/model/LibraryLookupException.java	0	0	4
de/kaiserpfalzedv/services/dnb/package-info.java	0	0	1

Rules

Category	Rule	Violations	Severity
coding	HiddenField	1	Error
	MagicNumber	5	Error
design	VisibilityModifier	2	Error
imports	AvoidStarImport	7	Error
	UnusedImports processJavadoc: "false"	2	Error
javadoc	JavadocPackage	3	Error
	JavadocStyle	2	Error
	JavadocVariable	55	Error
	MissingJavadocMethod	9	Error
misc	NewlineAtEndOfFile	2	Error
whitespace	NoWhitespaceAfter	1	Error
	NoWhitespaceBefore	1	Error
	WhitespaceAfter	4	Error
	WhitespaceAround	1	Error

Details

de/kaiserpfalzedv/services/dnb/client/DnbLookupClientConfig.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	37
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	38
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	39
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	42
Error	whitespace	NoWhitespaceBefore	';' is preceded with whitespace.	48
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	51
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	56

de/kaiserpfalzedv/services/dnb/client/Marc21Decoder.java

Severity	Category	Rule	Message	Line
Error	imports	UnusedImports	Unused import - java.util.List.	22
Error	imports	UnusedImports	Unused import - de.kaiserpfalzedv.services.dnb.model.Book.	27
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	45

de/kaiserpfalzedv/services/dnb/marcxml/LibraryLookupMarc21MappingException.java

Severity	Category	Rule	Message	Line
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	12
Error	coding	MagicNumber	'500' is a magic number.	13

de/kaiserpfalzedv/services/dnb/marcxml/MarcConverter.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	66
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	67
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	69
Error	whitespace	WhitespaceAround	'switch' is not followed by whitespace.	95
Error	whitespace	NoWhitespaceAfter	'!' is followed by whitespace.	145
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	161
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	169
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	177

de/kaiserpfalzedv/services/dnb/marcxml/model/ControlField.java

Severity	Category	Rule	Message	Line
Error	imports	AvoidStarImport	Using the '.*' form of import should be avoided - lombok.*.	6
Error	imports	AvoidStarImport	Using the '.*' form of import should be avoided - jakarta.xml.bind.annotation.*.	10
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	29
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	34

de/kaiserpfalzedv/services/dnb/marcxml/model/DataField.java

Severity	Category	Rule	Message	Line
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	29
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	41
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	45
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	48
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	52

de/kaiserpfalzedv/services/dnb/marcxml/model/Marc21Record.java

Severity	Category	Rule	Message	Line
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	29
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	41
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	43
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	45
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	50

de/kaiserpfalzedv/services/dnb/marcxml/model/Record.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	imports	AvoidStarImport	Using the '.*' form of import should be avoided - lombok.*.	4
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	31
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	33
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	36
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	39

de/kaiserpfalzedv/services/dnb/marcxml/model/RecordData.java

Severity	Category	Rule	Message	Line
Error	imports	AvoidStarImport	Using the '.*' form of import should be avoided - lombok.*.	4
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30

de/kaiserpfalzedv/services/dnb/marcxml/model/SearchRetrieveRequest.java

Severity	Category	Rule	Message	Line
Error	imports	AvoidStarImport	Using the '.*' form of import should be avoided - lombok.*.	4
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	32
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	35
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	37
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	40
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	42
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	45

de/kaiserpfalzedv/services/dnb/marcxml/model/SearchRetrieveResponse.java

Severity	Category	Rule	Message	Line
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	28
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	41
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	43
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	46
Error	design	VisibilityModifier	Variable 'records' must be private and have accessor methods.	48
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	50
Error	design	VisibilityModifier	Variable 'echoedSearchRetrieveRequest' must be private and have accessor methods.	51

de/kaiserpfalzedv/services/dnb/marcxml/model/SubField.java

Severity	Category	Rule	Message	Line
Error	imports	AvoidStarImport	Using the '.*' form of import should be avoided - lombok.*.	6
Error	imports	AvoidStarImport	Using the '.*' form of import should be avoided - jakarta.xml.bind.annotation.*.	10
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	29
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	33

de/kaiserpfalzedv/services/dnb/marcxml/package-info.java

Severity	Category	Rule	Message	Line
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1

de/kaiserpfalzedv/services/dnb/model/Book.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	javadoc	JavadocStyle	First sentence should end with a period.	41
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	47
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	57
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	59
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	63
Error	coding	MagicNumber	'1024' is a magic number.	64
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	66
Error	coding	MagicNumber	'1024' is a magic number.	67
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	69
Error	coding	MagicNumber	'1024' is a magic number.	69
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	72
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	76
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	78
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	79
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	81
Error	coding	MagicNumber	'1024' is a magic number.	81
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	83
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	84
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	86
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	87
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	88
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	90
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	92
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	94
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	95
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	96

de/kaiserpfalzedv/services/dnb/model/LibraryLookupException.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocStyle	First sentence should end with a period.	23
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	31
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	33
Error	coding	HiddenField	'code' hides a field.	33

de/kaiserpfalzedv/services/dnb/package-info.java

Severity	Category	Rule	Message	Line
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1