6

Concerning rule squid: S109 Magic numbers should not be used

Shouldn't it be allowed to have numbers in the constructor of an enum in java? The code below shouldn't violate the rule in my opinion.

public enum Color{
   RED(42),
   GREEN(123456),
   BLUE(666);

   public final int code;

   Color(int colorCode){
      this.code=colorCode;
   }    
}

I'm using Sonar java plugin version 3.3

Mithfindel
  • 4,553
  • 1
  • 23
  • 32
DEG
  • 65
  • 1
  • 5

2 Answers2

2

It will be fixed in version 3.4

See this issue on SonarSource : http://jira.sonarsource.com/browse/SONARJAVA-1117

Dams
  • 997
  • 12
  • 28
0

Technically, yes there is nothing wrong with your code. The code shows that the color code for each enum type is based on the constructor (like red is 42). But, squid rule dictates that this could be "confusing" when someone is trying to debug the code (particularly, a big piece of code).

This is taken from the squid rule documentation.

Using magic numbers may seem obvious and straightforward when you're writing a piece of code, but they are much less obvious and straightforward at debugging time.

That is why magic numbers must be demystified by first being assigned to clearly named constants before being used.

-1, 0 and 1 are not considered magic numbers

So, in your code, you may want to do something like this.

public enum Color{
   public final int RED_CODE = 42;
   RED(RED_CODE);

   public final int code;

   Color(int colorCode){
      this.code=colorCode;
   }    
}

or might as well disable the rule :D

Community
  • 1
  • 1
kucing_terbang
  • 4,991
  • 2
  • 22
  • 28
  • I know the rule and agree with it. So i do not want to disable it. Extracting the constructor arguments to constants decreases the readability of the code. Whereas the rule is just there to increase it. But luckily it will be fixed in 3.4. – DEG Jun 24 '15 at 08:27