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
  • JaCoCo
  • dependency-check
  • Javadoc
  • Test Javadoc
  • 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
17	0	0	112

Files

File	I	W	E
de/kaiserpfalzedv/commons/core/data/PagingImpl.java	0	0	8
de/kaiserpfalzedv/commons/core/i18n/ResourceBundleTranslator.java	0	0	16
de/kaiserpfalzedv/commons/core/libravatar/AvatarGenerator.java	0	0	3
de/kaiserpfalzedv/commons/core/libravatar/AvatarImpl.java	0	0	2
de/kaiserpfalzedv/commons/core/libravatar/package-info.java	0	0	2
de/kaiserpfalzedv/commons/core/resources/DefaultResourceSpecImpl.java	0	0	5
de/kaiserpfalzedv/commons/core/resources/HistoryImpl.java	0	0	5
de/kaiserpfalzedv/commons/core/resources/MetadataImpl.java	0	0	18
de/kaiserpfalzedv/commons/core/resources/PointerImpl.java	0	0	8
de/kaiserpfalzedv/commons/core/resources/ResourceImpl.java	0	0	10
de/kaiserpfalzedv/commons/core/resources/StatusImpl.java	0	0	6
de/kaiserpfalzedv/commons/core/store/GenericStoreService.java	0	0	1
de/kaiserpfalzedv/commons/core/user/MemoryUserStore.java	0	0	8
de/kaiserpfalzedv/commons/core/user/UserDataImpl.java	0	0	5
de/kaiserpfalzedv/commons/core/user/UserImpl.java	0	0	2
de/kaiserpfalzedv/commons/core/workflow/WorkflowDetailInfoImpl.java	0	0	7
de/kaiserpfalzedv/commons/core/workflow/WorkflowInfoImpl.java	0	0	6

Rules

Category	Rule	Violations	Severity
blocks	LeftCurly	1	Error
	NeedBraces	1	Error
coding	HiddenField	3	Error
	MagicNumber	8	Error
design	VisibilityModifier	5	Error
javadoc	JavadocPackage	6	Error
	JavadocStyle	5	Error
	JavadocVariable	43	Error
	MissingJavadocMethod	6	Error
misc	FinalParameters	1	Error
	NewlineAtEndOfFile	9	Error
sizes	LineLength fileExtensions: "java" max: "150"	2	Error
whitespace	WhitespaceAfter	20	Error
	WhitespaceAround	2	Error

Details

de/kaiserpfalzedv/commons/core/data/PagingImpl.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.	33
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	53
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	56
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	59
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	61
Error	coding	HiddenField	'start' hides a field.	101
Error	coding	HiddenField	'start' hides a field.	113

de/kaiserpfalzedv/commons/core/i18n/ResourceBundleTranslator.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	59
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	59
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	59
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	59
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	59
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	74
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	77
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	81
Error	coding	HiddenField	'defaultBundle' hides a field.	81
Error	misc	FinalParameters	Parameter locale should be final.	132
Error	blocks	LeftCurly	'{' at column 30 should have line break after.	183
Error	whitespace	WhitespaceAround	'{' is not followed by whitespace.	183
Error	whitespace	WhitespaceAfter	';' is not followed by whitespace.	183
Error	whitespace	WhitespaceAround	'}' is not preceded with whitespace.	183
Error	blocks	NeedBraces	'if' construct must use '{}'s.	207

de/kaiserpfalzedv/commons/core/libravatar/AvatarGenerator.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	37
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	39
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	43

de/kaiserpfalzedv/commons/core/libravatar/AvatarImpl.java

Severity	Category	Rule	Message	Line
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	54

de/kaiserpfalzedv/commons/core/libravatar/package-info.java

Severity	Category	Rule	Message	Line
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1
Error	sizes	LineLength	Line is longer than 150 characters (found 159).	21

de/kaiserpfalzedv/commons/core/resources/DefaultResourceSpecImpl.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	61
Error	coding	MagicNumber	'5' is a magic number.	78
Error	coding	MagicNumber	'3' is a magic number.	87
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	104
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	104

de/kaiserpfalzedv/commons/core/resources/HistoryImpl.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	62
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	75
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	89
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	98
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	98

de/kaiserpfalzedv/commons/core/resources/MetadataImpl.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocStyle	First sentence should end with a period.	75
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	79
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	89
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	95
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	110
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	121
Error	design	VisibilityModifier	Variable 'created' must be private and have accessor methods.	125
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	127
Error	design	VisibilityModifier	Variable 'modified' must be private and have accessor methods.	131
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	133
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	137
Error	coding	MagicNumber	'256' is a magic number.	142
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	146
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	149
Error	coding	MagicNumber	'256' is a magic number.	154
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	158
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	213
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	213

de/kaiserpfalzedv/commons/core/resources/PointerImpl.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocStyle	First sentence should end with a period.	60
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	63
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	78
Error	sizes	LineLength	Line is longer than 150 characters (found 151).	87
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	91
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	106
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	120
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	120

de/kaiserpfalzedv/commons/core/resources/ResourceImpl.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocStyle	First sentence should end with a period.	63
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	66
Error	design	VisibilityModifier	Variable 'metadata' must be private and have accessor methods.	74
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	77
Error	design	VisibilityModifier	Variable 'spec' must be private and have accessor methods.	83
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	86
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	92
Error	design	VisibilityModifier	Variable 'status' must be private and have accessor methods.	93
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	144
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	149

de/kaiserpfalzedv/commons/core/resources/StatusImpl.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	58
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	63
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	65
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	81
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	81

de/kaiserpfalzedv/commons/core/store/GenericStoreService.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1

de/kaiserpfalzedv/commons/core/user/MemoryUserStore.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocStyle	First sentence should end with a period.	28
Error	coding	MagicNumber	'100' is a magic number.	36
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1

de/kaiserpfalzedv/commons/core/user/UserDataImpl.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	56
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	61
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	64
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	66

de/kaiserpfalzedv/commons/core/user/UserImpl.java

Severity	Category	Rule	Message	Line
Error	misc	NewlineAtEndOfFile	File does not end with a newline.	1
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	45

de/kaiserpfalzedv/commons/core/workflow/WorkflowDetailInfoImpl.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	62
Error	coding	MagicNumber	'100' is a magic number.	66
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	71
Error	coding	MagicNumber	'100' is a magic number.	76
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	82
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	92
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	102

de/kaiserpfalzedv/commons/core/workflow/WorkflowInfoImpl.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	58
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	66
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	74
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	82
Error	coding	MagicNumber	'100' is a magic number.	87