Generators for DJUNITS classes

djunits-generator 4.01.06

MODULES

• djunits
• djunits-demo
• djunits-generator

API

• JavaDocs

PROJECT REPORTS

• Reports
• Source Xref
• Checkstyle
• Tag List
• SpotBugs
• CPD
• PMD

PROJECT INFO

• About
• Project Summary
• Dependencies
• Project Team
• Project License

RELATED

• OpenTrafficSim
• DSOL
• DJUNITS manual
• DITTLab
• Simulation@TU Delft
• About DJUNITS

Checkstyle Results

The following document contains the results of Checkstyle 8.35 with /src/main/resources/development/dsol-checks_6_11.xml ruleset. 

Summary

Files	Info	Warnings	Errors
11	10	85	0

Files

File	I	W	E
org/djunits/cleanup/ParamComments.java	0	2	0
org/djunits/generator/GenerateCliConverters.java	2	20	0
org/djunits/generator/GenerateCliConvertersTest.java	4	19	0
org/djunits/generator/GenerateDJUNIT.java	0	19	0
org/djunits/generator/GenerateStaticUNITS.java	3	2	0
org/djunits/generator/GenerateUSLocale.java	0	3	0
org/djunits/generator/GenerateXSD.java	1	18	0
org/djunits/generator/URLResource.java	0	2	0

Rules

Category	Rule	Violations	Severity
blocks	NeedBraces	12	Warning
design	DesignForExtension	2	Warning
	HideUtilityClassConstructor	5	Warning
	VisibilityModifier	8	Warning
javadoc	JavadocStyle	1	Warning
misc	ArrayTypeStyle	4	Warning
	FinalParameters	27	Warning
	TodoComment	1	Warning
modifier	RedundantModifier	2	Warning
naming	ConstantName	3	Warning
sizes	LineLength max: "128"	10	Info
whitespace	OperatorWrap	20	Warning

Details

org/djunits/cleanup/ParamComments.java

Severity	Category	Rule	Message	Line
Warning	design	DesignForExtension	Class 'CodeVisitor' looks like designed for extension (can be subclassed), but the method 'visit' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'CodeVisitor' final or making the method 'visit' static/final/abstract/empty, or adding allowed annotation for the method.	152
Warning	design	DesignForExtension	Class 'CodeVisitor' looks like designed for extension (can be subclassed), but the method 'visit' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'CodeVisitor' final or making the method 'visit' static/final/abstract/empty, or adding allowed annotation for the method.	165

org/djunits/generator/GenerateCliConverters.java

Severity	Category	Rule	Message	Line
Warning	design	HideUtilityClassConstructor	Utility classes should not have a public or default constructor.	19
Warning	misc	FinalParameters	Parameter args should be final.	27
Warning	whitespace	OperatorWrap	'+' should be on a new line.	41
Warning	whitespace	OperatorWrap	'+' should be on a new line.	42
Warning	whitespace	OperatorWrap	'+' should be on a new line.	43
Warning	whitespace	OperatorWrap	'+' should be on a new line.	44
Warning	whitespace	OperatorWrap	'+' should be on a new line.	45
Warning	whitespace	OperatorWrap	'+' should be on a new line.	46
Warning	whitespace	OperatorWrap	'+' should be on a new line.	76
Info	sizes	LineLength	Line is longer than 128 characters (found 154).	77
Warning	whitespace	OperatorWrap	'+' should be on a new line.	77
Warning	whitespace	OperatorWrap	'+' should be on a new line.	78
Warning	whitespace	OperatorWrap	'+' should be on a new line.	79
Warning	whitespace	OperatorWrap	'+' should be on a new line.	80
Warning	whitespace	OperatorWrap	'+' should be on a new line.	81
Warning	whitespace	OperatorWrap	'+' should be on a new line.	82
Info	sizes	LineLength	Line is longer than 128 characters (found 138).	83
Warning	whitespace	OperatorWrap	'+' should be on a new line.	83
Warning	whitespace	OperatorWrap	'+' should be on a new line.	84
Warning	whitespace	OperatorWrap	'+' should be on a new line.	85
Warning	whitespace	OperatorWrap	'+' should be on a new line.	86
Warning	whitespace	OperatorWrap	'+' should be on a new line.	87

org/djunits/generator/GenerateCliConvertersTest.java

Severity	Category	Rule	Message	Line
Warning	design	HideUtilityClassConstructor	Utility classes should not have a public or default constructor.	16
Info	sizes	LineLength	Line is longer than 128 characters (found 133).	34
Warning	misc	FinalParameters	Parameter args should be final.	122
Warning	whitespace	OperatorWrap	'+' should be on a new line.	133
Info	sizes	LineLength	Line is longer than 128 characters (found 151).	134
Warning	whitespace	OperatorWrap	'+' should be on a new line.	134
Info	sizes	LineLength	Line is longer than 128 characters (found 143).	158
Info	sizes	LineLength	Line is longer than 128 characters (found 145).	161
Warning	design	VisibilityModifier	Variable 'type' must be private and have accessor methods.	170
Warning	design	VisibilityModifier	Variable 'amount1' must be private and have accessor methods.	173
Warning	design	VisibilityModifier	Variable 'unit1' must be private and have accessor methods.	176
Warning	design	VisibilityModifier	Variable 'value1' must be private and have accessor methods.	179
Warning	design	VisibilityModifier	Variable 'amount2' must be private and have accessor methods.	182
Warning	design	VisibilityModifier	Variable 'unit2' must be private and have accessor methods.	185
Warning	design	VisibilityModifier	Variable 'value2' must be private and have accessor methods.	188
Warning	modifier	RedundantModifier	Redundant 'public' modifier.	199
Warning	misc	FinalParameters	Parameter type should be final.	199
Warning	misc	FinalParameters	Parameter amount1 should be final.	199
Warning	misc	FinalParameters	Parameter unit1 should be final.	199
Warning	misc	FinalParameters	Parameter value1 should be final.	199
Warning	misc	FinalParameters	Parameter amount2 should be final.	199
Warning	misc	FinalParameters	Parameter unit2 should be final.	199
Warning	misc	FinalParameters	Parameter value2 should be final.	199

org/djunits/generator/GenerateDJUNIT.java

Severity	Category	Rule	Message	Line
Warning	design	HideUtilityClassConstructor	Utility classes should not have a public or default constructor.	27
Warning	naming	ConstantName	Name 'generatedCodeRelativePath' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.	30
Warning	misc	FinalParameters	Parameter java should be final.	180
Warning	misc	FinalParameters	Parameter errorType should be final.	180
Warning	misc	FinalParameters	Parameter prefix should be final.	180
Warning	misc	FinalParameters	Parameter java should be final.	236
Warning	misc	FinalParameters	Parameter type should be final.	236
Warning	misc	ArrayTypeStyle	Array brackets at illegal position.	363
Warning	misc	FinalParameters	Parameter java should be final.	429
Warning	misc	FinalParameters	Parameter errorType should be final.	429
Warning	misc	FinalParameters	Parameter prefix should be final.	429
Warning	misc	ArrayTypeStyle	Array brackets at illegal position.	472
Warning	misc	ArrayTypeStyle	Array brackets at illegal position.	544
Warning	misc	FinalParameters	Parameter java should be final.	611
Warning	misc	FinalParameters	Parameter errorType should be final.	611
Warning	misc	FinalParameters	Parameter prefix should be final.	611
Warning	misc	ArrayTypeStyle	Array brackets at illegal position.	725
Warning	misc	FinalParameters	Parameter path should be final.	1069
Warning	misc	FinalParameters	Parameter args should be final.	1091

org/djunits/generator/GenerateStaticUNITS.java

Severity	Category	Rule	Message	Line
Warning	misc	FinalParameters	Parameter args should be final.	39
Info	sizes	LineLength	Line is longer than 128 characters (found 142).	45
Info	sizes	LineLength	Line is longer than 128 characters (found 141).	47
Info	sizes	LineLength	Line is longer than 128 characters (found 142).	57
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	103

org/djunits/generator/GenerateUSLocale.java

Severity	Category	Rule	Message	Line
Warning	design	HideUtilityClassConstructor	Utility classes should not have a public or default constructor.	19
Warning	misc	FinalParameters	Parameter o1 should be final.	92
Warning	misc	FinalParameters	Parameter o2 should be final.	92

org/djunits/generator/GenerateXSD.java

Severity	Category	Rule	Message	Line
Warning	design	HideUtilityClassConstructor	Utility classes should not have a public or default constructor.	19
Warning	naming	ConstantName	Name 'generatedCodeRelativePath' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.	22
Warning	misc	TodoComment	Comment matches to-do format 'TODO:'.	38
Info	sizes	LineLength	Line is longer than 128 characters (found 131).	57
Warning	design	VisibilityModifier	Variable 'first' must be private and have accessor methods.	159
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	193
Warning	blocks	NeedBraces	'else' construct must use '{}'s.	195
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	207
Warning	blocks	NeedBraces	'else' construct must use '{}'s.	209
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	215
Warning	blocks	NeedBraces	'for' construct must use '{}'s.	219
Warning	javadoc	JavadocStyle	First sentence should end with a period.	226
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	268
Warning	blocks	NeedBraces	'for' construct must use '{}'s.	272
Warning	naming	ConstantName	Name 'escape' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.	280
Warning	misc	FinalParameters	Parameter s should be final.	286
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	291
Warning	blocks	NeedBraces	'if' construct must use '{}'s.	293
Warning	blocks	NeedBraces	'else' construct must use '{}'s.	295

org/djunits/generator/URLResource.java

Severity	Category	Rule	Message	Line
Warning	misc	FinalParameters	Parameter path should be final.	199
Warning	modifier	RedundantModifier	Redundant 'public' modifier.	273