Improve company productivity with a Business Account.Sign Up

x
?
Solved

Java Code Style

Posted on 2013-06-12
7
Medium Priority
?
334 Views
Last Modified: 2013-06-18
Background:
We have a legacy Java code( Code written over 10 years ago). Legacy Code  followed distinct coding styles. Example of one being that Instance variables were declared at the bottom of the class.

A new team took over the legacy code and started  changes( adding spring framework   and other changes). After few months, we realized that  team was declaring instance variables at the top of the class. Decision was made to keep the instance variables at the bottom(old style).

My question :

1. Is it possible using some tool/plug or some code formatting file  in to find out  number of classes affected by the change in coding style?
2. If #1 is possible, and I manage to identify the classes, what would be the easiest way to change the  declaration of all instance variables to be at the bottom of the class rather than at the top.


Can I configure a code formatting file or checkstyle or PMD or some other tool to achieve above objectives?
0
Comment
Question by:maverickxx
  • 3
  • 3
7 Comments
 
LVL 17

Expert Comment

by:krakatoa
ID: 39241418
Why not write a Java programme to do it?
0
 

Author Comment

by:maverickxx
ID: 39242862
Krakatoa,

I was looking for a quick and easy way for identifying number of changes. Also I am not sure of there are any more formatting changes.

I want to leverage any formatting libraries or plug ins if any
0
 
LVL 36

Expert Comment

by:mccarl
ID: 39243281
CheckStyle is the only example I have used so my answer is based on that. It has a "com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck" that implements the checking of the order of declarations in a class, however, it is non-configurable in the order that it expects to see things, and the order that it is checking for is for instance variables to be at the top.

You could take the source code for "DeclarationOrderCheck" and you should just be able to change the numbers that are assigned to the STATE_* constants at the top, in order for it to check for a different order (also, you will have to change the initial state assignment to "mScopeState" to be what ever the first one should be). This page, http://checkstyle.sourceforge.net/writingchecks.html, should help you in how to setup your checkstyle configuration to use a custom written check.


Then, once you identify classes that don't conform to your standards, if you use Eclipse as your IDE, you can select from the menu, "Source" -> "Sort Members...", and then click the link that appears in the window to configure the "Members Sort Order" in the Preferences and then apply that sorting to your Java files. Eclipse is the only IDE that I use, so I can't speak for others if you use something else.
0
Get your problem seen by more experts

Be seen. Boost your question’s priority for more expert views and faster solutions

 

Author Comment

by:maverickxx
ID: 39243422
Thank you mccarl. your link was very useful.
 
link you provided will work if I want to change the order of declarations. But I want to move the the variables to bottom of the class before closing braces.
0
 
LVL 36

Accepted Solution

by:
mccarl earned 2000 total points
ID: 39243437
If you have a look at the source code for the existing "DeclarationOrderCheck" (I'm looking at the online version, HERE) you will see near the top the constants that define the expected order of declarations...
    private static final int STATE_STATIC_VARIABLE_DEF = 1;
    private static final int STATE_INSTANCE_VARIABLE_DEF = 2;
    private static final int STATE_CTOR_DEF = 3;
    private static final int STATE_METHOD_DEF = 4;

Open in new window

You would make a new class that is a copy of this one but changing those constants, probably something like the following is what you are after...
    private static final int STATE_STATIC_VARIABLE_DEF = 1;
    private static final int STATE_CTOR_DEF = 2;
    private static final int STATE_METHOD_DEF = 3;
    private static final int STATE_INSTANCE_VARIABLE_DEF = 4;

Open in new window

This will make checkstyle report on any classes where the instance variable declarations and NOT at the bottom of the class.

As I said previously though, this will only identify cases that don't comply. You will need something like Eclipse's "Sort Members" action to actually move those variable declarations to where you want them.
0
 

Author Closing Comment

by:maverickxx
ID: 39257207
Thanks mccarl
0
 
LVL 36

Expert Comment

by:mccarl
ID: 39257909
Not a problem, glad to help!
0

Featured Post

Upgrade your Question Security!

Your question, your audience. Choose who sees your identity—and your question—with question security.

Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

Join & Write a Comment

Go is an acronym of golang, is a programming language developed Google in 2007. Go is a new language that is mostly in the C family, with significant input from Pascal/Modula/Oberon family. Hence Go arisen as low-level language with fast compilation…
A discussion about automated testing of Web Applications utilizing Selenium, along with illustrated configuration steps for the Jenkins open source tool.
Viewers learn about the third conditional statement “else if” and use it in an example program. Then additional information about conditional statements is provided, covering the topic thoroughly. Viewers learn about the third conditional statement …
Viewers will learn about basic arrays, how to declare them, and how to use them. Introduction and definition: Declare an array and cover the syntax of declaring them: Initialize every index in the created array: Example/Features of a basic arr…

608 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question