LocalizedMessage should use ModuleName in compareTo method

[romani]

base on discussion at #4899 (comment)

LocalizedMessage.compareTo use ModuleId but does not use ModuleName ..... strange, ModuleName should be used

[shashwatj07]

I'm on it!

[romani]

@shashwat70 ,

Are moduleName and moduleID both supposed to be used in the compareTo method?

yes. You meant sourceName instead moduleName.
We need both fields to be used in compare method.

we need to rename it to be moduleName to match naming convention with moduleId (could be done as separate issue, as it is API, we need to deprecate getSourceName method and keep it for some time before deletion).

[romani]

abandoned PR - #8192
everyone is welcome to reuse this code and send new PR to fix an issue.

[rnveach]

LocalizedMessage

This is now in Violation.

LocalizedMessage.compareTo use ModuleId but does not use ModuleName ..... strange

Adding ModuleName (more technically sourceClass) to comparison will mean 2 different modules who print the same violation message will no longer be seen as same and each one will be unique. One good example is AbstractJavadocCheck#violateExecutionOnNonTightHtml.

Its odd all fields aren't used in compareTo but are used in hashCode and equals. The list: tokenType, severityLevel, key, bundle, sourceClass, customMessage, args . (Crossed out are part of violation message).

[romani]

even change is in api package, I mark it as bug, as it is details of implementation.
There should be no any side effect or big change for users, just slightly more precise sorting in collections.

[romani]

Fix the s merged