CodeNarc Report: My Sample Code

Report timestamp: Aug 25, 2009 9:38:58 PM

Summary by Package

Package	Total Files	Files with Violations	Priority 1	Priority 2	Priority 3
All Packages	7	5	2	11	5
org/codenarc/sample/domain	2	2	1	3	2
org/codenarc/sample/other	1	0	0	0	0
org/codenarc/sample/service	4	3	1	8	3

org/codenarc/sample/domain

org/codenarc/sample/domain/OtherDomain.groovy

Rule Name	Priority	Line #	Source Line / Message
MyStaticField	2	7	[SRC]static final MAX_COUNT = 10

org/codenarc/sample/domain/SampleDomain.groovy

Rule Name	Priority	Line #	Source Line / Message
DuplicateImport	1	5	[SRC]import org.codenarc.sample.other.Other
EmptyElseBlock	2	24	[SRC]else {
EmptyIfStatement	2	21	[SRC]if (name) {
ImportFromSamePackage	3	4	[SRC]import org.codenarc.sample.domain.OtherDomain
UnnecessaryGroovyImport	3	3	[SRC]import java.util.Map

org/codenarc/sample/service

org/codenarc/sample/service/NewService.groovy

Rule Name	Priority	Line #	Source Line / Message
EmptyForStatement	2	12	[SRC]for(int i=0; i < values.size(); i++) {
EmptyWhileStatement	2	18	[SRC]while (!values.empty) {
MyStaticField	2	7	[SRC]static final DEFAULT_ID = 999

org/codenarc/sample/service/OtherService.groovy

Rule Name	Priority	Line #	Source Line / Message
ReturnFromFinallyBlock	1	24	[SRC]return
EmptyFinallyBlock	2	13	[SRC]finally {
EmptyTryBlock	2	10	[SRC]try {

org/codenarc/sample/service/SampleService.groovy

Rule Name	Priority	Line #	Source Line / Message
BooleanInstantiation	2	17	[SRC]def shouldRun = new Boolean(true)
EmptyCatchBlock	2	20	[SRC]} catch(Throwable t) {
ThrowExceptionFromFinallyBlock	2	31	[SRC]throw new Exception('bad stuff')
UnnecessaryGroovyImport	3	3	[SRC]import java.util.Map
UnusedImport	3	4	[SRC]import org.codenarc.sample.domain.SampleDomain
AuthorTagNotAllowed	3	8	[SRC]@author

Rule Descriptions

#	Rule Name	Description
1	AuthorTagNotAllowed	[Example Custom Rule Description] The @author tag is not allowed
2	BooleanInstantiation	Use Boolean.valueOf() for variable values or Boolean.TRUE and Boolean.FALSE for constant values instead of calling the Boolean() constructor directly or calling Boolean.valueOf(true) or Boolean.valueOf(false).
3	DuplicateImport	Duplicate import statements are unnecessary.
4	EmptyCatchBlock	In most cases, exceptions should not be caught and ignored (swallowed).
5	EmptyElseBlock	Empty else blocks are confusing and serve no purpose.
6	EmptyFinallyBlock	Empty finally blocks are confusing and serve no purpose.
7	EmptyForStatement	Empty for statements are confusing and serve no purpose.
8	EmptyIfStatement	Empty if statements are confusing and serve no purpose.
9	EmptySwitchStatement	Empty switch statements are confusing and serve no purpose.
10	EmptySynchronizedStatement	Empty synchronized statements are confusing and serve no purpose.
11	EmptyTryBlock	Empty try blocks are confusing and serve no purpose.
12	EmptyWhileStatement	Empty while statements are confusing and serve no purpose.
13	EqualsAndHashCode	If either the boolean equals(Object) or the int hashCode() methods are overridden within a class, then both must be overridden.
14	ImportFromSamePackage	An import of a class that is within the same package is unnecessary.
15	MyStaticField	[Example Custom Rule Description] Check for static fields.
16	ReturnFromFinallyBlock	Returning from a finally block is confusing and can hide the original exception.
17	ThrowExceptionFromFinallyBlock	Throwing an exception from a finally block is confusing and can hide the original exception.
18	UnnecessaryGroovyImport	A Groovy file does not need to include an import for classes from java.lang, java.util, java.io, java.net, groovy.lang and groovy.util, as well as the classes java.math.BigDecimal and java.math.BigInteger.
19	UnusedImport	Imports for a class that is never referenced within the source file is unnecessary.