DCL01-J. Do not reuse public identifiers from the Java Standard Library

[norbo03]

I created DontReusePublicIdentifiers detector for rule DCL01-J to check clashes between user-defined identifiers and publicly available identifiers from the Java Standard Library.

I created several test cases considering the possible locations where user-defined names would appear. I checked class and interface names, field and variable declarations, and method names. In the case of classes, I checked multiply nested classes too. The test classes are placed into a separate package because of the number of source files.

I have slightly adjusted AnnotationMatcherTest because my detector found bugs in the test classes and the test was failing. Instead of checking that found bug matches the annotation, it inspects the number of bugs.

---

Make sure these boxes are checked before submitting your PR -- thank you!

• Added an entry into CHANGELOG.md if you have changed SpotBugs code

[ThrawnCA]

Build is failing.

[JuditKnoll]

It looks like there are some merge problems. Can you please resolve them?

[JuditKnoll]

Build is failing.

I think earlier "only" the Read the docs build failed, not the actual spotbugs build. Approved the workflow, the build succeeded. @ThrawnCA Do you know how to prevent the Read the docs build from failing?

[JuditKnoll]

Build is failing.

I think earlier "only" the Read the docs build failed, not the actual spotbugs build. Approved the workflow, the build succeeded. @ThrawnCA Do you know how to prevent the Read the docs build from failing?

The Read the docs build problem got solved.
@norbo03 Can you please merge master to your branch?

[gtoison]

Thanks for the PR @norbo03
I looked at the list of public identifiers and I think it should only include the public parts of the JDK. For instance the Axis class name is twice (!) in the JDK, in com.sun.org.apache.xerces.internal.impl.xpath.XPath.Axis and com.sun.org.apache.xml.internal.dtm.XPath. Neither of these classes in "exported" packages according to the module-info of these modules, so basically they shouldn't be used at all, and I'd argue that naming your own class "Axis" would be fine.

I suppose that this identifiers list was built with some kind of script, would it be possible to share the script?
Maybe this might be part of the project build, so new classes added to the JDK get added automatically as we upgrade versions?
There are also some .db in the project for this kind of long list, for instance https://github.com/spotbugs/spotbugs/blob/master/spotbugs/src/main/java/edu/umd/cs/findbugs/detect/longInstant.db

[norbo03]

Thanks for the PR @norbo03 I looked at the list of public identifiers and I think it should only include the public parts of the JDK. For instance the Axis class name is twice (!) in the JDK, in com.sun.org.apache.xerces.internal.impl.xpath.XPath.Axis and com.sun.org.apache.xml.internal.dtm.XPath. Neither of these classes in "exported" packages according to the module-info of these modules, so basically they shouldn't be used at all, and I'd argue that naming your own class "Axis" would be fine.

I suppose that this identifiers list was built with some kind of script, would it be possible to share the script? Maybe this might be part of the project build, so new classes added to the JDK get added automatically as we upgrade versions? There are also some .db in the project for this kind of long list, for instance https://github.com/spotbugs/spotbugs/blob/master/spotbugs/src/main/java/edu/umd/cs/findbugs/detect/longInstant.db

I believe integrating an automatic update feature into the project is a fantastic idea! In the past, I utilized scripts to extract public identifiers. Regrettably, these scripts are now outdated, and the results they produced necessitated extensive manual adjustments. While these scripts could serve as a foundation, they do require updates. I've gathered them here for reference.

[gtoison]

Thanks, I can't seem to access the repository you have linked (I get a 404 error page), maybe it is private?

[norbo03]

Thanks, I can't seem to access the repository you have linked (I get a 404 error page), maybe it is private?

I have already changed it, can you please check it now?

merge conflicts were resolved.