Update for existing Check: LocalVariableName

[maxvetrenko]

Update LocalVariableName to allow one-character for temporary and looping variables. http://google-styleguide.googlecode.com/svn/trunk/javaguide.html#s5.2.7-local-variable-names

[rdiachenko]

Allow one character loop variable.

Change to "Allow one character variable in for loops."

mAllowOneCharForLoopVar

Change to "mAllowOneCharVarInForLoop

if(isForLoopVariable(aAST) && mAllowOneCharForLoopVar) {

Should be "if(mAllowOneCharForLoopVar && isForLoopVariable(aAST)) {"

if variable is loop variable.

Change to "if a variable is the loop's one"

if(isForLoopVariable(aAST) && mAllowOneCharForLoopVar) {

•      String variableName = aAST.findFirstToken(TokenTypes.IDENT).getText();
  

•      return !aSingleChar.matcher(variableName).find();
  

•    }
  

I think your logic won't work properly if there is a loop variable with multiple chars:

for(int index = 1; index <10; index++) {
//come code
}

Please add this case into your test input and check

[rdiachenko]

Also update the check's documentation and xdocs

[maxvetrenko]

Change to "Allow one character variable in for loops."

Done

Change to "mAllowOneCharVarInForLoop

Done

Should be "if(mAllowOneCharForLoopVar && isForLoopVariable(aAST)) {"

Done

Change to "if a variable is the loop's one"

Done

I think your logic won't work properly if there is a loop variable with multiple chars:

I have added this case (InputSimple) and UTs did't fall.

Also update the check's documentation and xdocs

Done

[rdiachenko]

An example how to configure the check to allow

Change to "An example of how to configure the check to allow"

•    for(Integer k = 1; k <10; k++) {
  

  •      //come code
    

  •  }
    

  •    for(double d = 1; d <10; d++) {
    

  •      //come code
    

  •  }
    

  •    for(long l = 1; l <10; l++) {
    

  •      //come code
    

  •  }
    

There are a lot of simular test inputs and they all cover the same case. Please remove redundant inputs and add the new ones you don't have:

for (int i=0,j=1; ...)

int index = 0;
for (index < 10; index++)...

for (Map.Entry<String,Integer> e : map.entrySet()) ....

etc.

Module LocalVariableName also has the following properties:

Change to "The check provides the following properties:"

[maxvetrenko]

Change to "An example of how to configure the check to allow"

Done

There are a lot of simular test inputs and they all cover the same case. Please remove redundant inputs and add the new ones you don't have....

Done, see changes into InputSimple file

Change to "The check provides the following properties:"

Done

[romani]

one character variable in for loops:

http://docs.oracle.com/javase/tutorial/java/nutsandbolts/for.html it is initialization expression - so call that you examine only initialization expression in a loop, and put this link to JavaDoc.
2)

Utils.getPattern("^[a-z]")

Why end of line symbol is missed in RegExp

3. put yourself as author

[maxvetrenko]

1. Done
2. Done
3. Done

[romani]

you have two option so you need to describe all options and then provide examples . See how it is done in here - http://checkstyle.sourceforge.net/config_annotation.html

in for loops:

"in FOR loop", fix in all places.

[maxvetrenko]

1. Added example how to configure Check with custom properties commit
2. Done

[romani]

1. one character initialization expressions in FOR loop

What does this mean ? do you catch expression like "(i)"
Please write what exactly what you allow.

[maxvetrenko]

1. Is it enough or I have to write more? link

[romani]

one character initialization expressions in FOR loop:

please translate this and read carefully .... . And write me there example of this. Read attentively what is initialization expressions!

[romani]

xdoc have to be fixed too for that problem, users will read HTML description first.
So HTML part of description is our main focus.

[maxvetrenko]

xdoc have to be fixed too for that problem

Was updated according to Javadoc in LocalVariableNameCheck

[romani]

ok PR.