Static analysis code remediation: ome-xml and specification Java sources

[rleigh-codelibre]

Following static analysis of the ome-model source tree, the following remediation of the ome-xml and specification Java components has been performed:

Both ome-xml and specification:

• Addition of missing final qualifiers
• Removal of inferrable types when using generics (replaced with <>)
• Remove unnecessary boxing and unboxing

ome-xml:

• Simplify complex conditional
• Make ignored exceptions explicit
• Replace complex sets of conditionals with switch
• Use Map.computeIfAbsent() to simplify list creation
• Remove public modifier from interface (it's public by default)
• Replace use of StringBuilder for performance
• Return values directly rather than using an unneeded temporary
• Add suppression for unused return values [within the ome-model source tree]
• Add suppression for same return values for functions returning constants

specification:

• Remove redundant null initialisers (when the local will always be initialised immediately after creation and before first use)
• Remove unneeded temporary values
• Use try-with-resources rather than performing manual clean-up
• Correction of Javadoc markup
• Removal of unused exception types
• Use of new-style for loops
• Use of StandardCharsets to replace string literal

No generated source changes.

Total static analysis warnings fixed: 702 (3261 before, 2559 after)

Testing:

The refactoring should not result in any behavioural changes. All unit tests and integration tests should continue to pass. There should be no compatibility changes for downstream consumers.

If you would prefer to review these changes in a more fine-grained way, it can be split out into multiple PRs without any trouble. Few of the commits depend upon each other, so can be freely cherry-picked.

[snoopycrimecop]

Conflicting PR. Removed from build BIOFORMATS-push#659. See the console output for more details. Possible conflicts:

• PR #125 rleigh-codelibre 'OMEModelImpl: Do not permit the addition of null references'
  • ome-xml/src/main/java/ome/xml/model/OMEModelImpl.java

--conflicts Conflict resolved in build BIOFORMATS-push#664. See the console output for more details.

[rleigh-codelibre]

Update pushed which fixes up some cosmetic formatting in MetadataConverter.

snoopy is correct that #125 does conflict. As and when that fix is merged, I'll update this PR to remove the conflict.

[imagesc-bot]

This pull request has been mentioned on Image.sc Forum. There might be relevant details there:

https://forum.image.sc/t/static-analysis-and-ome-model-bugfixes/45977/1

[rleigh-codelibre]

Rebased to run with GitHub Actions.