Java import order preference

[gaben]

This is a long standing question of mine. What is the import order preference?

There are:

• static imports
• java.*
• javax.*
• org.openstreetmap.*
• jakarta.*
• org.apache.commons.*
• other utility classes mostly in tests

Once we settle on something, I'd like to document it on the DevelopersGuide/StyleGuide. Reason is that, every time I create a new dev env, I forgot what was the import order setting.

[stoecker]

Hmm, you mean in the sources? Actually I would say it is

• static imports
• others sorted by name

Major groups (java, josm, others) are usually separated by an empty line.

Everything else is probably either historic or wrong or maybe also personal style (i.e. having org.openstreetmap above org.apache, simply because it is more important ;-)

[gaben]

Yep, in the sources.

Hmm, if'd like to separate major groups by an empty line, I need to specify all the groups which could break the ordering if I don't specify all of them (at least in IntelliJ). The order so far:

1. all static imports
2. <empty line>
3. java.*
4. <empty line>
5. javax.*
6. <empty line>
7. org.openstreetmap.gui.jmapviewer.*
8. <empty line>
9. org.openstreetmap.josm
10. <empty line>
11. rest of the imports ungrouped

I don't know where to put jakarta.

[GerdP]

I must say I never really cared because Eclipse adds new imports with its own logic. Sometimes patches contain changes which also reorder the imports and I am sure I didn't do this manually, but maybe I pressed the "Format" or the "Organize Imports" shortcut accidentially.
In short, if you want to establish rules please provide rules for Eclipse and other IDEs.