Checkstyle Results

The following document contains the results of Checkstyle 8.29 with sun_checks.xml ruleset. 

Summary

Files	Info	Warnings	Errors
10	0	0	143

Files

File	I	W	E
mastermicro/topologies/components/Component.java	0	0	31
mastermicro/topologies/components/ComponentParameter.java	0	0	40
mastermicro/topologies/components/NMOSTransistor.java	0	0	13
mastermicro/topologies/components/Resistor.java	0	0	10
mastermicro/topologies/components/UnrecognizedTerminalException.java	0	0	3
mastermicro/topologies/controller/Controller.java	0	0	18
mastermicro/topologies/io/FileReader.java	0	0	6
mastermicro/topologies/io/InvalidJSONException.java	0	0	2
mastermicro/topologies/io/JSONSerializable.java	0	0	2
mastermicro/topologies/topology/Topology.java	0	0	18

Rules

Category	Rule	Violations	Severity
blocks	LeftCurly	3	Error
	NeedBraces	16	Error
coding	HiddenField	10	Error
	MagicNumber	1	Error
design	DesignForExtension	16	Error
	HideUtilityClassConstructor	1	Error
	VisibilityModifier	6	Error
javadoc	JavadocMethod	1	Error
	JavadocPackage	4	Error
	JavadocVariable	12	Error
	MissingJavadocMethod	21	Error
misc	FinalParameters	32	Error
modifier	RedundantModifier	1	Error
naming	MemberName	1	Error
	ParameterName	1	Error
regexp	RegexpSingleline format: "\s+$" maximum: "0" message: "Line has trailing spaces." minimum: "0"	3	Error
sizes	LineLength fileExtensions: "java"	12	Error
whitespace	WhitespaceAfter	2	Error

Details

mastermicro/topologies/components/Component.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	12
Error	design	VisibilityModifier	Variable 'id' must be private and have accessor methods.	12
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	13
Error	design	VisibilityModifier	Variable 'netlist' must be private and have accessor methods.	13
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	15
Error	misc	FinalParameters	Parameter id should be final.	15
Error	coding	HiddenField	'id' hides a field.	15
Error	sizes	LineLength	Line is longer than 80 characters (found 100).	19
Error	design	DesignForExtension	Class 'Component' looks like designed for extension (can be subclassed), but the method 'connectTerminal' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Component' final or making the method 'connectTerminal' static/final/abstract/empty, or adding allowed annotation for the method.	19
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	19
Error	misc	FinalParameters	Parameter terminal should be final.	19
Error	misc	FinalParameters	Parameter node should be final.	19
Error	sizes	LineLength	Line is longer than 80 characters (found 90).	24
Error	design	DesignForExtension	Class 'Component' looks like designed for extension (can be subclassed), but the method 'disconnectTerminal' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Component' final or making the method 'disconnectTerminal' static/final/abstract/empty, or adding allowed annotation for the method.	24
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	24
Error	misc	FinalParameters	Parameter terminal should be final.	24
Error	sizes	LineLength	Line is longer than 80 characters (found 91).	29
Error	design	DesignForExtension	Class 'Component' looks like designed for extension (can be subclassed), but the method 'validateTerminal' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Component' final or making the method 'validateTerminal' static/final/abstract/empty, or adding allowed annotation for the method.	29
Error	misc	FinalParameters	Parameter terminal should be final.	29
Error	blocks	NeedBraces	'if' construct must use '{}'s.	30
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	34
Error	regexp	RegexpSingleline	Line has trailing spaces.	40
Error	javadoc	JavadocMethod	Expected @return tag.	43
Error	misc	FinalParameters	Parameter node should be final.	43
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	48
Error	misc	FinalParameters	Parameter json should be final.	48
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	53
Error	misc	FinalParameters	Parameter obj should be final.	53
Error	sizes	LineLength	Line is longer than 80 characters (found 82).	70
Error	blocks	NeedBraces	'if' construct must use '{}'s.	78
Error	sizes	LineLength	Line is longer than 80 characters (found 84).	79

mastermicro/topologies/components/ComponentParameter.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	7
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	8
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	9
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	11
Error	misc	FinalParameters	Parameter defaultValue should be final.	11
Error	coding	HiddenField	'defaultValue' hides a field.	11
Error	misc	FinalParameters	Parameter min should be final.	11
Error	coding	HiddenField	'min' hides a field.	11
Error	misc	FinalParameters	Parameter max should be final.	11
Error	coding	HiddenField	'max' hides a field.	11
Error	sizes	LineLength	Line is longer than 80 characters (found 85).	12
Error	design	DesignForExtension	Class 'ComponentParameter' looks like designed for extension (can be subclassed), but the method 'getDefault' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ComponentParameter' final or making the method 'getDefault' static/final/abstract/empty, or adding allowed annotation for the method.	18
Error	blocks	LeftCurly	'{' at column 32 should have line break after.	18
Error	design	DesignForExtension	Class 'ComponentParameter' looks like designed for extension (can be subclassed), but the method 'getMin' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ComponentParameter' final or making the method 'getMin' static/final/abstract/empty, or adding allowed annotation for the method.	19
Error	blocks	LeftCurly	'{' at column 28 should have line break after.	19
Error	design	DesignForExtension	Class 'ComponentParameter' looks like designed for extension (can be subclassed), but the method 'getMax' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ComponentParameter' final or making the method 'getMax' static/final/abstract/empty, or adding allowed annotation for the method.	20
Error	blocks	LeftCurly	'{' at column 28 should have line break after.	20
Error	design	DesignForExtension	Class 'ComponentParameter' looks like designed for extension (can be subclassed), but the method 'setDefault' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ComponentParameter' final or making the method 'setDefault' static/final/abstract/empty, or adding allowed annotation for the method.	22
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	22
Error	misc	FinalParameters	Parameter defaultValue should be final.	22
Error	coding	HiddenField	'defaultValue' hides a field.	22
Error	blocks	NeedBraces	'if' construct must use '{}'s.	23
Error	blocks	NeedBraces	'if' construct must use '{}'s.	25
Error	design	DesignForExtension	Class 'ComponentParameter' looks like designed for extension (can be subclassed), but the method 'setMin' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ComponentParameter' final or making the method 'setMin' static/final/abstract/empty, or adding allowed annotation for the method.	30
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	30
Error	misc	FinalParameters	Parameter min should be final.	30
Error	coding	HiddenField	'min' hides a field.	30
Error	blocks	NeedBraces	'if' construct must use '{}'s.	31
Error	blocks	NeedBraces	'if' construct must use '{}'s.	34
Error	design	DesignForExtension	Class 'ComponentParameter' looks like designed for extension (can be subclassed), but the method 'setMax' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ComponentParameter' final or making the method 'setMax' static/final/abstract/empty, or adding allowed annotation for the method.	38
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	38
Error	misc	FinalParameters	Parameter max should be final.	38
Error	coding	HiddenField	'max' hides a field.	38
Error	blocks	NeedBraces	'if' construct must use '{}'s.	40
Error	blocks	NeedBraces	'if' construct must use '{}'s.	42
Error	design	DesignForExtension	Class 'ComponentParameter' looks like designed for extension (can be subclassed), but the method 'toJSON' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ComponentParameter' final or making the method 'toJSON' static/final/abstract/empty, or adding allowed annotation for the method.	46
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	55
Error	misc	FinalParameters	Parameter json should be final.	55
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	60
Error	misc	FinalParameters	Parameter obj should be final.	60

mastermicro/topologies/components/NMOSTransistor.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	7
Error	naming	MemberName	Name 'm_l' must match pattern '^[a-z][a-zA-Z0-9]*$'.	7
Error	design	VisibilityModifier	Variable 'm_l' must be private and have accessor methods.	7
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	8
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	9
Error	whitespace	WhitespaceAfter	',' is not followed by whitespace.	9
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	12
Error	misc	FinalParameters	Parameter id should be final.	12
Error	misc	FinalParameters	Parameter m_l should be final.	12
Error	coding	HiddenField	'm_l' hides a field.	12
Error	naming	ParameterName	Name 'm_l' must match pattern '^[a-z][a-zA-Z0-9]*$'.	12
Error	design	DesignForExtension	Class 'NMOSTransistor' looks like designed for extension (can be subclassed), but the method 'toJSON' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NMOSTransistor' final or making the method 'toJSON' static/final/abstract/empty, or adding allowed annotation for the method.	17
Error	design	DesignForExtension	Class 'NMOSTransistor' looks like designed for extension (can be subclassed), but the method 'getAvailableTerminals' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NMOSTransistor' final or making the method 'getAvailableTerminals' static/final/abstract/empty, or adding allowed annotation for the method.	27

mastermicro/topologies/components/Resistor.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	7
Error	design	VisibilityModifier	Variable 'resistance' must be private and have accessor methods.	7
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	8
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	12
Error	misc	FinalParameters	Parameter id should be final.	12
Error	misc	FinalParameters	Parameter resistance should be final.	12
Error	coding	HiddenField	'resistance' hides a field.	12
Error	design	DesignForExtension	Class 'Resistor' looks like designed for extension (can be subclassed), but the method 'toJSON' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Resistor' final or making the method 'toJSON' static/final/abstract/empty, or adding allowed annotation for the method.	17
Error	design	DesignForExtension	Class 'Resistor' looks like designed for extension (can be subclassed), but the method 'getAvailableTerminals' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Resistor' final or making the method 'getAvailableTerminals' static/final/abstract/empty, or adding allowed annotation for the method.	27

mastermicro/topologies/components/UnrecognizedTerminalException.java

Severity	Category	Rule	Message	Line
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	4
Error	misc	FinalParameters	Parameter terminal should be final.	4
Error	sizes	LineLength	Line is longer than 80 characters (found 100).	5

mastermicro/topologies/controller/Controller.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	11
Error	regexp	RegexpSingleline	Line has trailing spaces.	16
Error	regexp	RegexpSingleline	Line has trailing spaces.	26
Error	misc	FinalParameters	Parameter topologyId should be final.	29
Error	blocks	NeedBraces	'for' construct must use '{}'s.	30
Error	blocks	NeedBraces	'if' construct must use '{}'s.	31
Error	sizes	LineLength	Line is longer than 80 characters (found 83).	38
Error	design	DesignForExtension	Class 'Controller' looks like designed for extension (can be subclassed), but the method 'deleteTopology' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Controller' final or making the method 'deleteTopology' static/final/abstract/empty, or adding allowed annotation for the method.	43
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	43
Error	misc	FinalParameters	Parameter id should be final.	43
Error	blocks	NeedBraces	'for' construct must use '{}'s.	44
Error	blocks	NeedBraces	'if' construct must use '{}'s.	45
Error	sizes	LineLength	Line is longer than 80 characters (found 88).	54
Error	misc	FinalParameters	Parameter jsonFilePath should be final.	54
Error	sizes	LineLength	Line is longer than 80 characters (found 96).	65
Error	misc	FinalParameters	Parameter topologyId should be final.	65
Error	misc	FinalParameters	Parameter jsonFilePath should be final.	65

mastermicro/topologies/io/FileReader.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	design	HideUtilityClassConstructor	Utility classes should not have a public or default constructor.	7
Error	sizes	LineLength	Line is longer than 80 characters (found 81).	8
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	8
Error	misc	FinalParameters	Parameter filepath should be final.	8
Error	blocks	NeedBraces	'while' construct must use '{}'s.	11

mastermicro/topologies/io/InvalidJSONException.java

Severity	Category	Rule	Message	Line
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	4
Error	misc	FinalParameters	Parameter message should be final.	4

mastermicro/topologies/io/JSONSerializable.java

Severity	Category	Rule	Message	Line
Error	sizes	LineLength	Line is longer than 80 characters (found 92).	7
Error	modifier	RedundantModifier	Redundant 'public' modifier.	12

mastermicro/topologies/topology/Topology.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.	1
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	12
Error	design	VisibilityModifier	Variable 'id' must be private and have accessor methods.	12
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	13
Error	design	VisibilityModifier	Variable 'components' must be private and have accessor methods.	13
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	15
Error	misc	FinalParameters	Parameter id should be final.	15
Error	coding	HiddenField	'id' hides a field.	15
Error	misc	FinalParameters	Parameter node should be final.	24
Error	coding	MagicNumber	'3' is a magic number.	25
Error	blocks	NeedBraces	'for' construct must use '{}'s.	26
Error	blocks	NeedBraces	'if' construct must use '{}'s.	27
Error	design	DesignForExtension	Class 'Topology' looks like designed for extension (can be subclassed), but the method 'toJSON' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Topology' final or making the method 'toJSON' static/final/abstract/empty, or adding allowed annotation for the method.	32
Error	blocks	NeedBraces	'for' construct must use '{}'s.	38
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	45
Error	misc	FinalParameters	Parameter json should be final.	45
Error	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	50
Error	misc	FinalParameters	Parameter obj should be final.	50